Class: MapItemState

MapLayerState.MapItemState(type, layerItemState, parentMapGroupopt)

Class representing a map item: could be a group or a layer

Constructor

new MapItemState(type, layerItemState, parentMapGroupopt)

Create a map item
Parameters:
Name Type Attributes Description
type string the map layer item type
layerItemState LayerItemState the layer item state
parentMapGroup MapItemState <optional>
 the parent layer map group
Source:

Extends

Members

checked :boolean

Map item is checked
Type:
  • boolean
Source:

checked :boolean

Set map item is checked
Type:
  • boolean
Source:

(nullable) itemState :LayerItemState

Lizmap layer item state
Type:
  • LayerItemState
Source:

(nullable) layerConfig :LayerConfig

Lizmap layer config
Type:
  • LayerConfig
Source:

level :number

the layer item level
Type:
  • number
Source:

name :string

Map item name
Type:
  • string
Source:

opacity :number

Map item opacity
Type:
  • number
Source:

opacity :number

Set map item opacity
Type:
  • number
Source:

type :string

Map item type
Type:
  • string
Source:

visibility :boolean

Map item is visible It depends on the parent visibility
Type:
  • boolean
Source:

wmsBoundingBoxes :Array.<LayerBoundingBoxConfig>

WMS item Bounding Boxes
Type:
  • Array.<LayerBoundingBoxConfig>
Source:

(nullable) wmsGeographicBoundingBox :LayerGeographicBoundingBoxConfig

WMS item Geographic Bounding Box
Type:
  • LayerGeographicBoundingBoxConfig
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
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
Source:

(nullable) wmsName :string

WMS item name
Type:
  • string
Source:

wmsTitle :string

WMS item title
Type:
  • string
Source:

Methods

calculateVisibility() → {boolean}

Calculate and save visibility
Source:
Returns:
the calculated visibility
Type
boolean