Changes between Version 2 and Version 3 of ApplicationDefinition/MapSet/MapGroup

Timestamp:

Apr 7, 2008, 12:23:39 PM (16 years ago)

Author:

jbirch

Comment:

Adding information about InitialView

ApplicationDefinition/MapSet/MapGroup

@@ +1 @@
+[[PageOutline]]
 [wiki:Documentation] | [wiki:ApplicationDefinition] | [wiki:ApplicationDefinition/MapSet MapSet]
 
 = !MapGroup =
 
-A sub-tag of the [wiki:ApplicationDefinition/MapSet MapSet] tag, a !MapGroup contains sub-tags for map rendering sources that are to be included in a visible map.  A !MapGroup must contain at least one '''Map''' tag to be valid.  For example:
+A child of the [wiki:ApplicationDefinition/MapSet MapSet] element, a !MapGroup contains configuration information for map rendering sources that are to be included in a visible map.  A !MapGroup must contain at least one '''Map''' element to be valid, and may contain one '''!InitialView''' element. For example:
 
 {{{
-<MapGroup id="Parks" xsi:type="MapType">
+<MapGroup id="Sheboygan" xsi:type="MapType">
   <Map xsi:type="MapGuideLayerType">
     <Type>MapGuide</Type>
@@ -14 +15 @@
     </Extension>
   </Map>
+  <InitialView>
+    <CenterX>430379</CenterX>
+    <CenterY>5446616</CenterY>
+    <Scale>5446915</Scale>
+  </InitialView>
 </MapGroup>
 }}}
+
+== Map ==
 
 The Map tag contains the following sub-tags:
@@ -28 +36 @@
   The Extension tag contains sub-tags that are not defined by the schema.  The content of the sub-tags depends partly on the '''Type''' of map specified.
 
-== General Extension ==
+=== General Extensions ===
 
 The generally supported Extension tags are supported by all or most of the map types.  These are described below.
 
-=== Links ===
+==== Links ====
 The Links tag allows you to specify metadata URLs to be associated with groups and layers.  The Legend widget can use this metadata to add links into the rendered legend tree to hyperlink users to additional information about groups and layers.  
 
@@ -59 +67 @@
 }}}
 
-=== !MapEvents ===
+==== !MapEvents ====
 The !MapEvents tag allows you to specify actions to take when layers and groups are turned on or off by a user.  Valid actions are to turn on or off other layers and groups.  
 
@@ -142 +150 @@
 
 If you have defined a !MapServer map type, you must provide a {{{<MapFile>}}} sub-tag that defines the path to the MAP file to be used to render this map.
+
+== !InitialView ==
+
+!InitialView allows you to set a zoom extents that is different that the maximum extents of the map.  This is useful for regional mapping, as it allows you to create a map with large extents to give a reasonable amout of context, but still have only your area of interest displayed on initial load.
+
+There are two syntaxes allowed for !InitialView, center and scale style, or bounding box style.  The center and scale style is given precedence over the bounding box style if both sets of required elements exist.  If any of the required elements are missing for either of these styles (for instance, omitting the CenterX element for the center and scale style) that style will not be applied.
+
+=== Center and Scale ===
+
+This allows you to set the initial view based on a midpoint and a desired scale.
+
+For this to be used, you must include valid CenterX, CenterY and Scale elements within the !InitialView element.
+
+Example:
+
+{{{
+  <InitialView>
+    <CenterX>430379</CenterX>
+    <CenterY>5446616</CenterY>
+    <Scale>5446915</Scale>
+  </InitialView>
+}}}
+
+=== Bounding Box ===
+
+This allows you to set the initial view based on a desired bounding box.
+
+For this to be used, you must include valid MinX, MinY, MaxX, and MaxY elements within the !InitialView element.
+
+Example:
+
+{{{
+      <InitialView>
+        <MinX>430379</MinX>
+        <MinY>5446616</MinY>
+        <MaxX>430541</MaxX>
+        <MaxY>5446915</MaxY>
+      </InitialView>
+}}}