Moxi Media Inc.
<group> Discussion Forum
IMF Developer's Guide » Layer Configuration » <group>  

The <group> element is used to organize layers into a virtual layer so they can be controlled as one layer. A layer group is shown like any other ordinary layer in the layers list.

Frequency Parent Elements (the <group> element is valid within):
PO+ <folder>
   

Frequency Child Elements (the <group> element may contain):
O+ <dynamic-feature-layer>
O+ <dynamic-image-layer>
O+ <layer>
O+ <wms-layer>
O+ <layer-list-icon>
O+ <layer-list-legend>
   

Frequency Description (in this context)
PO+ The <group> element may appear one or more times within a <folder> element.
O+ The <group> element must contain one or more <layer> or <wms-layer> elements, but not necessarily both. The order of the layers in the group is significant if the "first" or "location" reporting types are used.
   

Attributes Description
active-identify A directive to set the layer group as the active identify layer. Valid values are "true" or "false". Defaults to "false".
active-select A directive to set the layer group as the active selection layer. Valid values are "true" or "false". Defaults to "false".
can-hide-labels Sets whether a checkbox will be displayed in the layers list for the layer group to allow the user to hide the labels. Optional, valid values are "true" or "false". Defaults to false. Note that if a layer contains RASTERMARKERSYMBOLS, you must set the property spatialServer.AllowResponsePath to "true" in esrimap_prop. This property file is found in the same directory as the ArcIMS Servlet Connector. For more information on the location of esrimap_prop and its properties, see the ArcIMS Help.
can-identify A directive to specify whether the layer group can be identified. Valid values are "true" or "false". Defaults to true if there are identifiable sub-layers, otherwise false. Note that setting can-identify to "true" when there are no identifiable sub-layers has no effect.
can-select A directive to specify whether the layer group can be selected. Valid values are "true" or "false". Defaults to true if there are selectable sub-layers, otherwise false. Note that setting can-select to "true" when there are no selectable sub-layers has no effect.
can-set-visibility Sets whether a layer group can be turned on and off by the user. Valid values are "true" or "false". The default is "true". Layers that have can-set-visibility set to "false" show up in the layers list with the visibility checkbox disabled (grayed out). Optional.
can-set-visibility-beyond-scale Sets whether a layer group can be turned on and off by the user if it is outside of the visible scale range. Valid values are "true" or "false". The default is "false". Optional.
identify-method Sets how the identify tool works with this layer group. The options are:
 - drill
   When the layer group is active and the identify tool is used, the drill down
   identify report will be executed showing the results for the visible layers
   in this layer group only.

 - first
   The identify routine associated with the first visible layer in the layer group 
   will be executed when the identify tool is used.

 - location
   The identify routine associated with the first visible layer that intersects the
   clicked point that is in the layer group will be executed when the identify tool
   is used.
Optional. The default is "drill".
identify-window Sets whether the drill identify results for a layer group are shown in a separate browser window. This setting has no effect if "first" or "location" identify-methods are used. The default is "false" which means that the results are shown in the data frame. Valid values are "true" or "false". Optional.
immediate-refresh Sets whether the map should immediately refresh when the user changes the visibility of the layer group. Valid values are "true" or "false". The default is "false".
layer-list-legend-can-hide Sets whether the visibility of the layer list legend for this group can be toggled by the user by clicking the mouse on a small icon beside the layer name. Note that this controls the visibility of individual layers or groups, as opposed to the checkbox on the layer list that toggles the visibility of all layer list legends. Optional, default is false.
layer-list-legend-height The height of the graphic used in the layer list legend for this layer group, in pixels. Optional, but required if a layer list legend is used.
layer-list-legend-url The URL of the graphic used in the layer list legend for this layer group. The URL can start with the special variable $IMF to specify that the document is relative to the IMF installation directory. Absolute URLs may also be used. URLs that don't start with http: or $IMF are resolved relative to the location of the XML file. Optional, but required if a layer list legend is used.
layer-list-legend-visible Sets whether the layer list legend for this layer group is visible when the application starts. Since invisible legends need to be turned on by the user at some point, only set this to "false" if you activate the user toggle function e.g. layer-list-legend-can-hide="true". Valid values are "true" or "false". Optional, defaults to "true".
layer-list-legend-width The width of the graphic used in the layer list legend for this layer group, in pixels. Optional, but required if a layer list legend is used.
metadata-handler Sets the URL for a dynamic page that describes the layer. The URL is called with parameters layer id, name, and the layer's object id. The URL can start with the special variable $IMF to specify that the document is relative to the IMF installation directory. Absolute URLs may also be used. URLs that don't start with http: or $IMF are resolved relative to the location of the XML file. Optional. By default, there is no metadata.
metadata-url Sets the URL for a metadata page that describes the layer group. The URL can start with the special variable $IMF to specify that the document is relative to the IMF installation directory. Absolute URLs may also be used. URLs that don't start with http: or $IMF are resolved relative to the location of the XML file. Optional. By default, there is no metadata.
name The name of the group. Required.
select-method Sets how the select tool works with this layer group. The options are:
 - first
The select routine associated with the first visible layer in the layer group will be executed when the select tool is used. - location The select routine associated with the first visible layer that intersects the clicked point that is in the layer group will be executed when the select tool is used.
Optional. The default is "first".
select-shape The type of selection shape used for the layer group. This affects the action of the select tool in the application. Valid values are "point", "polygon" and "box". The default is "point". Optional.
visible Sets whether the layer group should be visible (checked in the layer list) when the application starts up. Valid values are "true" or "false". Optional, defaults to "false".
   

Example:

<group name="Map Grid"
       can-identify="true"
       identify-method="first"
       layer-list-legend-url="grids.gif"
       layer-list-legend-width="75"
       layer-list-legend-height="100"
       visible="true">
  <layer name="1:20K Map Grid"/>  
  <layer name="1:50K Map Grid"/>
  <layer name="1:250K Map Grid"/>
</group>

Valid HTML 4.01!