OpenLayers LayerSwitcher
Grouped layer list control for an OpenLayer map.
All layers should have a title
property and base layers should have a type
property set to base
. Group layers (ol.layer.Group
) can be used to visually group layers together. See examples/layerswitcher.js for usage.
Examples
The examples demonstrate usage and can be viewed online thanks to RawGit:
- 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.
- Create a layer switcher control. Each layer to be displayed in the layer switcher has a
- Add layer
- Add a layer to an existing layer group after the layer switcher has been added to the map.
- Scrolling
- Demonstrate the panel scrolling vertically, control the height of the layer switcher by setting the
max-height
(see examples/scroll.css) and it's position relative to the bottom of the map (see the.layer-switcher.shown
selector in src/ol-layerswitcher.css).
- Demonstrate the panel scrolling vertically, control the height of the layer switcher by setting the
- Bundling with
ol
package (Browserify, Parcel, Webpack...)- To use the layer switcher with the
ol
package and a module bundler such as Browserify, Parcel, Webpack etc. see ol-layerswitcher-examples.
- To use the layer switcher with the
The source for all examples can be found in examples.
Tests
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.
API
Table of Contents
LayerSwitcher
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.
setMap
Set the map instance the control is associated with.
Parameters
map
ol.Map The map instance.
showPanel
Show the layer panel.
hidePanel
Hide the layer panel.
renderPanel
Re-draw the layer panel to represent the current state of the layers.
forEachRecursive
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
uuid
Static Generate a UUID
Adapted from http://stackoverflow.com/a/2117523/526860
Returns String UUID
License
MIT (c) Matt Walker.
Also see
If you find the layer switcher useful you might also like the ol-popup.