Grouped layer list control with group selection checkbox for an OpenLayer map.
To be shown in the layer switcher layers should have a title
property; base
layers should have a type
property set to base
. Group layers
(ol.layer.Group
) can be used to visually group layers together; a group with
a fold
property set to either open
or close
will be displayed with a
toggle. See Examples for usage.
Compatible with OpenLayers version 3, 4 and 5 (see note in Install - Parcel,
Webpack etc. regarding installing the appropriate version
of ol-layerswitcher
for OpenLayers).
The examples demonstrate usage and can be viewed online thanks to raw.githack.com:
- Basic usage
- Create a layer switcher control. Each layer to be displayed in the layer switcher has a
title
property as does each Group; each base map layer has atype: 'base'
property.allowSelection
property will enable checkbox to show/hide complete group on map.fold
property will allow you to collaspe\expand group.enableOpacitySliders
property on layer will enable slider to manage opacity.
- Create a layer switcher control. Each layer to be displayed in the layer switcher has a
The source for all examples can be found in examples.
Load ol-layerlist.js
after OpenLayers. The layerswitcher control is available as LayerSwitcher
or ol.control.LayerSwitcher
.
<script src="https://unpkg.com/ol-layerlist@1.1.8"></script>
<link rel="stylesheet" href="https://unpkg.com/ol-layerlist@1.1.8/src/ol-layerlist.css" />
NPM package: ol-layerlist.
Install the package via npm
npm install ol-layerlist --save
ol
package prior to v5 you'll need to install ol-layerlist@v1.1.8
.
To run the tests you'll need to install the dependencies via npm
. In the root of the repository run:
npm install
Then run the tests by opening test/index.html in a browser.
Extends ol.control.Control
OpenLayers Layer Switcher Control. See the examples for usage.
Parameters
opt_options
Object Control options, extends olx.control.ControlOptions adding:
tipLabel
String
- the button tooltip.
Set the map instance the control is associated with.
Parameters
map
ol.Map The map instance.
Show the layer panel.
Hide the layer panel.
Re-draw the layer panel to represent the current state of the layers.
Static Re-draw the layer panel to represent the current state of the layers.
Parameters
map
ol.Map The OpenLayers Map instance to render layers forpanel
Element The DOM Element into which the layer tree will be rendered
Static Call the supplied function for each layer in the passed layer group recursing nested groups.
Parameters
lyr
ol.layer.Group The layer group to start iterating from.fn
Function Callback which will be called for eachol.layer.Base
found underlyr
. The signature forfn
is the same asol.Collection#forEach
Static Generate a UUID
Adapted from http://stackoverflow.com/a/2117523/526860
Returns String UUID
Fold/unfold layer group
Parameters
lyr
li
MIT (c)