IMF Developer's Guide

IMF Developer's Guide » Map Configuration » <FOLDER>

The <FOLDER> element is used to organize layers into folders for display in the layers list in the IMF application. The <FOLDER> element is used to create and name a new folder. Within a <FOLDER> element, there can be many layers, groups, or other folders (up to 3 deep) to specify the contents of the folder.

Frequency	Parent Elements (this element is valid within):
POS+	<MAP-CONFIG>
PO+	<FOLDER>

Attributes	Description
apply-visibility-to-subfolders	Specifies whether setting the visibility of a folder also applies to sub-folders. Valid values are "true" or "false". Defaults to "true".
can-set-visibility	Specifies whether the ON and OFF options appear beside a folder for the user to control the visibility of the folder's contents. Valid values are "true" or "false". Defaults to "true".
can-set-visibility-on	Specifies whether the ON option appears beside a folder for the user to control the visibility of the folder's contents. Valid values are "true" or "false". Defaults to "true".
can-set-visibility-off	Specifies whether the OFF option appears beside a folder for the user to control the visibility of the folder's contents. Valid values are "true" or "false". Defaults to "true".
metadata-url	Sets the URL for a metadata page that describes the layer. 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. If there is a metadata-url, the folder name will be a hyperlink on the layers page, if not, the folder name will not be hyperlinked.
name	The name of the folder. Required.
open	Specifies whether the folder is open the first time that the user sees it. Valid values are "true" or "false". Defaults to "false".
radio	Specifies whether the visibility controls of the layers in the folder work like radio buttons, where only one of them can be visible at a time. Valid values are "true" or "false". Defaults to "false".

Frequency	Child Elements
O+	<FOLDER>
O+	<GROUP>
O+	<LAYER>

Frequency	Description (in this context)
POS+	The <FOLDER> element may appear one or more times within the <MAP-CONFIG> element in the specified sequence.
PO+	The <FOLDER> element may appear one or more times within another <FOLDER> element. Folders can only be nested three-deep.
O+	The child element may appear one or more times within the <FOLDER> element.

Examples:

<FOLDER name="Grids" open="true">
  <LAYER title="BCGS Grid" /> 
  <LAYER title="NTS Grid" /> 
</FOLDER>

<FOLDER name="Some Layers" open="true">
  <LAYER title="BCGS Grid" /> 
  <LAYER title="NTS Grid" /> 
  <GROUP name="Elevation" visible="false" can-identify="false">
    <LAYER title="Spot Elevation - Points (1:2M)" />
    <LAYER title="Contours - Lines (1:250K)" />
    <LAYER title="Elevation - Lines (1:20K)" />
    <LAYER title="Elevation - Points (1:20K)" />
    <LAYER title="Elevation - Text (1:20K)" /> 
  </GROUP>
</FOLDER>