WxML overlay tag

< prev | next >

overlay < Tags < Home

<overlay>

The <overlay> tag specifies a geography overlay to appear within the context of a map. As such, <overlay> tags can only appear as children of a <map>. Each <overlay> tag must contain a single <data> tag, and may contain a <lineStyle>. If the <lineStyle> is omitted, default visual properties will be applied. Currently, the data source for an overlay can be a file in the OCS Resources folder or a shapefile specified by a URL.

Attributes

attribute

default

description

visible

"true"

Is the overlay initially visible?

name

Overlays that use OCS Resource files get their name from the resource by default. Overlays that use shapefiles have the name "untitled" by default.

The name of the overlay as it appears in the legend.

Children

tag

quantity

description

<data>

1 (required)

The source from which the overlay data are obtained. To use an OCS Resources file, the src attribute should contain the name of the file, and the param attribute should contain the name of an overlay resource within the file. If the src attribute is omitted, the overlay will combine all available resources with the name specified in the param attribute. To use a shapefile, the src attribute should contain a URL and the param attribute should be omitted.

<lineStyle>

1 (optional)

The visual properties of the overlay lines. Each overlay resource defines its own default line properties.

Examples

<overlay visible="true" name="Oklahoma counties"> <data src="Oklahoma Maps" param="County borders"/> <lineStyle color="#666666" width="0"/> </overlay> <overlay visible="false"> <data src="Kansas Maps" param="Interstate highways"/> </overlay> <overlay> <data param="State border"/> </overlay> <overlay name="My Shape File"> <data src="http://myserver/myshapefile.shp"/> </overlay>