|
Attributes |
Description |
|
active-copy |
Specifies whether the layer is the active copy layer. Requires the editing
tools extension. Valid values are "true" or "false". Optional, defaults to "false".
|
|
active-edit |
Specifies whether the layer is the active editing layer. Requires editing tools extension. Valid values are "true" or "false". Optional, defaults to "false".
|
|
active-identify |
Sets the layer to be the default identify layer when the application starts. Valid values are "true" or "false". The default is "false". Only one layer should be designated as active, but if more than one layer contains a true value, the last layer processed will be the active one. Optional.
|
|
active-select |
Sets the layer to be the default select layer when the application starts. Valid values are "true" or "false". The default is "false". This setting is only applicable to feature layers. Only one layer should be designated as active, but if more than one layer contains a true value, the last layer processed will be the active one. Optional.
|
|
alias |
Sets an alternate name to use when listing this layer in the layer list. Optional.
|
|
can-drill-identify |
Sets whether the layer appears on the drill identify report. Valid values are "true" or "false". The default is "true". Optional.
|
|
can-edit |
Specifies whether the layer can be edited. Requires editing tools extension. Valid values are "true" or "false". Optional, defaults to "false".
|
|
can-extract |
Sets whether the layer can be extracted. If this attribute is true, set the rest of the extract elements too. Optional, valid values are "true" or "false". Defaults to false.
|
|
can-extract-excel |
Sets whether the attributes of the layer can be extracted to an Excel spreadsheet.
If this attribute is true, a link to extract selected records will appear on the
selected set summary page, and the layer's name will appear on the form used to
extract to Excel, if used. Valid values are "true" or "false". Defaults to "true".
|
|
can-extract-gml |
Sets whether the attributes of the layer can be extracted to an GML2 XML file.
If this attribute is true, a link to extract selected records will appear on the
selected set summary page, and the layer's name will appear on the form used to
extract to GML, if used. 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
to allow the user to hide the labels. Optional, valid values are "true" of "false".
Defaults to false. Note that if the 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 |
Sets whether a layer can be identified. Valid values are "true" or "false". The default is "true". Layers that cannot be identified do not have the identify icon beside them in the theme list. Optional.
|
|
can-select |
Sets whether a layer can be selected using the select tool. Valid values are "true" or "false". The default is "false". Layers that cannot be selected do not have the select icon beside them in the theme list. Optional.
|
|
can-set-visibility |
Sets whether a layer 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 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.
|
|
can-symbolize |
Sets whether a layer can symbolized by the user. Note that show-symbolize-icon must also
be set to true before the icon shows beside the layer name in the layer list. Valid values
are "true" or "false". The default is "false", but the default for show-symbolize-icon is
"true". Added at version 4.0.6.5. Optional. See also attribute symbolize-script.
|
|
can-zoom-to-layer |
Sets whether the user can zoom to the extent of a layer using the Zoom To Layer Extent routine. Valid values are "true" or "false". The default is "true". Optional.
|
|
default-field-visibility |
A setting to indicate whether the fields will be shown in the default reports. If true, the fields will be shown unless the fields are defined as sub-elements with display="false". If false, the fields will not be shown unless the fields are defined as sub-elements with display="true". Defaults to true. Optional.
|
|
edit-handler |
Specifies the URL of the script used to insert, update or delete records from the layer. Requires editing tools extension. Optional.
|
|
edit-handler-target |
Specifies the name of the frame that the edit handler will execute in. Requires editing tools extension. Typical values are "dataFrame", "hiddenFrame", or "_blank". Optional.
|
|
extract-clip |
Specifies whether the extracted features should be limited to those visible in the current map window. Valid values are "true" or "false". The default is "true". Optional.
|
|
extract-layer-id |
Sets the ID of the layer to be extracted. This should be the ID of the same layer in the extractable map service. Required if extracting is enabled.
|
|
extract-server |
Sets the name of the server with the map service used to extract this layer. For security reasons, this should be a different map service than the one used for the web site, and should not contain any layers that you don't want to export.
|
|
extract-service |
Sets the name of the map service used to extract this layer. For security reasons, this should be a different map service than the one used for the web site, and should not contain any layers that you don't want to export.
|
|
extract-servlet |
Sets the servlet path of the map service used to extract this layer. Defaults to "/servlet/com.esri.esrimap.Esrimap".
|
|
extract-coordsys-id |
For projecting extracted shape files to a desired projection. Use the ESRI id
for the projection you want to extract to. For custom projections without an id,
use extract-coordsys-string instead. Use one or the other, but not both. Optional,
if this attribute or the extract-coordsys-string attribute is missing, the
extracted shape file will be the same projection as the map.
|
|
extract-coordsys-string |
For projecting extracted shape files to a desired projection. Use the string
for the projection you want to extract to. For projections with an ESRI id,
use extract-coordsys-id instead. Use one or the other, but not both. Optional,
if this attribute or the extract-coordsys-id attribute is missing, the extracted
shape file will be the same projection as the map.
|
|
geocode-layer-id |
The geocode attributes are used in IMF applications that use ArcMap services
to set the layer in a normal ArcIMS image map service that provided geocoding
capability (ArcMap services don't support this). To associate an ArcMap layer to
an associated layer in an image service, set the geocode attributes to the
applicable values in the other service. This attribute is used to specify the
ID of the layer in the image service. Optional, but required if remote geocoding
services are used.
|
|
geocode-server |
The geocode attributes are used in IMF applications that use ArcMap services
to set the layer in a normal ArcIMS image map service that provided geocoding
capability (ArcMap services don't support this). To associate an ArcMap layer to
an associated layer in an image service, set the geocode attributes to the
applicable values in the other service. This attribute is used to specify the
server host name or IP address of the ArcIMS image service. Optional, but
required if remote geocoding services are used.
|
|
geocode-servlet |
The geocode attributes are used in IMF applications that use ArcMap services
to set the layer in a normal ArcIMS image map service that provided geocoding
capability (ArcMap services don't support this). To associate an ArcMap layer to
an associated layer in an image service, set the geocode attributes to the
applicable values in the other service. This attribute is used to specify the
servlet path of the ArcIMS image service. Optional, defaults to
"/servlet/com.esri.esrimap.Esrimap".
|
|
geocode-service |
The geocode attributes are used in IMF applications that use ArcMap services
to set the layer in a normal ArcIMS image map service that provided geocoding
capability (ArcMap services don't support this). To associate an ArcMap layer to
an associated layer in an image service, set the geocode attributes to the
applicable values in the other service. This attribute is used to specify the
service name of the ArcIMS image service. Optional, but required if remote
geocoding services are used.
|
|
hide-labels |
Sets whether the labels for the layer should be displayed when the application opens.
Optional, valid values are "true" of "false". Defaults to true..
Note that if the 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.
|
|
highlight-color |
The color for selected features in RGB values like "255,255,0". Defaults to yellow. Optional.
|
|
highlight-transparency |
A value indicating the transparency of the highlighted features. Acceptable values range from 0.0 for fully transparent to 1.0 for fully opaque. Defaults to 1.0. Optional.
|
|
highlight-type |
A value indicating the way that polygon features are highlighted. Acceptable values
are "outline" and "fill". Defaults to "outline". Optional. Ignored for non-polygon layers.
|
|
id |
Used to find the layer to set properties for. Must match the id of a layer in the map service. Either this attribute or the name attribute is required.
|
|
identify-handler |
The name of a URL that is executed when the records have been located. Required for all identify types except "default".
|
|
identify-handler-suffix |
Used by the urlAppend reporting type. When the urlAppend identify type is used, the
URL called is created by concatenating the text of the identify-handler value, the value
of the first field specified in the identify-key-fields attribute, and the value
contained in this attribute. |
|
identify-key-fields |
A list of field names s used in the "urlTable", "urlFieldValues" or
"urlMultipleFieldValues" identify types. For the "urlFieldValueAsQuery" or
"urlAppend" identify types, only one field name should be used.
Must match the FULL name of a field in a feature layer in the map service.
In the case of SDE layers, the full name is the OWNER.TABLE.COLUMN format.
The field names in the text string should be separated by commas with no
extra spacing. Required for the above identify types.
|
|
identify-maximum-results |
The number of results that can be returned by an identify query. The default is 500. Optional.
|
|
identify-tolerance-pixels |
The search distance for selecting features when using the point select or identify tools,
in pixels. Optional, the default is "1" for polygons, "6" for points, and "3" for lines.
|
|
identify-type |
The type of identify process that this layer uses. Valid values are
"default", "tabular", "custom", "urlAppend", "urlTable", "urlFieldValues",
"urlMultipleFieldValues" and "urlFieldValueAsQuery". Optional, the default
is "default".
|
|
identify-window |
Sets whether the identify results for a layer are shown in a separate browser window. 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. 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 layer 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, 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,
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.
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 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,
in pixels. Optional, but required if a layer list legend is used.
|
|
max-scale |
Sets the maximum scale at which the layer will be displayed. Use numeric values, for example to set the scale to 1:10000, use 10000. Defaults to the maxscale setting in the map service, or 1.0E99 if no maximum scale is set for the layer in the map service.
|
|
maximum-excel-results |
Sets the maximum number of records that can be extracted to Excel using the
extract routines. Optional, defaults to "500".
|
|
maximum-gml-results |
Sets the maximum number of records that can be extracted to a GML file using the
extract routines. Optional, defaults to "500".
|
|
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. By default, there is no metadata. Optional.
|
|
min-scale |
Sets the minimum scale at which the layer will be displayed. Use numeric values, for example to set the scale to 1:10000, use 10000. Defaults to the minscale setting in the map service, or 0 if no minimum scale is set for the layer in the map service.
|
|
name |
Used to find the layer to set properties for. Must match the name of a layer in the map service. Either this attribute or the id attribute is required.
|
|
position |
Sets the drawing order of the layer. Valid values are "top", "bottom", or the desired indexed position between 0 (bottom) and one less than the layer count (top).
|
|
select-handler |
The name of a URL that is executed when the records have been located. Required for all select types except "default".
|
|
select-handler-suffix |
Used by the urlAppend reporting type. When the urlAppend select type is used, the
URL called is created by concatenating the text of the select-handler value, the value
of the first field specified in the select-key-fields attribute, and the value
contained in this attribute. |
|
select-highlight |
A boolean value indicating whether the selected features should be highlighted on the map. Valid values are "true" and "false". The default is "true". Optional.
|
|
select-key-fields |
A list of fields used in the select type routines. The field names in the text string should be separated by commas with no extra spacing. Required for the select types that need it.
|
|
select-maximum-results |
The number of results that can be returned by an select query. The default is 500. Optional.
|
|
select-shape |
The type of selection shape used for the layer. This affects the action of the select tool in the application. Valid values are "point", "polygon" and "box". The default is "point". Optional.
|
|
select-type |
The type of select process that this layer uses. Valid values are "default", "tabular", "custom", "urlTable", "urlEnvelope", and "urlShape". The default is "default". Optional.
|
|
select-window |
Sets whether the select results for a layer are shown in a separate browser window. The default is "false" which means that the results are shown in the data frame. Valid values are "true" or "false". Optional.
|
|
selected-set |
Specifies whether the layer uses selected set routines. Valid values are "true" or "false". The default is "false". Optional.
|
|
show-legend |
Sets whether the layer will show in the legend. Valid values are "true" or "false". The default is "true".
|
|
show-symbolize-icon |
Sets whether a the symbolization icon is displayed beside the layer name in the layers list.
Note that can-symbolize must be set to true in order for this to have any effect. Valid values
are "true" or "false". The default is "true", but the default for can-symbolize is "false".
Added at version 4.0.6.5. Optional.
|
|
symbolize-script |
Sets the script called when the user selects the symbolize tool for a layer.
The script should be a file name of a JSP script inside the IMF directory structure.
Optional, defaults to "imfSymbolizeLayerForm.jsp". Added at 4.0.6.12.
See also attribute can-symbolize.
|
|
visible |
Sets the initial visibility of the layer. Valid values are "true" or "false". The default is as defined in the map service. Optional.
|
|
zoom-extent-buffer |
Sets the buffer distance for zooming to selected features. The map extent will have at least this distance away from the feature on all sides. Numeric value in map units, no default. Optional.
|
| |
|
