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

The <field> element is used to set an alias name for a field in a feature layer, so that the alias is used as a label in the default report or to name the parameter when calling the URL of a "urlFieldValues" handler. There is also an attribute the set the field so that it doesn't show up in a default report. Note that the fields will be ordered in the default reports in the order specified in the layer configuration file.

Frequency Parent Elements (this element is valid within):
PO+ <dynamic-feature-layer>
PO+ <layer>
   

Attributes Description
alias Sets an alternate name to use when listing this layer in the layer list or on the select by attribute or find by attribute routines. Optional. If this attribute is missing, the field names will appear instead. Note that if there is no alias and the layer is an SDE layer, a shortened field name will appear that does not include the owner and table name.
can-extract-excel Specifies whether the field is included in the Excel file created using the export routine when the layer is exported. To control whether a layer can be extracted, use the can-extract-excel attribute in the layer element. By default, all fields are included in the output unless the field element contains can-extract-excel="false", so this attribute is optional, defaulting to true.
can-extract-gml Specifies whether the field is included in the GML file created using the export routine when the layer is exported. To control whether a layer can be extracted, use the can-extract-gml attribute in the layer element. By default, all fields are included in the output unless the field element contains can-extract-gml="false", so this attribute is optional, defaulting to true.
can-find-by-attribute Specifies that the field can be used in the find by attribute routine. Optional, defaults to false.
can-select-by-attribute Specifies that the field can be used in the select by attribute routine. Optional, defaults to false.
can-symbolize-by-attribute Specifies that the field can be used in the symbolize by attribute routine. Optional, defaults to false.
display Sets the visibility of the field when used with the default identify or select report. Valid values are "true" or "false". Optional, defaults to true unless the default-field-visibility in the parent <layer> element is set to false.
find-by-attribute-buffer Specifies the buffer distance around the selected features when the map is zoomed in. Optional. The default is 100 map units.
find-by-attribute-case Specifies how the query is made when using the find by attribute routine. There are four valid values:

 - upper
   The user entry will be converted to upper case for the query. The 
   values in the database must be in upper case for a match to be found.

 - lower
   The user entry will be converted to lower case for the query. The 
   values in the database must be in lower case for a match to be found.

 - sensitive
   The user entry will not be converted at all. The values in the database
   must exactly match the case of the user entry for a match to be found.

 - insensitive
   The search will be done in a case-insensitive manner.

Optional. The default is "insensitive".

format Sets a formatting routine for the display of field values on the default identify and selection pages. Valid values / examples are:
 - currency
   Currency format for numeric fields only.

 - date,short
   Short date format for date fields only.

 - date,medium
   Medium date format for date fields only.

 - date,long
   Long date format for date fields only.

 - date,full
   Full date format for date fields only.

 - datetime,short
   Short date and time format for date fields only.

 - datetime,medium
   Medium date and time format for date fields only.

 - datetime,long
   Long date and time format for date fields only.

 - datetime,full
   Full date and time format for date fields only.

 - initcap
   First letter of each word capitalized (e.g. proper names) format for text fields only.

 - lower
   Lower case format for text fields only.

 - precision,2
   Rounding format for floating point numeric fields only.
   The number after the comma can be 0 - 9.

 - replace,string1,string2
   String substitution format for text fields only.
   All occurrences of the first string will be substituted with the second.

 - time,short
   Short time format for date fields only.

 - time,medium
   Medium time format for date fields only.

 - time,long
   Long time format for date fields only.

 - time,full
   Full time format for date fields only.

 - upper
   Upper case format for text fields only.
hypertext-message Sets the hyperlink text shown on the default reports when a field contains a URL address. Defaults to "More data".
identify-alias Sets an alternate name to use when setting the parameter name for a field in a "urlFieldValues" or "urlMultipleFieldValues" identify report. Optional.
identify-link-alias Sets an alternate name to use when setting the parameter name for a field in a "urlFieldValues" or "urlMultipleFieldValues" identify-link URL. Optional. Returns the first found identify-alias, alias, short name, or full name if this attribute is not used.
map-tip Specifies that this field can be shown as a map tip. Valid values are "true" or "false". Optional, defaults to "false".
map-tip-alias Sometimes a shorter field alias is better for a map tip. If this is a map tip field, this attribute is used to set the field alias for the map tip. Optional. If no map tip alias is specified, the map tip will show the field alias or short name (field name of SDE fields) or full name, searched in that order.
metadata-url Sets the field metadata URL to the value specified. Optional.
name Used to find the field to set properties for. 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. Required.
select-alias Sets an alternate name to use when setting the parameter name for a field in a "urlFieldValues" or "urlMultipleFieldValues" identify report. Optional.
select-by-attribute-buffer Specifies the buffer distance around the selected features when the map is zoomed in. Optional. The default is 100 map units.
select-by-attribute-case Specifies how the query is made when using the select by attribute routine. There are four valid values:

 - upper
   The user entry will be converted to upper case for the query. The 
   values in the database must be in upper case for a match to be found.

 - lower
   The user entry will be converted to lower case for the query. The 
   values in the database must be in lower case for a match to be found.

 - sensitive
   The user entry will not be converted at all. The values in the database
   must exactly match the case of the user entry for a match to be found.

 - insensitive
   The search will be done in a case-insensitive manner.

Optional. The default is "insensitive".

select-by-attribute-zoom Specifies that the select-by-attribute routine should zoom to the extent of the selected records once they are found. Optional, defaults to "false".
   

Frequency Description (in this context)
PO+ The <field> element may appear one or more times within the <layer> element.
   

Example:

<field....../>

Valid HTML 4.01!