Class: OlTreeLayerState

OlTreeLayerState(mapLayerState, parentGroupStateopt)

Class representing an OpenLayers tree layer state

Constructor

new OlTreeLayerState(mapLayerState, parentGroupStateopt)

Instantiate an OpenLayers tree layer
Parameters:
Name Type Attributes Description
mapLayerState OlMapLayerState the OpenLayers map layer state
parentGroupState ExternalLayerTreeGroupState <optional>
 the parent layer tree group
Source:

Extends

Classes

OlTreeLayerState

Members

checked :boolean

Map item is checked
Type:
  • boolean
Overrides:
Source:

expanded :boolean

Layer tree item is expanded
Type:
  • boolean
Overrides:
Source:

icon :string

layer icon
Type:
  • string
Source:

icon :string

layer icon
Type:
  • string
Source:

layerConfig :null

Lizmap layer config
Type:
  • null
Overrides:
Source:

level :number

Map item level
Type:
  • number
Overrides:
Source:

(nullable) mapItemState :ExternalMapItemState

External map item state
Type:
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 layer Bounding Boxes
Type:
  • Array
Overrides:
Source:

wmsGeographicBoundingBox :null

WMS layer Geographic Bounding Box
Type:
  • null
Overrides:
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
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:

(nullable) wmsName :string

WMS item name
Type:
  • string
Overrides:
Source:

wmsTitle :string

WMS item title
Type:
  • string
Overrides:
Source:

Methods

calculateVisibility() → {boolean}

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

isVisible(scaleDenominator) → {boolean}

Get item visibility taking care of this.visibility and scale
Parameters:
Name Type Description
scaleDenominator number the scale denominator for which the visibility has to be evaluated
Overrides:
Source:
Returns:
the item visibility
Type
boolean