Optionallayers?: LayerSwitcherLayersConfig[]list of layers to be configured. Each array element is an object, with following properties :
Optionaloptions?: LayerSwitcherOptionsol.control.Control options (see ol.control.Control)
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,
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: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);
});
collapse mode true if widget is collapsed, false otherwise
ProtecteddisposedThe object has already been disposed.
ProtectedlistenerKey name.
Listener.
Type.
Listener.
Add a new layer to control (when added to map) or add new layer configuration
layer to add to layer switcher
Optionalconfig: {additional options for layer configuration
Optionaldescription?: anylayer description (default is null)
Optionallegends?: anylayer legends (default is an empty array)
Optionalmetadata?: anylayer metadata (default is an empty array)
OptionalquicklookUrl?: anylayer quicklookUrl (default is null)
Optionaltitle?: anylayer title (default is layer identifier)
layerswitcher:add LayerSwitcher#ADD_LAYER_EVENT
ProtectedapplyProtectedApply any properties from another object without triggering events.
The source object.
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.
Event object.
false if anyone called preventDefault on the
event object or if any of the listeners returned false.
Clean up.
ProtecteddisposeProtectedExtension point for disposable objects.
Forget add listener added to the control
Returns true if widget is collapsed (minimize), false otherwise
is collapsed
Get container
container
Get layer informations : title, description, quicklookurl, legends, metadata
the ol.layer object
layerInfo - layer informations
Get the listeners for a specified event type. Listeners are returned in the order that they will be called in.
Type.
Listeners.
Get an object of all property names and values.
Object.
Optionaltype: stringType. If not provided,
true will be returned if this event target has any listeners.
Has listeners.
The object has properties.
Check if map view is out of layer range (in terms of extent and zoom)
the Layer object
the Map object
outOfRange - false if map view is out of layer range
Add listeners to catch map layers addition
Lock a layer, so it cannot be removed or modified from layerSwitcher
layer to be locked
true if locked
layerswitcher:lock LayerSwitcher#LOCK_LAYER_EVENT
Key name.
Old value.
ProtectedonceProtectedonKey name.
Listener.
Type.
Listener.
Remove a layer from control
layer.
layerswitcher:remove LayerSwitcher#REMOVE_LAYER_EVENT
Collapse or display control main container
True to collapse control, False to display it
Display or hide removeLayerPicto from layerSwitcher for this layer
ol.layer to be configured
specify if layer can be remove from layerSwitcher (true) or not (false). Default is true
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.
Target.
ProtectedunProtectedUnlisten for a certain type of event.
Type.
Listener.
event triggered when a layer is added layerswitcher:add
event triggered when a layer grayscale is changed layerswitcher:change:grayscale
event triggered when a layer is locked or unlocked layerswitcher:change:locked
event triggered when a layer opacity is changed layerswitcher:change:opacity
event triggered when a layer visibility is changed layerswitcher:change:visibility
event triggered when a custom action is called layerswitcher:custom
event triggered when a layer is edited layerswitcher:edit
event triggered when a layer extent is changed layerswitcher:extent
event triggered when a layer is locked layerswitcher:lock
event triggered when a layer is removed layerswitcher:remove
control options