(function (global, factory) { typeof exports === 'object' && typeof module !== 'undefined' ? module.exports = factory(require('ol/control/Control'), require('ol/Observable')) : typeof define === 'function' && define.amd ? define(['ol/control/Control', 'ol/Observable'], factory) : (global.LayerSwitcher = factory(global.ol.control.Control,global.ol.Observable)); }(this, (function (Control,Observable) { 'use strict'; Control = 'default' in Control ? Control['default'] : Control; Observable = 'default' in Observable ? Observable['default'] : Observable; var CSS_PREFIX = 'layer-switcher-'; /** * OpenLayers Layer Switcher Control. * See [the examples](./examples) for usage. * @constructor * @extends {ol.control.Control} * @param {Object} opt_options Control options, extends olx.control.ControlOptions adding: * **`tipLabel`** `String` - the button tooltip. */ class LayerSwitcher extends Control { constructor(opt_options) { var options = opt_options || {}; var tipLabel = options.tipLabel ? options.tipLabel : 'Legend'; var element = document.createElement('div'); super({ element: element, target: options.target }); this.mapListeners = []; this.hiddenClassName = 'ol-unselectable ol-control layer-switcher'; if (LayerSwitcher.isTouchDevice_()) { this.hiddenClassName += ' touch'; } this.shownClassName = 'shown'; element.className = this.hiddenClassName; var button = document.createElement('button'); button.setAttribute('title', tipLabel); element.appendChild(button); this.panel = document.createElement('div'); this.panel.className = 'panel'; element.appendChild(this.panel); LayerSwitcher.enableTouchScroll_(this.panel); this.onOpacityChange = options.onOpacityChange || null; this.onLayerToggle = options.onLayerToggle || null; var this_ = this; button.onmouseover = e => { this.showPanel(); }; button.onclick = e => { e = e || window.event; this.showPanel(); e.preventDefault(); }; this_.panel.onmouseout = e => { e = e || window.event; if (!this.panel.contains(e.toElement || e.relatedTarget)) { this.hidePanel(); } }; } /** * Set the map instance the control is associated with. * @param {ol.Map} map The map instance. */ setMap(map) { // Clean up listeners associated with the previous map for (var i = 0, key; i < this.mapListeners.length; i++) { Observable.unByKey(this.mapListeners[i]); } this.mapListeners.length = 0; // Wire up listeners etc. and store reference to new map super.setMap(map); if (map) { var this_ = this; this.mapListeners.push(map.on('pointerdown', function () { this_.hidePanel(); })); this.renderPanel(); } } /** * Show the layer panel. */ showPanel() { if (!this.element.classList.contains(this.shownClassName)) { this.element.classList.add(this.shownClassName); this.renderPanel(); } } /** * Hide the layer panel. */ hidePanel() { if (this.element.classList.contains(this.shownClassName)) { this.element.classList.remove(this.shownClassName); } } /** * Re-draw the layer panel to represent the current state of the layers. */ renderPanel() { LayerSwitcher.renderPanel(this.getMap(), this.panel); } /** * **Static** Re-draw the layer panel to represent the current state of the layers. * @param {ol.Map} map The OpenLayers Map instance to render layers for * @param {Element} panel The DOM Element into which the layer tree will be rendered */ static renderPanel(map, panel) { LayerSwitcher.ensureTopVisibleBaseLayerShown_(map); while (panel.firstChild) { panel.removeChild(panel.firstChild); } var ul = document.createElement('ul'); panel.appendChild(ul); // passing two map arguments instead of lyr as we're passing the map as the root of the layers tree LayerSwitcher.renderLayers_(map, map, ul); } /** * **Static** Ensure only the top-most base layer is visible if more than one is visible. * @param {ol.Map} map The map instance. * @private */ static ensureTopVisibleBaseLayerShown_(map) { var lastVisibleBaseLyr; LayerSwitcher.forEachRecursive(map, function (l, idx, a) { if (l.get('type') === 'base' && l.getVisible()) { lastVisibleBaseLyr = l; } }); if (lastVisibleBaseLyr) LayerSwitcher.setVisible_(map, lastVisibleBaseLyr, true); } /** * **Static** Toggle the visible state of a layer. * Takes care of hiding other layers in the same exclusive group if the layer * is toggle to visible. * @private * @param {ol.Map} map The map instance. * @param {ol.layer.Base} The layer whos visibility will be toggled. */ static setVisible_(map, lyr, visible) { lyr.setVisible(visible); if (visible && lyr.get('type') === 'base') { // Hide all other base layers regardless of grouping LayerSwitcher.forEachRecursive(map, function (l, idx, a) { if (l != lyr && l.get('type') === 'base') { l.setVisible(false); } }); } } /** * **Static** Render all layers that are children of a group. * @private * @param {ol.Map} map The map instance. * @param {ol.layer.Base} lyr Layer to be rendered (should have a title property). * @param {Number} idx Position in parent group list. */ static renderLayer_(map, lyr, idx) { var this_ = this; var li = document.createElement('li'); var lyrTitle = lyr.get('title'); var lyrId = LayerSwitcher.uuid(); var label = document.createElement('label'); if (lyr.getLayers && !lyr.get('combine')) { var input = document.createElement('input'); li.className = 'group'; // Group folding if (lyr.get('fold')) { li.classList.add(CSS_PREFIX + 'fold'); li.classList.add(CSS_PREFIX + lyr.get('fold')); label.onclick = function (e) { LayerSwitcher.toggleFold_(lyr, li); }; } if (lyr.get('allowSelection')) { input.type = 'checkbox'; input.checked = lyr.get('visible'); input.onchange = function (e) { LayerSwitcher.setVisible_(map, lyr, e.target.checked); }; label.innerHTML = lyrTitle; li.appendChild(input); } li.appendChild(label); var ul = document.createElement('ul'); li.appendChild(ul); LayerSwitcher.renderLayers_(map, lyr, ul); } else { li.className = 'layer'; var container = document.createElement('div'), input = document.createElement('input'), input_o = document.createElement('input'); if (lyr.get('type') === 'base') { input.type = 'radio'; input.name = 'base'; } else { input.type = 'checkbox'; } input.id = lyrId; input.checked = lyr.get('visible'); input.onchange = function (e) { LayerSwitcher.setVisible_(map, lyr, e.target.checked); }; container.appendChild(input); label.htmlFor = lyrId; label.innerHTML = lyrTitle; var rsl = map.getView().getResolution(); if (rsl > lyr.getMaxResolution() || rsl < lyr.getMinResolution()) { label.className += ' disabled'; } container.appendChild(label); if (lyr.get('enableOpacitySliders')) { input_o.type = 'range'; input_o.className = 'opacity'; input_o.min = 0; input_o.max = 1; input_o.step = 0.01; input_o.value = lyr.getOpacity(); input_o.onchange = e => { lyr.setOpacity(e.target.value); if (this_.onOpacityChange !== null && typeof this_.onOpacityChange === "function") { this_.onOpacityChange(e.target.value, lyr); } }; container.appendChild(input_o); } li.appendChild(container); if (lyr.get('legend')) { var legend = document.createElement('div'); legend.className = 'legend'; legend.innerHTML = lyrOpt.legend; li.appendChild(lyr.get('legend')); } } return li; } /** * **Static** Render all layers that are children of a group. * @private * @param {ol.Map} map The map instance. * @param {ol.layer.Group} lyr Group layer whos children will be rendered. * @param {Element} elm DOM element that children will be appended to. */ static renderLayers_(map, lyr, elm) { var lyrs = lyr.getLayers().getArray().slice().reverse(); for (var i = 0, l; i < lyrs.length; i++) { l = lyrs[i]; if (l.get('title')) { elm.appendChild(LayerSwitcher.renderLayer_(map, l, i)); } } } /** * **Static** Call the supplied function for each layer in the passed layer group * recursing nested groups. * @param {ol.layer.Group} lyr The layer group to start iterating from. * @param {Function} fn Callback which will be called for each `ol.layer.Base` * found under `lyr`. The signature for `fn` is the same as `ol.Collection#forEach` */ static forEachRecursive(lyr, fn) { lyr.getLayers().forEach(function (lyr, idx, a) { fn(lyr, idx, a); if (lyr.getLayers) { LayerSwitcher.forEachRecursive(lyr, fn); } }); } /** * **Static** Generate a UUID * Adapted from http://stackoverflow.com/a/2117523/526860 * @returns {String} UUID */ static uuid() { return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) { var r = Math.random() * 16 | 0, v = c == 'x' ? r : r & 0x3 | 0x8; return v.toString(16); }); } /** * @private * @desc Apply workaround to enable scrolling of overflowing content within an * element. Adapted from https://gist.github.com/chrismbarr/4107472 */ static enableTouchScroll_(elm) { if (LayerSwitcher.isTouchDevice_()) { var scrollStartPos = 0; elm.addEventListener("touchstart", function (event) { scrollStartPos = this.scrollTop + event.touches[0].pageY; }, false); elm.addEventListener("touchmove", function (event) { this.scrollTop = scrollStartPos - event.touches[0].pageY; }, false); } } /** * @private * @desc Determine if the current browser supports touch events. Adapted from * https://gist.github.com/chrismbarr/4107472 */ static isTouchDevice_() { try { document.createEvent("TouchEvent"); return true; } catch (e) { return false; } } /** * Fold/unfold layer group */ static toggleFold_(lyr, li) { li.classList.remove(CSS_PREFIX + lyr.get('fold')); lyr.set('fold', lyr.get('fold') === 'open' ? 'close' : 'open'); li.classList.add(CSS_PREFIX + lyr.get('fold')); } } // Expose LayerSwitcher as ol.control.LayerSwitcher if using a full build of // OpenLayers if (window.ol && window.ol.control) { window.ol.control.LayerSwitcher = LayerSwitcher; } return LayerSwitcher; })));