### Type parameters

### Hierarchy

- GmfMetaData

## Index

### Properties

- copyable
- customOpenLayersOptions
- directedFilterAttributes
- disclaimer
- enumeratedAttributes
- exclusiveGroup
- hiDPILegendImages
- iconUrl
- identifierAttributeField
- isChecked
- isExpanded
- isLegendExpanded
- legend
- legendImage
- legendRule
- maxQueryResolution
- maxResolution
- metadataUrl
- minQueryResolution
- minResolution
- ogcServer
- opacity
- printLayers
- printNativeAngle
- queryIconPosition
- queryLayers
- snappingConfig
- thumbnail
- timeAttribute
- wmsLayers

## Properties

### copyable

copyable: boolean

- Defined in src/themes.js:218

Whether the geometry from this data source can be copied to other data sources or not. For WMS layers.

### customOpenLayersOptions

customOpenLayersOptions: Object

- Defined in src/themes.js:278

The custom OpenLayers WMS layer options.

### directedFilterAttributes

directedFilterAttributes: string[]

- Defined in src/themes.js:220

List of attribute names which should have rules already ready when using the filter tools. For WMS layers.

### disclaimer

disclaimer: string

- Defined in src/themes.js:222

The disclaimer text for this element. For every kind of layer, layer groups and themes.

### enumeratedAttributes

enumeratedAttributes: string[]

- Defined in src/themes.js:224

List of attribute names which have enumerated attribute values (for filters purpose). For WMS layers.

### exclusiveGroup

exclusiveGroup: boolean

- Defined in src/themes.js:226

Whether the group contains children that have to be mutually exclusive, meaning that only one child may be ON at any time.

### hiDPILegendImages

hiDPILegendImages: Object

- Defined in src/themes.js:241

The URLs to the hi DPI images used as a legend in the layer tree. For WMS and WMTS layers.

### iconUrl

iconUrl: string

- Defined in src/themes.js:228

The URL of the icon to display in the layer tree. For every kind of layer.

### identifierAttributeField

identifierAttributeField: string

- Defined in src/themes.js:229

The field used in the 'display query window' as feature title. For WMS layers.

### isChecked

isChecked: boolean

- Defined in src/themes.js:231

Is the layer checked by default. For WMS and WMTS layers.

### isExpanded

isExpanded: boolean

- Defined in src/themes.js:232

Whether the layer group is expanded by default. For layer groups (only).

### isLegendExpanded

isLegendExpanded: boolean

- Defined in src/themes.js:236

Whether the legend is expanded by default. For WMS and WMTS layers.

### legend

legend: boolean

- Defined in src/themes.js:238

Display the legend of this layers. For WMS and WMTS layers.

### legendImage

legendImage: string

- Defined in src/themes.js:239

The URL to the image used as a legend in the layer tree. For WMS and WMTS layers.

### legendRule

legendRule: string

- Defined in src/themes.js:243

The WMS 'RULE' parameter used to display the icon in the layer tree. "Short version" of the 'iconURL' metadata for WMS layers. For WMS layers.

### maxQueryResolution

maxQueryResolution: number

- Defined in src/themes.js:245

The max resolution where the layer is queryable. For WMTS and vector tiles layers.

### maxResolution

maxResolution: number

- Defined in src/themes.js:247

The max resolution where the layer is visible. For WMS layers. On WMTS and vector tiles layers it will have an effect on the node in the layertree but not on the layertree directly.

### metadataUrl

metadataUrl: string

- Defined in src/themes.js:250

The URL to the information on this layer. For WMS and WMTS layers.

### minQueryResolution

minQueryResolution: number

- Defined in src/themes.js:251

The min resolution where the layer is queryable. For WMTS and vector tiles layers.

### minResolution

minResolution: number

- Defined in src/themes.js:253

The min resolution where the layer is visible. For WMS layers. On WMTS and vector tiles layers it will have an effect on the node in the layertree but not on the layer directly.

### ogcServer

ogcServer: string

- Defined in src/themes.js:259

The corresponding OGC server. For WMTS and vector tiles layers.

### opacity

opacity: number

- Defined in src/themes.js:260

Layer opacity. 1.0 means fully visible, 0 means invisible, for every kind of layers.

### printLayers

printLayers: string

- Defined in src/themes.js:262

A WMS layers (comma separated) that will be used instead of the WMTS layer in the print. Used to increase quality of printed WMTS layer. An OGCServer metadata must be set with the name of the OGC server to use for these wms layers. For WMTS layers.

### printNativeAngle

printNativeAngle: boolean

- Defined in src/themes.js:234

Whether the print should rotate the symbols. For layer groups (only).

### queryIconPosition

queryIconPosition: number[]

- Defined in src/themes.js:256

values to define the shape (bbox) to use to query the layer. The values are used like a padding in css with 1, 2, 3 or 4 comma separated values: all / top-bottom, left-right / top, right-left, bottom / top, right, bottom, left.

### queryLayers

queryLayers: string

- Defined in src/themes.js:265

Layers names separate by a comma. For WMTS layers: The WMS layers used as references to query the WMTS or vector tiles layers. An OGCServer metadata must be set with the name of the OGC server to use for this wms layer. For WFS GetFeature request: The WFS layers that should be queried.

### snappingConfig

snappingConfig: GmfSnappingConfig

- Defined in src/themes.js:271

The snapping configuration for the leaf. If set, the leaf's layer is considered to be "snappable", even if the config itself is empty. Example value: {'tolerance': 50, 'edge': false} For WMS layers.

### thumbnail

thumbnail: string

- Defined in src/themes.js:269

The icon visible in the background selector. For every kind of layers.

### timeAttribute

timeAttribute: string

- Defined in src/themes.js:270

The name of the time attribute. For WMS(-T) layers.

### wmsLayers

wmsLayers: string

- Defined in src/themes.js:274

A corresponding WMS layers (comma separated) for WMTS and vector tiles layers. Used to query the WMTS or vector tiles layers and to print them. See also printLayers and queryLayers metadata for more granularity. An OGCServer metadata must be set with the name of the OGC server to use for these wms layers. For WMTS and vector tiles Layers.

Generated using TypeDoc