Class: LayerItemState

LayerState.LayerItemState(type, layerTreeItemCfg, parentGroupopt)

Class representing a layer item state: could be group, vector or raster layer

Constructor

new LayerItemState(type, layerTreeItemCfg, parentGroupopt)

Creating a layer item state
Parameters:
Name Type Attributes Description
type string the layer item type
layerTreeItemCfg LayerTreeItemConfig the layer item config
parentGroup LayerItemState <optional>
 the parent layer group
Source:

Extends

Members

(nullable) abstract :string

Item abstract
Type:
  • string
Source:

baseLayer :boolean

The layer as base layer activation
Type:
  • boolean
Source:

cached :boolean

The layer cached activation
Type:
  • boolean
Source:

checked :boolean

Layer tree item is checked
Type:
  • boolean
Source:

checked :boolean

Set layer tree item is checked
Type:
  • boolean
Source:

displayInLegend :boolean

The layer display in legend activation
Type:
  • boolean
Source:

(nullable) id :string

Item unique id
Type:
  • string
Source:

(nullable) imageFormat :string

The layer image format
Type:
  • string
Source:

isInGroupAsLayer :boolean

The item is in a group as layer
Type:
  • boolean
Source:

(nullable) layerConfig :LayerConfig

Lizmap layer config
Type:
  • LayerConfig
Source:

level :number

The layer tree item level
Type:
  • number
Source:
Item link
Type:
  • string
Source:

mapType :string

Item map type
Type:
  • string
Source:

name :string

Item name
Type:
  • string
Source:

opacity :number

Set layer tree item opacity
Type:
  • number
Source:

singleTile :boolean

The layer singleTile activation
Type:
  • boolean
Source:

(nullable) symbology :LayerIconSymbology|LayerSymbolsSymbology|LayerGroupSymbology

Item symbology
Type:
  • LayerIconSymbology | LayerSymbolsSymbology | LayerGroupSymbology
Source:

symbology

Update Item symbology
Source:

(nullable) title :string

Item title
Type:
  • string
Source:

type :string

Item type
Type:
  • string
Source:

visibility :boolean

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

(nullable) wmsAbstract :string

WMS layer abstract
Type:
  • string
Source:

wmsBoundingBoxes :Array.<LayerBoundingBoxConfig>

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

(nullable) wmsGeographicBoundingBox :LayerGeographicBoundingBoxConfig

WMS layer Geographic Bounding Box
Type:
  • LayerGeographicBoundingBoxConfig
Source:

wmsMaxScaleDenominator :number

WMS layer 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 layer name
Type:
  • string
Source:

wmsTitle :string

WMS layer title
Type:
  • string
Source:

Methods

calculateVisibility() → {boolean}

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