Class: LayerConfig

Layer.LayerConfig(cfg)

Class representing a layer config

Constructor

new LayerConfig(cfg)

Create a layer config instance based on a config object
Parameters:
Name Type Description
cfg object the lizmap config object for layer
Properties
Name Type Attributes Description
id string the layer id
name string the layer name
type string the layer type
title string the layer title
abstract string the layer abstract
link string the layer link
minScale number the layer minScale
maxScale number the layer maxScale
toggled boolean the layer toggled activation
popup boolean the layer popup activation
popupSource string the layer popup source
popupTemplate string the layer popup template
popupMaxFeatures number the layer popup max features
popupDisplayChildren boolean the layer popup display children activation
groupAsLayer boolean the layer as group as layer activation (only group type)
baseLayer boolean the layer as base layer activation
displayInLegend boolean the layer display in legend activation
singleTile boolean the layer singleTile activation
imageFormat string the layer image format
cached boolean the layer cached activation
clientCacheExpiration number the layer client cache expiration
shortname string <optional>
the layer short name
layerType string <optional>
the layer layer type (layer only)
geometryType string <optional>
the layer geometry type (layer only)
extent Array.<number> <optional>
the layer extent (layer only)
crs string <optional>
the layer crs (layer only)
opacity number <optional>
the layer opacity defined in QGIS project
noLegendImage boolean <optional>
the layer no legend image activation
legend_image_option string <optional>
the layer legend image option
mutuallyExclusive boolean <optional>
the layer mutuallyExclusive (only group type)
externalWmsToggle boolean <optional>
the layer provides parameters for external access
externalAccess object <optional>
the layer external access
Source:

Extends

  • BaseObjectConfig

Members

abstract :string

The layer abstract
Type:
  • string
Source:

baseLayer :boolean

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

cached :boolean

The layer cached activation
Type:
  • boolean
Source:

clientCacheExpiration :number

The layer client cache expiration
Type:
  • number
Source:

(nullable) crs :string

The layer crs (layer only)
Type:
  • string
Source:

displayInLegend :boolean

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

(nullable) extent :Extent

The layer extent (layer only)
Type:
  • Extent
Source:

(nullable) externalAccess :object

The layer external access (layer only)
Type:
  • object
Source:

externalWmsToggle :boolean

The layer provides parameters for external access (layer only)
Type:
  • boolean
Source:

(nullable) geometryType :string

The layer geometry type (layer only)
Type:
  • string
Source:

groupAsLayer :boolean

The layer as group as layer activation (group only)
Type:
  • boolean
Source:

id :string

The layer id - QGIS layer id
Type:
  • string
Source:

imageFormat :string

The layer image format
Type:
  • string
Source:

(nullable) layerType :string

The layer type (layer only)
Type:
  • string
Source:

(nullable) legendImageOption :string

The layer legend image option
Type:
  • string
Source:
The layer link
Type:
  • string
Source:

maxScale :number

The layer maxScale
Type:
  • number
Source:

minScale :number

The layer minScale
Type:
  • number
Source:

mutuallyExclusive :boolean

The layer mutually exclusive activation (group only)
Type:
  • boolean
Source:

name :string

The layer name - QGIS layer name
Type:
  • string
Source:

noLegendImage :boolean

The layer no legend image activation replaced by legendImageOption
Type:
  • boolean
Deprecated:
  • Yes
Source:

opacity :number

The layer opacity defined in QGIS project
Type:
  • number
Source:
The layer popup activation
Type:
  • boolean
Source:

popupDisplayChildren :boolean

The layer popup display children activation
Type:
  • boolean
Source:

popupMaxFeatures :number

The layer popup max features
Type:
  • number
Source:

popupSource :string

The layer popup source
Type:
  • string
Source:

popupTemplate :string

The layer popup template
Type:
  • string
Source:

(nullable) shortname :string

The layer short name - will be the WMS/WFS/WMTS name if not null
Type:
  • string
Source:

singleTile :boolean

The layer singleTile activation
Type:
  • boolean
Source:

title :string

The layer title
Type:
  • string
Source:

toggled :boolean

The layer toggled activation
Type:
  • boolean
Source:

type :string

The layer type: layer or group
Type:
  • string
Source: