Class LayerSwitcher

Constructors

Properties

collapsed container description disposed element listable listenerKeys on once options selectedLayer un switcherButtons

Events

ADD_LAYER_EVENT CHANGE_LAYER_GRAYSCALE_EVENT CHANGE_LAYER_LOCKED_EVENT CHANGE_LAYER_OPACITY_EVENT CHANGE_LAYER_SELECTED_EVENT CHANGE_LAYER_VISIBILITY_EVENT CUSTOM_LAYER_EVENT EDIT_LAYER_EVENT EXTENT_LAYER_EVENT HEADER_BUTTON_EVENT LOCK_LAYER_EVENT PROPERTY_CHANGE_EVENT REMOVE_LAYER_EVENT

Constructors

constructor

new LayerSwitcher(
    options: {
        layers?: LayerSwitcherLayersConfig[];
        options?: LayerSwitcherOptions;
    },
): LayerSwitcher

Parameters

options: { layers?: LayerSwitcherLayersConfig[]; options?: LayerSwitcherOptions }
control options
- Optionallayers?: LayerSwitcherLayersConfig[]
  
  list of layers to be configured. Each array element is an object, with following properties :
- Optionaloptions?: LayerSwitcherOptions
  
  ol.control.Control options (see ol.control.Control)

Fires

layerswitcher:add

Fires

layerswitcher:remove

Fires

layerswitcher:lock

Fires

layerswitcher:extent

Fires

layerswitcher:edit

Fires

layerswitcher:changeproperty

Fires

layerswitcher:change:selected

Fires

layerswitcher:change:opacity

Fires

layerswitcher:change:visibility

Fires

layerswitcher:change:position

Fires

layerswitcher:change:grayscale

Fires

layerswitcher:change:style

Fires

layerswitcher:change:locked

Fires

layerswitcher:custom

Fires

layerswitcher:header:button

Example

map.addControl(new ol.control.LayerSwitcher(
 [
     {
         layer : wms1,
         config : {
             title : "test layer name 1",
             description : "test layer desc 1",
         }
     }
 ],
 {
     collapsed : true,
     panel : false,
     counter : false,
     position : "top-left",
     allowEdit : true,
     allowGrayScale : true,
     headerButtons : [
         {
             label: 'Ajouter',
             title: 'Ajouter une couche',
             icon: "svg | http",
             cb: (e, switcher) => {},
         },
     ],
     advancedTools : [
         {
             label = 'Bouton',
             icon = "svg | http",
             cb = (e, LayerSwitcher, layer, options) => {},
             styles = {},
         }
     ]
 }
));

LayerSwitcher.on("layerswitcher:add", function (e) {
   console.warn("layer", e.layer);
});
LayerSwitcher.on("layerswitcher:remove", function (e) {
   console.warn("layer", e.layer);
});
LayerSwitcher.on("layerswitcher:extent", function (e) {
   console.warn("layer", e.layer);
});
LayerSwitcher.on("layerswitcher:edit", function (e) {
   console.warn("layer", e.layer);
});
LayerSwitcher.on("layerswitcher:change:selected", function (e) {
   console.warn("layer", e.layer, e.previous);
});
LayerSwitcher.on("layerswitcher:change:opacity", function (e) {
   console.warn("layer", e.layer, e.opacity);
});
LayerSwitcher.on("layerswitcher:change:visibility", function (e) {
   console.warn("layer", e.layer, e.visibility);
});
LayerSwitcher.on("layerswitcher:change:position", function (e) {
   console.warn("layer", e.layer, e.position);
});
LayerSwitcher.on("layerswitcher:change:grayscale", function (e) {
   console.warn("layer", e.layer, e.grayscale);
});
LayerSwitcher.on("layerswitcher:change:style", function (e) {
   console.warn("layer", e.layer, e.name, e.url);
});
LayerSwitcher.on("layerswitcher:change:locked", function (e) {
   console.warn("layer", e.layer, e.locked);
});
LayerSwitcher.on("layerswitcher:custom", function (e) {
  console.warn("layer", e.action, e.layer);
})
LayerSwitcher.on("layerswitcher:header:button", function (e) {
  console.warn("Action", e.action, e.target);
})
LayerSwitcher.on("layerswitcher:propertychange", function (e) {
   console.warn("layer", e.layer, e.key, e.value);
});

Properties

collapsed

collapsed: boolean | undefined

collapse mode true if widget is collapsed, false otherwise

container

container: HTMLElement

description

description: any

`Protected`disposed

disposed: boolean

The object has already been disposed.

element

element: HTMLElement

listable

listable: boolean

`Protected`listenerKeys

listenerKeys: EventsKey[]

on

on: ObjectOnSignature<EventsKey>

once

once: ObjectOnSignature<EventsKey>

options

options:
    | {
        advancedTools: null;
        allowDelete: boolean;
        allowDraggable: boolean;
        allowEdit: boolean;
        allowGrayScale: boolean;
        allowTooltips: boolean;
        collapsed: boolean;
        counter: boolean;
        draggable: boolean;
        gutter: boolean;
        headerButtons: never[];
        id: string;
        panel: boolean;
    }
    | undefined

selectedLayer

selectedLayer:
    | Layer<Source, LayerRenderer<any>, { [x: string]: any }>
    | null
    | undefined

un

un: ObjectOnSignature<void>

`Static`switcherButtons

switcherButtons: {
    EDIT: string;
    EXTENT: string;
    GREYSCALE: string;
    INFO: string;
} = ...

Methods

addChangeListener

addChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.addChangeListener
- Defined in node_modules/ol/Object.d.ts:145

addEventListener

addEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.addEventListener
- Defined in node_modules/ol/events/Target.d.ts:50

addLayer

addLayer(
    layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
    config?: {
        description?: any;
        display?: boolean;
        legends?: any;
        metadata?: any;
        producer?: any;
        quicklookUrl?: any;
        title?: any;
    },
): void
Add a new layer to control (when added to map) or add new layer configuration
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  layer to add to layer switcher
- Optionalconfig: {
      description?: any;
      display?: boolean;
      legends?: any;
      metadata?: any;
      producer?: any;
      quicklookUrl?: any;
      title?: any;
  }
  additional options for layer configuration
  - Optionaldescription?: any
    
    layer description (default is null)
  - Optionaldisplay?: boolean
    
    controls the visibility of the layer entry in the LayerSwitcher only.
  - Optionallegends?: any
    
    layer legends (default is an empty array)
  - Optionalmetadata?: any
    
    layer metadata (default is an empty array)
  - Optionalproducer?: any
    
    layer producer (default is null)
  - OptionalquicklookUrl?: any
    
    layer quicklookUrl (default is null)
  - Optionaltitle?: any
    
    layer title (default is layer identifier)
Returns void
Fires
layerswitcher:add LayerSwitcher#ADD_LAYER_EVENT
Example
```
layerSwitcher.addLayer(
      gpParcels,
      {
          title : "Parcelles cadastrales",
          description : "description de la couche",
          quicklookUrl : "http://quicklookUrl.fr"
      }
  )
```
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:452

`Protected`applyProperties

applyProperties(source: BaseObject): void
Protected
Apply any properties from another object without triggering events.
Parameters
- source: BaseObject
  The source object.
Returns void
Inherited from ControlExtended.applyProperties
- Defined in node_modules/ol/Object.d.ts:172

changed

changed(): void
Increases the revision counter and dispatches a 'change' event.

Returns void

Api
Inherited from ControlExtended.changed
- Defined in node_modules/ol/Observable.d.ts:74

dispatchEvent

dispatchEvent(event: string | BaseEvent): boolean | undefined
Dispatches an event and calls all listeners listening for events of this type. The event parameter can either be a string or an Object with a type property.
Parameters
- event: string | BaseEvent
  Event object.
Returns boolean | undefined
false if anyone called preventDefault on the event object or if any of the listeners returned false.

Api
Inherited from ControlExtended.dispatchEvent
- Defined in node_modules/ol/events/Target.d.ts:61

dispose

dispose(): void
Clean up.

Returns void
Inherited from ControlExtended.dispose
- Defined in node_modules/ol/Disposable.d.ts:19

`Protected`disposeInternal

disposeInternal(): void
Protected
Extension point for disposable objects.

Returns void
Inherited from ControlExtended.disposeInternal
- Defined in node_modules/ol/Disposable.d.ts:24

forget

forget(): void
Forget add listener added to the control

Returns void
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:776

get

get(key: string): any
Gets a value.
Parameters
- key: string
  Key name.
Returns any
Value.

Api
Inherited from ControlExtended.get
- Defined in node_modules/ol/Object.d.ts:114

getCollapsed

getCollapsed(): boolean
Returns true if widget is collapsed (minimize), false otherwise

Returns boolean
is collapsed
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:733

getContainer

getContainer(): HTMLElement
Get container

Returns HTMLElement
container
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:769

getKeys

getKeys(): string[]
Get a list of object property names.

Returns string[]
List of property names.

Api
Inherited from ControlExtended.getKeys
- Defined in node_modules/ol/Object.d.ts:120

getLayerInfo

getLayerInfo(
layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
): any
Get layer informations : title, description, quicklookurl, legends, metadata
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  the ol.layer object
Returns any
layerInfo - layer informations
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:2867

getListeners

getListeners(type: string): Listener[] | undefined
Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.
Parameters
- type: string
  Type.
Returns Listener[] | undefined
Listeners.
Inherited from ControlExtended.getListeners
- Defined in node_modules/ol/events/Target.d.ts:69

getMap

getMap(): Map | null
Get the map associated with this control.

Returns Map | null
Map.

Api
Inherited from ControlExtended.getMap
- Defined in node_modules/ol/control/Control.d.ts:94

getProperties

getProperties(): NoInfer<{ [x: string]: any }>
Get an object of all property names and values.

Returns NoInfer<{ [x: string]: any }>
Object.

Api
Inherited from ControlExtended.getProperties
- Defined in node_modules/ol/Object.d.ts:126

getPropertiesInternal

getPropertiesInternal(): Partial<NoInfer<{ [x: string]: any }>> | null
Get an object of all property names and values.

Returns Partial<NoInfer<{ [x: string]: any }>> | null
Object.
Inherited from ControlExtended.getPropertiesInternal
- Defined in node_modules/ol/Object.d.ts:131

getRevision

getRevision(): number
Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns number
Revision.

Api
Inherited from ControlExtended.getRevision
- Defined in node_modules/ol/Observable.d.ts:81

getSelectedLayer

getSelectedLayer(): | Layer<Source, LayerRenderer<any>, { [x: string]: any }>
| null
Sélectionne une couche et envoie un événement

Returns Layer<Source, LayerRenderer<any>, { [x: string]: any }> | null
Couche sélectionnée.
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:2708

hasListener

hasListener(type?: string): boolean
Parameters
- Optionaltype: string
  Type. If not provided, true will be returned if this event target has any listeners.
Returns boolean
Has listeners.
Inherited from ControlExtended.hasListener
- Defined in node_modules/ol/events/Target.d.ts:75

hasProperties

hasProperties(): boolean
Returns boolean
The object has properties.
Inherited from ControlExtended.hasProperties
- Defined in node_modules/ol/Object.d.ts:135

isInRange

isInRange(
layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
map: Map,
): boolean
Check if map view is out of layer range (in terms of extent and zoom)
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  the Layer object
- map: Map
  the Map object
Returns boolean
outOfRange - false if map view is out of layer range
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:2828

listen

listen(): void
Add listeners to catch map layers addition

Returns void
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:784

lockLayer

lockLayer(
layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
locked: boolean,
): void
Lock a layer, so it cannot be removed or modified from layerSwitcher
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  layer to be locked
- locked: boolean
  true if locked
Returns void

Fires
layerswitcher:lock LayerSwitcher#LOCK_LAYER_EVENT
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:679

notify

notify(key: string, oldValue: any): void
Parameters
- key: string
  Key name.
- oldValue: any
  Old value.
Returns void
Inherited from ControlExtended.notify
- Defined in node_modules/ol/Object.d.ts:140

`Protected`onceInternal

onceInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from ControlExtended.onceInternal
- Defined in node_modules/ol/Observable.d.ts:95

`Protected`onInternal

onInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): EventsKey | EventsKey[]
Protected
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns EventsKey | EventsKey[]
Event key.
Inherited from ControlExtended.onInternal
- Defined in node_modules/ol/Observable.d.ts:88

removeChangeListener

removeChangeListener(key: string, listener: Listener): void
Parameters
- key: string
  Key name.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.removeChangeListener
- Defined in node_modules/ol/Object.d.ts:150

removeEventListener

removeEventListener(type: string, listener: Listener): void
Parameters
- type: string
  Type.
- listener: Listener
  Listener.
Returns void
Inherited from ControlExtended.removeEventListener
- Defined in node_modules/ol/events/Target.d.ts:80

removeLayer

removeLayer(
layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
): void
Remove a layer from control
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  layer.
Returns void

Fires
layerswitcher:remove LayerSwitcher#REMOVE_LAYER_EVENT

Deprecated
on the future version ...
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:615

render

render(mapEvent: MapEvent): void
Renders the control.
Parameters
- mapEvent: MapEvent
  Map event.
Returns void

Api
Inherited from ControlExtended.render
- Defined in node_modules/ol/control/Control.d.ts:88

set

set(key: string, value: any, silent?: boolean): void
Sets a value.
Parameters
- key: string
  Key name.
- value: any
  Value.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void

Api
Inherited from ControlExtended.set
- Defined in node_modules/ol/Object.d.ts:158

setCollapsed

setCollapsed(collapsed: boolean): void
Collapse or display control main container
Parameters
- collapsed: boolean
  True to collapse control, False to display it
Returns void
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:708

setLayerProducer

setLayerProducer(
layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
producer: string,
): void
Modifie le nom du producteur de donnée
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  Couche à modifier
- producer: string
  Nom du producteur. Vide si le producteur doit être enlevé
Returns void
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:2892

setMap

setMap(map: Map): void
Remove the control from its current map and attach it to the new map. Pass null to just remove the control from the current map. Subclasses may set up event handlers to get notified about changes to the map here.
Parameters
- map: Map
  Map.
Returns void

Api
Overrides ControlExtended.setMap
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:308

setPosition

setPosition(pos: any): void
Parameters
- pos: any
Returns void
Inherited from ControlExtended.setPosition
- Defined in src/packages/Controls/Control.js:27

setProperties

setProperties(values: Partial<NoInfer<Properties>>, silent?: boolean): void
Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).
Parameters
- values: Partial<NoInfer<Properties>>
  Values.
- Optionalsilent: boolean
  Update without triggering an event.
Returns void

Api
Inherited from ControlExtended.setProperties
- Defined in node_modules/ol/Object.d.ts:166

setRemovable

setRemovable(
layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
removable: boolean,
): void
Display or hide removeLayerPicto from layerSwitcher for this layer
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  ol.layer to be configured
- removable: boolean
  specify if layer can be remove from layerSwitcher (true) or not (false). Default is true
Returns void
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:743

setSelectedLayer

setSelectedLayer(
layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
selected: boolean,
): void
Sélectionne une couche et envoie un événement et déselectionne la couche déjà sélectionné (si elle existe).
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  Couche à sélectionner.
- selected: boolean
  Vrai si la couche doit être sélectionnée.
Returns void
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:2720

setTarget

setTarget(target: string | HTMLElement): void
This function is used to set a target element for the control. It has no effect if it is called after the control has been added to the map (i.e. after setMap is called on the control). If no target is set in the options passed to the control constructor and if setTarget is not called then the control is added to the map's overlay container.
Parameters
- target: string | HTMLElement
  Target.
Returns void

Api
Inherited from ControlExtended.setTarget
- Defined in node_modules/ol/control/Control.d.ts:113

shouldDisplayLayerInSwitcher

shouldDisplayLayerInSwitcher(
layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>,
): boolean
Indique si la couche doit être affichée dans le gestionnaire de couches. La couche est toujours rendue sur la carte ; seule sa visibilité dans le gestionnaire est contrôlée par cette propriété. Par défaut, une couche est affichée sauf si layer.get("display") === false. Cette propriété n'a aucun effet sur le rendu de la couche sur la carte, elle ne contrôle que la visibilité de son entrée dans le LayerSwitcher.
Parameters
- layer: Layer<Source, LayerRenderer<any>, { [x: string]: any }>
  Couche OpenLayers.
Returns boolean
true si la couche doit apparaître dans le gestionnaire.
- Defined in src/packages/Controls/LayerSwitcher/LayerSwitcher.js:422

`Protected`unInternal

unInternal(
type: string | string[],
listener: (arg0: Event | BaseEvent) => unknown,
): void
Protected
Unlisten for a certain type of event.
Parameters
- type: string | string[]
  Type.
- listener: (arg0: Event | BaseEvent) => unknown
  Listener.
Returns void
Inherited from ControlExtended.unInternal
- Defined in node_modules/ol/Observable.d.ts:102

unset

unset(key: string, silent?: boolean): void
Unsets a property.
Parameters
- key: string
  Key name.
- Optionalsilent: boolean
  Unset without triggering an event.
Returns void

Api
Inherited from ControlExtended.unset
- Defined in node_modules/ol/Object.d.ts:179

updatePosition

updatePosition(pos: any): void
Parameters
- pos: any
Returns void
Inherited from ControlExtended.updatePosition
- Defined in src/packages/Controls/Control.js:34

Events

ADD_LAYER_EVENT

ADD_LAYER_EVENT: string | undefined

event triggered when a layer is added layerswitcher:add

Default Value

"layerswitcher:add"

Param: type

event

Param: layer

layer

Param: target

instance LayerSwitcher

Example

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

CHANGE_LAYER_GRAYSCALE_EVENT

CHANGE_LAYER_GRAYSCALE_EVENT: string | undefined

event triggered when a layer grayscale is changed layerswitcher:change:grayscale

Default Value

"layerswitcher:change:grayscale"

Param: type

event

Param: layer

layer

Param: grayscale

new grayscale value

Param: target

instance LayerSwitcher

Example

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

CHANGE_LAYER_LOCKED_EVENT

CHANGE_LAYER_LOCKED_EVENT: string | undefined

event triggered when a layer is locked or unlocked layerswitcher:change:locked

Default Value

"layerswitcher:change:locked"

Param: type

event

Param: layer

layer

Param: locked

new locked value

Param: target

instance LayerSwitcher

Example

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

CHANGE_LAYER_OPACITY_EVENT

CHANGE_LAYER_OPACITY_EVENT: string | undefined

event triggered when a layer opacity is changed layerswitcher:change:opacity

Default Value

"layerswitcher:change:opacity"

Param: type

event

Param: layer

layer

Param: opacity

new opacity value

Param: target

instance LayerSwitcher

Example

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

CHANGE_LAYER_SELECTED_EVENT

CHANGE_LAYER_SELECTED_EVENT: string | undefined

event triggered when a layer is selected layerswitcher:change:selected

Default Value

"layerswitcher:change:selected"

Param: type

event

Param: layer

new selected layer

Param: previous

old selected layer (null if there was no selected layer before)

Param: target

instance LayerSwitcher

Example

LayerSwitcher.on("layerswitcher:change:selected", function (e) {
  console.log(e, e.layer, e.previous);
})

CHANGE_LAYER_VISIBILITY_EVENT

CHANGE_LAYER_VISIBILITY_EVENT: string | undefined

event triggered when a layer visibility is changed layerswitcher:change:visibility

Default Value

"layerswitcher:change:visibility"

Param: type

event

Param: layer

layer

Param: visibility

new visibility value

Param: target

instance LayerSwitcher

Example

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

CUSTOM_LAYER_EVENT

CUSTOM_LAYER_EVENT: string | undefined

event triggered when a custom action is called layerswitcher:custom

Default Value

"layerswitcher:custom"

Param: type

event

Param: action

label name

Param: layer

layer

Param: options

layer options

Param: target

instance LayerSwitcher

Example

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

EDIT_LAYER_EVENT

EDIT_LAYER_EVENT: string | undefined

event triggered when a layer is edited layerswitcher:edit

Default Value

"layerswitcher:edit"

Param: type

event

Param: layer

layer

Param: options

layer options

Param: target

instance LayerSwitcher

Example

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

EXTENT_LAYER_EVENT

EXTENT_LAYER_EVENT: string | undefined

event triggered when a layer extent is changed layerswitcher:extent

Default Value

"layerswitcher:extent"

Param: extent

extent (map projection)

Param: layer

layer

Param: error

error

Param: target

instance LayerSwitcher

Example

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

HEADER_BUTTON_EVENT

HEADER_BUTTON_EVENT: string | undefined

event triggered when an header button is clicked layerswitcher:header:button

Default Value

"layerswitcher:header:button"

Param: type

event

Param: action

label name

Param: target

instance LayerSwitcher

Example

LayerSwitcher.on("layerswitcher:header:button", function (e) {
  console.log(e.action, e.target);
})

LOCK_LAYER_EVENT

LOCK_LAYER_EVENT: string | undefined

event triggered when a layer is locked layerswitcher:lock

Default Value

"layerswitcher:lock"

Param: type

event

Param: layer

layer

Param: target

instance LayerSwitcher

Example

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

PROPERTY_CHANGE_EVENT

PROPERTY_CHANGE_EVENT: string | undefined

event triggered when a property is modified layerswitcher:propertychange

Default Value

"layerswitcher:propertychange"

Param: type

event

Param: layer

layer

Param: key

Nom de la propriété modifiée. Valeurs documentées et gérées nativement : title, description, producer, display.

Param: value

Nouvelle valeur de la propriété.

Param: target

instance LayerSwitcher

Example

LayerSwitcher.on("layerswitcher:propertychange", function (e) {
  console.log(e.layer);
})

Example

layer.set("title", "Orthophoto");
layer.set("description", "Photographies aériennes");
layer.set("producer", "IGN");
layer.set("display", false); // masque uniquement l'entrée du gestionnaire

REMOVE_LAYER_EVENT

REMOVE_LAYER_EVENT: string | undefined

event triggered when a layer is removed layerswitcher:remove

Default Value

"layerswitcher:remove"

Param: type

event

Param: layer

layer

Param: target

instance LayerSwitcher

Example

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

Class LayerSwitcher

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Parameters

Optionallayers?: LayerSwitcherLayersConfig[]

Optionaloptions?: LayerSwitcherOptions

Returns LayerSwitcher

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Fires

Example

Properties

collapsed

container

description

Protecteddisposed

element

listable

ProtectedlistenerKeys

on

once

options

selectedLayer

un

StaticswitcherButtons

Methods

addChangeListener

Parameters

Returns void

addEventListener

Parameters

Returns void

addLayer

Parameters

Optionaldescription?: any

Optionaldisplay?: boolean

Optionallegends?: any

Optionalmetadata?: any

Optionalproducer?: any

OptionalquicklookUrl?: any

Optionaltitle?: any

Returns void

Fires

Example

ProtectedapplyProperties

Parameters

Returns void

changed

Returns void

Api

dispatchEvent

Parameters

Returns boolean | undefined

Api

dispose

Returns void

ProtecteddisposeInternal

Returns void

forget

Returns void

get

Parameters

`Optional`layers?: LayerSwitcherLayersConfig[]

`Optional`options?: LayerSwitcherOptions

`Protected`disposed

`Protected`listenerKeys

`Static`switcherButtons

`Optional`description?: any

`Optional`display?: boolean

`Optional`legends?: any

`Optional`metadata?: any

`Optional`producer?: any

`Optional`quicklookUrl?: any

`Optional`title?: any

`Protected`applyProperties

`Protected`disposeInternal

`Protected`onceInternal

`Protected`onInternal