ol3-layerswitcher's Introduction

OpenLayers 3 LayerSwitcher

Grouped layer list control for an OL3 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.

Demo

Clone or download the repository and open examples/layerswitcher.html in a browser or view the example on RawGit.

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

`new ol.control.LayerSwitcher(opt_options)`

OpenLayers 3 Layer Switcher Control. See the examples for usage.

Parameters:

Name	Type	Description
`opt_options`	`Object`	Control options, extends olx.control.ControlOptions adding: `tipLabel` `String` - the button tooltip.

Extends

ol.control.Control

Methods

`showPanel()`

Show the layer panel.

`hidePanel()`

Hide the layer panel.

`renderPanel()`

Re-draw the layer panel to represent the current state of the layers.

`setMap(map)`

Set the map instance the control is associated with.

Parameters:

Name	Type	Description
`map`	`ol.Map`	The map instance.

`(static) ol.control.LayerSwitcher.forEachRecursive(lyr,fn)`

Static Call the supplied function for each layer in the passed layer group recursing nested groups.

Parameters:

Name	Type	Description
`lyr`	`ol.layer.Group`	The layer group to start iterating from.
`fn`	`function`	Callback which will be called for each `ol.layer.Base` found under `lyr`. The signature for `fn` is the same as `ol.Collection#forEach`