Geoportal Extension for OpenLayers
API Reference

Module: LayerSwitcher

module:~controls/LayerSwitcher

Example

import LayerSwitcher from "gpf-ext-ol/controls/LayerSwitcher"
ou
import { LayerSwitcher } from "gpf-ext-ol"

Events

layerswitcher:add

Controls/LayerSwitcher/LayerSwitcher.js, line 444

event triggered when a layer is added

layerswitcher:add

Controls/LayerSwitcher/LayerSwitcher.js, line 798

event triggered when a layer is added

Name Type Description
type Object

event

layer Object

layer

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:add"
Example
LayerSwitcher.on("layerswitcher:add", function (e) {
  console.log(e.layer);
})

layerswitcher:change:grayscale

Controls/LayerSwitcher/LayerSwitcher.js, line 924

event triggered when a layer grayscale is changed

Name Type Description
type Object

event

layer Object

layer

grayscale Object

new grayscale value

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:change:grayscale"
Example
LayerSwitcher.on("layerswitcher:change:grayscale", function (e) {
  console.log(e.layer, e.grayscale);
})

layerswitcher:change:grayscale

Controls/LayerSwitcher/LayerSwitcher.js, line 1911

event triggered when an grayscale is changed

layerswitcher:change:locked

Controls/LayerSwitcher/LayerSwitcher.js, line 940

event triggered when a layer is locked or unlocked

Name Type Description
type Object

event

layer Object

layer

locked Object

new locked value

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:change:locked"
Example
LayerSwitcher.on("layerswitcher:change:locked", function (e) {
  console.log(e.layer, e.locked);
})

layerswitcher:change:locked

Controls/LayerSwitcher/LayerSwitcher.js, line 1963

event triggered when an locked layer is changed

layerswitcher:change:opacity

Controls/LayerSwitcher/LayerSwitcher.js, line 892

event triggered when a layer opacity is changed

Name Type Description
type Object

event

layer Object

layer

opacity Object

new opacity value

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:change:opacity"
Example
LayerSwitcher.on("layerswitcher:change:opacity", function (e) {
  console.log(e.layer, e.opacity);
})

layerswitcher:change:opacity

Controls/LayerSwitcher/LayerSwitcher.js, line 1308

event triggered when an opacity layer is changed

layerswitcher:change:style

Controls/LayerSwitcher/LayerSwitcher.js, line 1380

event triggered when an select style is changed

Properties:
Name Type Description
type Object

event

name String

name

url String

url

layer Object

layer

target Object

instance LayerSwitcher

Example
LayerSwitcher.on("layerswitcher:change:style", function (e) {
  console.log(e.url);
})

layerswitcher:change:visibility

Controls/LayerSwitcher/LayerSwitcher.js, line 908

event triggered when a layer visibility is changed

Name Type Description
type Object

event

layer Object

layer

visibility Object

new visibility value

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:change:visibility"
Example
LayerSwitcher.on("layerswitcher:change:visibility", function (e) {
  console.log(e.layer, e.visibility);
})

layerswitcher:change:visibility

Controls/LayerSwitcher/LayerSwitcher.js, line 1347

event triggered when an visibility layer is changed

layerswitcher:change:visibility

Controls/LayerSwitcher/LayerSwitcher.js, line 1701

event triggered when an position layer is changed

Properties:
Name Type Description
type Object

event

position Object

position

layer Object

layer

layers Object

layers sorted

target Object

instance LayerSwitcher

Example
LayerSwitcher.on("layerswitcher:change:position", function (e) {
  console.log(e.position);
})

layerswitcher:custom

Controls/LayerSwitcher/LayerSwitcher.js, line 875

event triggered when a custom action is called

Name Type Description
type Object

event

action String

label name

layer Object

layer

options Object

layer options

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:custom"
Example
LayerSwitcher.on("layerswitcher:custom", function (e) {
  console.log(e.layer);
})

layerswitcher:custom

Controls/LayerSwitcher/LayerSwitcher.js, line 2117

event triggered when an action is done

layerswitcher:edit

Controls/LayerSwitcher/LayerSwitcher.js, line 859

event triggered when a layer is edited

Name Type Description
type Object

event

layer Object

layer

options Object

layer options

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:edit"
Example
LayerSwitcher.on("layerswitcher:edit", function (e) {
  console.log(e.layer);
})

layerswitcher:edit

Controls/LayerSwitcher/LayerSwitcher.js, line 1646

event triggered when the edit button is clicked

layerswitcher:extent

Controls/LayerSwitcher/LayerSwitcher.js, line 843

event triggered when a layer extent is changed

Name Type Description
extent Object

extent (map projection)

layer Object

layer

error String

error

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:extent"
Example
LayerSwitcher.on("layerswitcher:extent", function (e) {
  console.log(e.layer);
})

layerswitcher:extent

Controls/LayerSwitcher/LayerSwitcher.js, line 2086

event triggered when an zoom extent is done

layerswitcher:lock

Controls/LayerSwitcher/LayerSwitcher.js, line 536

event triggered when a layer is locked or unlocked

layerswitcher:lock

Controls/LayerSwitcher/LayerSwitcher.js, line 828

event triggered when a layer is locked

Name Type Description
type Object

event

layer Object

layer

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:lock"
Example
LayerSwitcher.on("layerswitcher:lock", function (e) {
  console.log(e.layer);
})

layerswitcher:remove

Controls/LayerSwitcher/LayerSwitcher.js, line 501

event triggered when a layer is removed

layerswitcher:remove

Controls/LayerSwitcher/LayerSwitcher.js, line 813

event triggered when a layer is removed

Name Type Description
type Object

event

layer Object

layer

target Object

instance LayerSwitcher

Default Value:
  • "layerswitcher:remove"
Example
LayerSwitcher.on("layerswitcher:remove", function (e) {
  console.log(e.layer);
})