flowfarouk / ol-layerswitcher

Layer control for OpenLayers

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

OpenLayers LayerSwitcher

Grouped layer list control 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).

Examples

The examples demonstrate usage and can be viewed online thanks to RawGit:

The source for all examples can be found in examples.

Install

Browser

JS

Load ol-layerswitcher.js after OpenLayers. The layerswitcher control is available as LayerSwitcher or ol.control.LayerSwitcher.

<script src="https://unpkg.com/ol-layerswitcher@3.0.0"></script>

CSS

<link rel="stylesheet" href="https://unpkg.com/ol-layerswitcher@3.0.0/src/ol-layerswitcher.css" />

Parcel, Webpack etc.

NPM package: ol-layerswitcher.

JS

Install the package via npm

npm install ol-layerswitcher --save

⚠️ If you're using the ol package prior to v5 you'll need to install ol-layerswitcher@v2.0.0.

CSS

The CSS file ol-layerswitcher.css can be found in ./node_modules/ol-layerswitcher/src

To use the layerswitcher with the ol package and a module bundler such as Parcel, Webpack etc. see ol-layerswitcher-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.

renderPanel

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 for
  • panel Element The DOM Element into which the layer tree will be rendered

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 each ol.layer.Base found under lyr. The signature for fn is the same as ol.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.

About

Layer control for OpenLayers


Languages

Language:JavaScript 89.0%Language:CSS 8.4%Language:HTML 2.7%