Class: ThemeConfig

Theme.ThemeConfig(name, cfg)

Class representing a theme config

Constructor

new ThemeConfig(name, cfg)

Create a theme config instance
Parameters:
Name Type Description
name string The theme name
cfg object the lizmap config object for a theme
Source:

Extends

  • BaseObjectConfig

Members

checkedGroupNodes :Array.<string>

The copy of the checked group nodes list
Type:
  • Array.<string>
Source:

expandedGroupNodes :Array.<string>

The copy of the expanded group nodes list
Type:
  • Array.<string>
Source:

expandedLegendNodes :Array.<string>

The copy of the expanded legend nodes list
Type:
  • Array.<string>
Source:

layerConfigs :Array.<LayerThemeConfig>

The copy of the layer configs of the theme
Type:
  • Array.<LayerThemeConfig>
Source:

layerIds :Array.<string>

The copy of the layer ids of the theme
Type:
  • Array.<string>
Source:

name :string

The theme name
Type:
  • string
Source:

Methods

(generator) getCheckedGroupNodes() → {string}

Iterate through the checked group nodes list
Source:
Yields:
The next checked group node
Type
string

(generator) getExpandedGroupNodes() → {string}

Iterate through the expanded group nodes list
Source:
Yields:
The next expanded group node
Type
string

(generator) getExpandedLegendNodes() → {string}

Iterate through the expanded legend nodes list
Source:
Yields:
The next expanded legend node
Type
string

getLayerConfigByLayerId(layerId) → {LayerThemeConfig}

Get a layer config of the theme by layer id
Parameters:
Name Type Description
layerId string the layer id
Source:
Throws:
The layer id is unknown or the config has been corrupted
Type
RangeError | Error
Returns:
The layer config of the theme
Type
LayerThemeConfig

(generator) getLayerConfigs() → {LayerThemeConfig}

Iterate through layer configs of the theme
Source:
Yields:
The next layer config of the theme
Type
LayerThemeConfig

(generator) getLayerIds() → {string}

Iterate through layer ids of the theme
Source:
Yields:
The next layer id of the theme
Type
string