leaflet
Version:
JavaScript library for mobile-friendly interactive maps
177 lines (143 loc) • 5.23 kB
JavaScript
import {Control} from './Control.js';
import * as DomEvent from '../dom/DomEvent.js';
import * as DomUtil from '../dom/DomUtil.js';
/** @import {AttributionControlDefaults, AttributionControlOptions, ControlOptions, Defaults, MapListeners}
from '../types.js' */
/** @import {LayerBase} from '../layer/LayerBase.js' */
/** @import {LeafletMap} from '../map/Map.js' */
const ukrainianFlag = '<svg aria-hidden="true" width="12" height="8" viewBox="0 0 12 8" class="leaflet-attribution-flag"><path fill="#4C7BE1" d="M0 0h12v4H0z"/><path fill="#FFD500" d="M0 4h12v3H0z"/><path fill="#E0BC00" d="M0 7h12v1H0z"/></svg>';
/** @satisfies {Defaults<ControlOptions>} */
const defaultOptions = {
/**
* The position of the control (one of the map corners). Possible values
* are `'topleft'`, `'topright'`, `'bottomleft'` or `'bottomright'`
*/
position: 'bottomright',
/**
* The HTML text shown before the attributions. Pass `false` to disable.
* @type {string | false}
*/
prefix: `<a target="_blank" href="https://leafletjs.com" lang="en" title="A JavaScript library for interactive maps">${ukrainianFlag}Leaflet</a>`
};
/** @typedef {typeof defaultOptions} AttributionControlDefaultsValues */
/**
* The attribution control allows you to display attribution data in a small text box on a map. It is put
* on the map by default unless you set its [`attributionControl` option](#map-attributioncontrol) to
* `false`, and it fetches attribution texts from layers with the [`getAttribution`
* method](#layer-getattribution) automatically. Extends `Control`.
* @template {AttributionControlOptions} [O=AttributionControlOptions]
* @extends {Control<O & AttributionControlDefaults>}
*/
export class AttributionControl extends Control {
static initHooks = true;
/** @type {Defaults<AttributionControlOptions>} */
static defaultOptions = defaultOptions;
/**
* Creates an attribution control.
* @param {NoInfer<Partial<O>>} [options]
*/
constructor(options) {
super(/** @type {Partial<O & AttributionControlDefaults>} */ (options));
/** @type {{[text: string]: number}} */
this._attributions = {};
/** @type {Map<LayerBase, string>} */
this._layerAttributions = new Map();
/** @type {Set<LayerBase>} */
this._shownLayers = new Set();
this.callInitHooks();
}
/** @param {LeafletMap} map */
onAdd(map) {
map.attributionControl = this;
this._container = DomUtil.create('div', 'leaflet-control-attribution');
DomEvent.disableClickPropagation(this._container);
// before the map is loaded, layers already added to it will still fire layeradd once it loads
if (map._loaded) {
map.eachLayer(layer => this._addLayer({layer}));
}
this._update();
return this._container;
}
/** @returns {MapListeners} */
getEvents() {
return {layeradd: this._addLayer, layerremove: this._removeLayer, zoomend: this._onZoomEnd};
}
onRemove() {
for (const layer of this._layerAttributions.keys()) {
this._removeLayer({layer});
}
}
/** @param {{layer: LayerBase}} e */
_addLayer({layer}) {
const text = layer.getAttribution?.();
if (!text || this._layerAttributions.has(layer)) { return; }
this._layerAttributions.set(layer, text);
this._updateLayer(layer);
}
/** @param {{layer: LayerBase}} e */
_removeLayer({layer}) {
if (this._shownLayers.delete(layer)) {
this.removeAttribution(/** @type {string} */ (this._layerAttributions.get(layer)));
}
this._layerAttributions.delete(layer);
}
_onZoomEnd() {
for (const layer of this._layerAttributions.keys()) {
this._updateLayer(layer);
}
}
/**
* Layers with `minZoom`/`maxZoom` options (e.g. tile layers) aren't displayed outside that range.
* @param {LayerBase} layer
*/
_updateLayer(layer) {
const {minZoom = -Infinity, maxZoom = Infinity} = /** @type {{minZoom?: number, maxZoom?: number}} */ (layer.options);
const zoom = this._map.getZoom();
const show = zoom >= minZoom && zoom <= maxZoom;
if (show === this._shownLayers.has(layer)) { return; }
const text = /** @type {string} */ (this._layerAttributions.get(layer));
if (show) {
this._shownLayers.add(layer);
this.addAttribution(text);
} else {
this._shownLayers.delete(layer);
this.removeAttribution(text);
}
}
/**
* Sets the HTML text shown before the attributions. Pass `false` to disable.
* @param {string | false} prefix
*/
setPrefix(prefix) {
this.options.prefix = prefix;
this._update();
return this;
}
/**
* Adds an attribution text (e.g. `'© OpenStreetMap contributors'`).
* @param {string} text
*/
addAttribution(text) {
if (!text) { return this; }
this._attributions[text] = (this._attributions[text] || 0) + 1;
this._update();
return this;
}
/**
* Removes an attribution text.
* @param {string} text
*/
removeAttribution(text) {
if (!text) { return this; }
if (this._attributions[text]) {
this._attributions[text]--;
this._update();
}
return this;
}
_update() {
if (!this._map) { return; }
const attribs = Object.keys(this._attributions).filter(i => this._attributions[i]).join(', ');
this._container.innerHTML = [this.options.prefix, attribs].filter(Boolean).join(' <span aria-hidden="true">|</span> ');
}
}