leaflet/src/layer/SVGOverlay.js

JavaScript library for mobile-friendly interactive maps

import {ImageOverlay} from './ImageOverlay.js';
import * as Util from '../core/Util.js';

/** @import {ImageOverlayEventMap, ImageOverlayOptions} from '../types.js' */

/**
 * Used to load, display and provide DOM access to an SVG file over specific bounds of the map. Extends
 * `ImageOverlay`.
 *
 * An SVG overlay uses the [`<svg>`](https://developer.mozilla.org/docs/Web/SVG/Element/svg) element. A viewBox
 * attribute is required on the SVG element to zoom in and out properly.
 * @constructorDescription Instantiates an SVG overlay given an SVG element and the geographical bounds it is tied to.
 * @example
 * ```js
 * const svgElement = document.createElementNS("http://www.w3.org/2000/svg", "svg");
 * svgElement.setAttribute('xmlns', "http://www.w3.org/2000/svg");
 * svgElement.setAttribute('viewBox', "0 0 200 200");
 * svgElement.innerHTML = '<rect width="200" height="200"/><rect x="75" y="23" width="50" height="50" style="fill:red"/><rect x="75" y="123" width="50" height="50" style="fill:#0013ff"/>';
 * const svgElementBounds = [ [ 32, -130 ], [ 13, -100 ] ];
 * new SVGOverlay(svgElement, svgElementBounds).addTo(map);
 * ```
 * @template {ImageOverlayOptions} [O=ImageOverlayOptions]
 * @template {ImageOverlayEventMap} [E=ImageOverlayEventMap]
 * @extends {ImageOverlay<O, E, SVGElement, SVGElement>}
 */
export class SVGOverlay extends ImageOverlay {
	_initImage() {
		const el = this._image = /** @type {SVGElement} */ (this._url);

		el.classList.add('leaflet-image-layer', 'leaflet-zoom-animated');
		if (this.options.className) { el.classList.add(...Util.splitWords(this.options.className)); }
	}
}