Class: ExternalMapGroupState

ExternalMapGroupState(name)

Class representing an external map group state

Constructor

new ExternalMapGroupState(name)

Instantiate an external map group state

Parameters:
Name Type Description
name string

the external map group name
Source:

Extends

Classes

ExternalMapGroupState

Members

checked :boolean

Map item is checked

Type:
  • boolean
Overrides:
Source:

children :Array.<OlMapLayerState>

Children items

Type:
Source:

childrenCount :number

Children items count

Type:
  • number
Source:

itemState :null

Lizmap layer item state

Type:
  • null
Overrides:
Source:

layerConfig :null

Lizmap layer config

Type:
  • null
Overrides:
Source:

level :number

Map item level

Type:
  • number
Overrides:
Source:

name :string

Map item name

Type:
  • string
Overrides:
Source:

opacity :number

Map item opacity

Type:
  • number
Overrides:
Source:

type :string

Map item type

Type:
  • string
Overrides:
Source:

visibility :boolean

Map item is visible It depends on the parent visibility

Type:
  • boolean
Overrides:
Source:

wmsBoundingBoxes :Array

WMS item Bounding Boxes

Type:
  • Array
Overrides:
Source:

wmsGeographicBoundingBox :null

WMS item Geographic Bounding Box

Type:
  • null
Overrides:
Source:

wmsMaxScaleDenominator :number

WMS Maximum scale denominator If the maximum scale denominator is not defined: -1 is returned If the WMS layer is a group, the maximum scale denominator is the largest of the layers in the group

Type:
  • number
Overrides:
Source:

wmsMinScaleDenominator :number

WMS Minimum scale denominator If the minimum scale denominator is not defined: -1 is returned If the WMS layer is a group, the minimum scale denominator is -1 if only one layer minimum scale denominator is not defined else the smallest layer minimum scale denominator in the group

Type:
  • number
Overrides:
Source:

wmsName :null

WMS item name

Type:
  • null
Overrides:
Source:

wmsTitle :string

WMS item title

Type:
  • string
Overrides:
Source:

Methods

addOlLayer(name, olLayer) → {OlMapLayerState}

Get layer or group item by its name

Parameters:
Name Type Description
name string

the layer name
olLayer object

the OpenLayers layer
Source:
Returns:

The MapLayerState or MapGroupState associated to the name

Type
OlMapLayerState

calculateVisibility() → {boolean}

Calculate and save visibility

Overrides:
Source:
Returns:

the calculated visibility

Type
boolean

clean() → {boolean}

Remove all OpenLayers layer

Source:
Returns:

The children list is empty

Type
boolean

(generator) getChildren() → {OlMapLayerState}

Iterate through children items

Source:
Yields:
The next child item
Type
OlMapLayerState

removeOlLayer(name) → {OlMapLayerState|undefined}

Remove OpenLayers layer

Parameters:
Name Type Description
name string

the OpenLayers layer name to remove
Source:
Returns:

The removed OpenLayers layer or undefined if the name is unknown

Type
OlMapLayerState | undefined