/*
- Leaflet 1.0.1, a JS library for interactive maps. http://leafletjs.com
+ Leaflet 1.0.2, a JS library for interactive maps. http://leafletjs.com
(c) 2010-2016 Vladimir Agafonkin, (c) 2010-2011 CloudMade
*/
(function (window, document, undefined) {
var L = {
- version: "1.0.1"
+ version: "1.0.2"
};
function expose() {
// @method fire(type: String, data?: Object, propagate?: Boolean): this
// Fires an event of the specified type. You can optionally provide an data
// object — the first argument of the listener function will contain its
- // properties. The event might can optionally be propagated to event parents.
+ // properties. The event can optionally be propagated to event parents.
fire: function (type, data, propagate) {
if (!this.listens(type, propagate)) { return this; }
*/
L.Point = function (x, y, round) {
+ // @property x: Number; The `x` coordinate of the point
this.x = (round ? Math.round(x) : x);
+ // @property y: Number; The `y` coordinate of the point
this.y = (round ? Math.round(y) : y);
};
L.Transformation.prototype = {
// @method transform(point: Point, scale?: Number): Point
// Returns a transformed point, optionally multiplied by the given scale.
- // Only accepts real `L.Point` instances, not arrays.
+ // Only accepts actual `L.Point` instances, not arrays.
transform: function (point, scale) { // (Point, Number) -> Point
return this._transform(point.clone(), scale);
},
// @method untransform(point: Point, scale?: Number): Point
// Returns the reverse transformation of the given point, optionally divided
- // by the given scale. Only accepts real `L.Point` instances, not arrays.
+ // by the given scale. Only accepts actual `L.Point` instances, not arrays.
untransform: function (point, scale) {
scale = scale || 1;
return new L.Point(
* @example
*
* ```js
- * var southWest = L.latLng(40.712, -74.227),
- * northEast = L.latLng(40.774, -74.125),
- * bounds = L.latLngBounds(southWest, northEast);
+ * var corner1 = L.latLng(40.712, -74.227),
+ * corner2 = L.latLng(40.774, -74.125),
+ * bounds = L.latLngBounds(corner1, corner2);
* ```
*
* All Leaflet methods that accept LatLngBounds objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:
* [40.774, -74.125]
* ]);
* ```
+ *
+ * Caution: if the area crosses the antimeridian (often confused with the International Date Line), you must specify corners _outside_ the [-180, 180] degrees longitude range.
*/
-L.LatLngBounds = function (southWest, northEast) { // (LatLng, LatLng) or (LatLng[])
- if (!southWest) { return; }
+L.LatLngBounds = function (corner1, corner2) { // (LatLng, LatLng) or (LatLng[])
+ if (!corner1) { return; }
- var latlngs = northEast ? [southWest, northEast] : southWest;
+ var latlngs = corner2 ? [corner1, corner2] : corner1;
for (var i = 0, len = latlngs.length; i < len; i++) {
this.extend(latlngs[i]);
// TODO International date line?
-// @factory L.latLngBounds(southWest: LatLng, northEast: LatLng)
-// Creates a `LatLngBounds` object by defining south-west and north-east corners of the rectangle.
+// @factory L.latLngBounds(corner1: LatLng, corner2: LatLng)
+// Creates a `LatLngBounds` object by defining two diagonally opposite corners of the rectangle.
// @alternative
// @factory L.latLngBounds(latlngs: LatLng[])
* @crs L.CRS.EPSG4326
*
* A common CRS among GIS enthusiasts. Uses simple Equirectangular projection.
+ *
+ * Leaflet 1.0.x complies with the [TMS coordinate scheme for EPSG:4326](https://wiki.osgeo.org/wiki/Tile_Map_Service_Specification#global-geodetic),
+ * which is a breaking change from 0.7.x behaviour. If you are using a `TileLayer`
+ * with this CRS, ensure that there are two 256x256 pixel tiles covering the
+ * whole earth at zoom level zero, and that the tile coordinate origin is (-180,+90),
+ * or (-180,-90) for `TileLayer`s with [the `tms` option](#tilelayer-tms) set.
*/
L.CRS.EPSG4326 = L.extend({}, L.CRS.Earth, {
// @section Animation Options
+ // @option zoomAnimation: Boolean = true
+ // Whether the map zoom animation is enabled. By default it's enabled
+ // in all browsers that support CSS3 Transitions except Android.
+ zoomAnimation: true,
+
+ // @option zoomAnimationThreshold: Number = 4
+ // Won't animate zoom if the zoom difference exceeds this value.
+ zoomAnimationThreshold: 4,
+
// @option fadeAnimation: Boolean = true
// Whether the tile fade animation is enabled. By default it's enabled
// in all browsers that support CSS3 Transitions except Android.
this.callInitHooks();
+ // don't animate on browsers without hardware-accelerated transitions or old Android/Opera
+ this._zoomAnimated = L.DomUtil.TRANSITION && L.Browser.any3d && !L.Browser.mobileOpera &&
+ this.options.zoomAnimation;
+
+ // zoom transitions run with the same duration for all layers, so if one of transitionend events
+ // happens after starting zoom animation (propagating to the map pane), we know that it ended globally
+ if (this._zoomAnimated) {
+ this._createAnimProxy();
+ L.DomEvent.on(this._proxy, L.DomUtil.TRANSITION_END, this._catchTransitionEnd, this);
+ }
+
this._addLayers(this.options.layers);
},
// @method setView(center: LatLng, zoom: Number, options?: Zoom/pan options): this
// Sets the view of the map (geographical center and zoom) with the given
// animation options.
- setView: function (center, zoom) {
- // replaced by animation-powered implementation in Map.PanAnimation.js
- zoom = zoom === undefined ? this.getZoom() : zoom;
- this._resetView(L.latLng(center), zoom);
+ setView: function (center, zoom, options) {
+
+ zoom = zoom === undefined ? this._zoom : this._limitZoom(zoom);
+ center = this._limitCenter(L.latLng(center), zoom, this.options.maxBounds);
+ options = options || {};
+
+ this._stop();
+
+ if (this._loaded && !options.reset && options !== true) {
+
+ if (options.animate !== undefined) {
+ options.zoom = L.extend({animate: options.animate}, options.zoom);
+ options.pan = L.extend({animate: options.animate, duration: options.duration}, options.pan);
+ }
+
+ // try animating pan or zoom
+ var moved = (this._zoom !== zoom) ?
+ this._tryAnimatedZoom && this._tryAnimatedZoom(center, zoom, options.zoom) :
+ this._tryAnimatedPan(center, options.pan);
+
+ if (moved) {
+ // prevent resize handler call, the view will refresh after animation anyway
+ clearTimeout(this._sizeTimer);
+ return this;
+ }
+ }
+
+ // animation didn't start, just reset the map view
+ this._resetView(center, zoom);
+
return this;
},
// @method panBy(offset: Point): this
// Pans the map by a given number of pixels (animated).
- panBy: function (offset) { // (Point)
- // replaced with animated panBy in Map.PanAnimation.js
- this.fire('movestart');
+ panBy: function (offset, options) {
+ offset = L.point(offset).round();
+ options = options || {};
+
+ if (!offset.x && !offset.y) {
+ return this.fire('moveend');
+ }
+ // If we pan too far, Chrome gets issues with tiles
+ // and makes them disappear or appear in the wrong place (slightly offset) #2602
+ if (options.animate !== true && !this.getSize().contains(offset)) {
+ this._resetView(this.unproject(this.project(this.getCenter()).add(offset)), this.getZoom());
+ return this;
+ }
- this._rawPanBy(L.point(offset));
+ if (!this._panAnim) {
+ this._panAnim = new L.PosAnimation();
- this.fire('move');
- return this.fire('moveend');
+ this._panAnim.on({
+ 'step': this._onPanTransitionStep,
+ 'end': this._onPanTransitionEnd
+ }, this);
+ }
+
+ // don't fire movestart if animating inertia
+ if (!options.noMoveStart) {
+ this.fire('movestart');
+ }
+
+ // animate pan unless animate: false specified
+ if (options.animate !== false) {
+ L.DomUtil.addClass(this._mapPane, 'leaflet-pan-anim');
+
+ var newPos = this._getMapPanePos().subtract(offset).round();
+ this._panAnim.run(this._mapPane, newPos, options.duration || 0.25, options.easeLinearity);
+ } else {
+ this._rawPanBy(offset);
+ this.fire('move').fire('moveend');
+ }
+
+ return this;
+ },
+
+ // @method flyTo(latlng: LatLng, zoom?: Number, options?: Zoom/pan options): this
+ // Sets the view of the map (geographical center and zoom) performing a smooth
+ // pan-zoom animation.
+ flyTo: function (targetCenter, targetZoom, options) {
+
+ options = options || {};
+ if (options.animate === false || !L.Browser.any3d) {
+ return this.setView(targetCenter, targetZoom, options);
+ }
+
+ this._stop();
+
+ var from = this.project(this.getCenter()),
+ to = this.project(targetCenter),
+ size = this.getSize(),
+ startZoom = this._zoom;
+
+ targetCenter = L.latLng(targetCenter);
+ targetZoom = targetZoom === undefined ? startZoom : targetZoom;
+
+ var w0 = Math.max(size.x, size.y),
+ w1 = w0 * this.getZoomScale(startZoom, targetZoom),
+ u1 = (to.distanceTo(from)) || 1,
+ rho = 1.42,
+ rho2 = rho * rho;
+
+ function r(i) {
+ var s1 = i ? -1 : 1,
+ s2 = i ? w1 : w0,
+ t1 = w1 * w1 - w0 * w0 + s1 * rho2 * rho2 * u1 * u1,
+ b1 = 2 * s2 * rho2 * u1,
+ b = t1 / b1,
+ sq = Math.sqrt(b * b + 1) - b;
+
+ // workaround for floating point precision bug when sq = 0, log = -Infinite,
+ // thus triggering an infinite loop in flyTo
+ var log = sq < 0.000000001 ? -18 : Math.log(sq);
+
+ return log;
+ }
+
+ function sinh(n) { return (Math.exp(n) - Math.exp(-n)) / 2; }
+ function cosh(n) { return (Math.exp(n) + Math.exp(-n)) / 2; }
+ function tanh(n) { return sinh(n) / cosh(n); }
+
+ var r0 = r(0);
+
+ function w(s) { return w0 * (cosh(r0) / cosh(r0 + rho * s)); }
+ function u(s) { return w0 * (cosh(r0) * tanh(r0 + rho * s) - sinh(r0)) / rho2; }
+
+ function easeOut(t) { return 1 - Math.pow(1 - t, 1.5); }
+
+ var start = Date.now(),
+ S = (r(1) - r0) / rho,
+ duration = options.duration ? 1000 * options.duration : 1000 * S * 0.8;
+
+ function frame() {
+ var t = (Date.now() - start) / duration,
+ s = easeOut(t) * S;
+
+ if (t <= 1) {
+ this._flyToFrame = L.Util.requestAnimFrame(frame, this);
+
+ this._move(
+ this.unproject(from.add(to.subtract(from).multiplyBy(u(s) / u1)), startZoom),
+ this.getScaleZoom(w0 / w(s), startZoom),
+ {flyTo: true});
+
+ } else {
+ this
+ ._move(targetCenter, targetZoom)
+ ._moveEnd(true);
+ }
+ }
+
+ this._moveStart(true);
+
+ frame.call(this);
+ return this;
+ },
+
+ // @method flyToBounds(bounds: LatLngBounds, options?: fitBounds options): this
+ // Sets the view of the map with a smooth animation like [`flyTo`](#map-flyto),
+ // but takes a bounds parameter like [`fitBounds`](#map-fitbounds).
+ flyToBounds: function (bounds, options) {
+ var target = this._getBoundsCenterZoom(bounds, options);
+ return this.flyTo(target.center, target.zoom, options);
},
// @method setMaxBounds(bounds: Bounds): this
return this._stop();
},
+ // @section Geolocation methods
+ // @method locate(options?: Locate options): this
+ // Tries to locate the user using the Geolocation API, firing a [`locationfound`](#map-locationfound)
+ // event with location data on success or a [`locationerror`](#map-locationerror) event on failure,
+ // and optionally sets the map view to the user's location with respect to
+ // detection accuracy (or to the world view if geolocation failed).
+ // Note that, if your page doesn't use HTTPS, this method will fail in
+ // modern browsers ([Chrome 50 and newer](https://sites.google.com/a/chromium.org/dev/Home/chromium-security/deprecating-powerful-features-on-insecure-origins))
+ // See `Locate options` for more details.
+ locate: function (options) {
- // TODO handler.addTo
- // TODO Appropiate docs section?
- // @section Other Methods
- // @method addHandler(name: String, HandlerClass: Function): this
- // Adds a new `Handler` to the map, given its name and constructor function.
- addHandler: function (name, HandlerClass) {
- if (!HandlerClass) { return this; }
+ options = this._locateOptions = L.extend({
+ timeout: 10000,
+ watch: false
+ // setView: false
+ // maxZoom: <Number>
+ // maximumAge: 0
+ // enableHighAccuracy: false
+ }, options);
- var handler = this[name] = new HandlerClass(this);
+ if (!('geolocation' in navigator)) {
+ this._handleGeolocationError({
+ code: 0,
+ message: 'Geolocation not supported.'
+ });
+ return this;
+ }
- this._handlers.push(handler);
+ var onResponse = L.bind(this._handleGeolocationResponse, this),
+ onError = L.bind(this._handleGeolocationError, this);
- if (this.options[name]) {
- handler.enable();
+ if (options.watch) {
+ this._locationWatchId =
+ navigator.geolocation.watchPosition(onResponse, onError, options);
+ } else {
+ navigator.geolocation.getCurrentPosition(onResponse, onError, options);
}
-
return this;
},
- // @method remove(): this
- // Destroys the map and clears all related event listeners.
- remove: function () {
-
- this._initEvents(true);
-
- if (this._containerId !== this._container._leaflet_id) {
- throw new Error('Map container is being reused by another instance');
+ // @method stopLocate(): this
+ // Stops watching location previously initiated by `map.locate({watch: true})`
+ // and aborts resetting the map view if map.locate was called with
+ // `{setView: true}`.
+ stopLocate: function () {
+ if (navigator.geolocation && navigator.geolocation.clearWatch) {
+ navigator.geolocation.clearWatch(this._locationWatchId);
}
-
- try {
- // throws error in IE6-8
- delete this._container._leaflet_id;
- delete this._containerId;
- } catch (e) {
- /*eslint-disable */
- this._container._leaflet_id = undefined;
- /*eslint-enable */
- this._containerId = undefined;
+ if (this._locateOptions) {
+ this._locateOptions.setView = false;
}
+ return this;
+ },
- L.DomUtil.remove(this._mapPane);
+ _handleGeolocationError: function (error) {
+ var c = error.code,
+ message = error.message ||
+ (c === 1 ? 'permission denied' :
+ (c === 2 ? 'position unavailable' : 'timeout'));
- if (this._clearControlPos) {
- this._clearControlPos();
+ if (this._locateOptions.setView && !this._loaded) {
+ this.fitWorld();
}
- this._clearHandlers();
-
- if (this._loaded) {
- // @section Map state change events
- // @event unload: Event
- // Fired when the map is destroyed with [remove](#map-remove) method.
- this.fire('unload');
- }
+ // @section Location events
+ // @event locationerror: ErrorEvent
+ // Fired when geolocation (using the [`locate`](#map-locate) method) failed.
+ this.fire('locationerror', {
+ code: c,
+ message: 'Geolocation error: ' + message + '.'
+ });
+ },
+
+ _handleGeolocationResponse: function (pos) {
+ var lat = pos.coords.latitude,
+ lng = pos.coords.longitude,
+ latlng = new L.LatLng(lat, lng),
+ bounds = latlng.toBounds(pos.coords.accuracy),
+ options = this._locateOptions;
+
+ if (options.setView) {
+ var zoom = this.getBoundsZoom(bounds);
+ this.setView(latlng, options.maxZoom ? Math.min(zoom, options.maxZoom) : zoom);
+ }
+
+ var data = {
+ latlng: latlng,
+ bounds: bounds,
+ timestamp: pos.timestamp
+ };
+
+ for (var i in pos.coords) {
+ if (typeof pos.coords[i] === 'number') {
+ data[i] = pos.coords[i];
+ }
+ }
+
+ // @event locationfound: LocationEvent
+ // Fired when geolocation (using the [`locate`](#map-locate) method)
+ // went successfully.
+ this.fire('locationfound', data);
+ },
+
+ // TODO handler.addTo
+ // TODO Appropiate docs section?
+ // @section Other Methods
+ // @method addHandler(name: String, HandlerClass: Function): this
+ // Adds a new `Handler` to the map, given its name and constructor function.
+ addHandler: function (name, HandlerClass) {
+ if (!HandlerClass) { return this; }
+
+ var handler = this[name] = new HandlerClass(this);
+
+ this._handlers.push(handler);
+
+ if (this.options[name]) {
+ handler.enable();
+ }
+
+ return this;
+ },
+
+ // @method remove(): this
+ // Destroys the map and clears all related event listeners.
+ remove: function () {
+
+ this._initEvents(true);
+
+ if (this._containerId !== this._container._leaflet_id) {
+ throw new Error('Map container is being reused by another instance');
+ }
+
+ try {
+ // throws error in IE6-8
+ delete this._container._leaflet_id;
+ delete this._containerId;
+ } catch (e) {
+ /*eslint-disable */
+ this._container._leaflet_id = undefined;
+ /*eslint-enable */
+ this._containerId = undefined;
+ }
+
+ L.DomUtil.remove(this._mapPane);
+
+ if (this._clearControlPos) {
+ this._clearControlPos();
+ }
+
+ this._clearHandlers();
+
+ if (this._loaded) {
+ // @section Map state change events
+ // @event unload: Event
+ // Fired when the map is destroyed with [remove](#map-remove) method.
+ this.fire('unload');
+ }
for (var i in this._layers) {
this._layers[i].remove();
return this.project(latlng, zoom)._subtract(topLeft);
},
+ _latLngBoundsToNewLayerBounds: function (latLngBounds, zoom, center) {
+ var topLeft = this._getNewPixelOrigin(center, zoom);
+ return L.bounds([
+ this.project(latLngBounds.getSouthWest(), zoom)._subtract(topLeft),
+ this.project(latLngBounds.getNorthWest(), zoom)._subtract(topLeft),
+ this.project(latLngBounds.getSouthEast(), zoom)._subtract(topLeft),
+ this.project(latLngBounds.getNorthEast(), zoom)._subtract(topLeft)
+ ]);
+ },
+
// layer point of the current center
_getCenterLayerPoint: function () {
return this.containerPointToLayerPoint(this.getSize()._divideBy(2));
zoom = Math.round(zoom / snap) * snap;
}
return Math.max(min, Math.min(max, zoom));
+ },
+
+ _onPanTransitionStep: function () {
+ this.fire('move');
+ },
+
+ _onPanTransitionEnd: function () {
+ L.DomUtil.removeClass(this._mapPane, 'leaflet-pan-anim');
+ this.fire('moveend');
+ },
+
+ _tryAnimatedPan: function (center, options) {
+ // difference between the new and current centers in pixels
+ var offset = this._getCenterOffset(center)._floor();
+
+ // don't animate too far unless animate: true specified in options
+ if ((options && options.animate) !== true && !this.getSize().contains(offset)) { return false; }
+
+ this.panBy(offset, options);
+
+ return true;
+ },
+
+ _createAnimProxy: function () {
+
+ var proxy = this._proxy = L.DomUtil.create('div', 'leaflet-proxy leaflet-zoom-animated');
+ this._panes.mapPane.appendChild(proxy);
+
+ this.on('zoomanim', function (e) {
+ var prop = L.DomUtil.TRANSFORM,
+ transform = proxy.style[prop];
+
+ L.DomUtil.setTransform(proxy, this.project(e.center, e.zoom), this.getZoomScale(e.zoom, 1));
+
+ // workaround for case when transform is the same and so transitionend event is not fired
+ if (transform === proxy.style[prop] && this._animatingZoom) {
+ this._onZoomTransitionEnd();
+ }
+ }, this);
+
+ this.on('load moveend', function () {
+ var c = this.getCenter(),
+ z = this.getZoom();
+ L.DomUtil.setTransform(proxy, this.project(c, z), this.getZoomScale(z, 1));
+ }, this);
+ },
+
+ _catchTransitionEnd: function (e) {
+ if (this._animatingZoom && e.propertyName.indexOf('transform') >= 0) {
+ this._onZoomTransitionEnd();
+ }
+ },
+
+ _nothingToAnimate: function () {
+ return !this._container.getElementsByClassName('leaflet-zoom-animated').length;
+ },
+
+ _tryAnimatedZoom: function (center, zoom, options) {
+
+ if (this._animatingZoom) { return true; }
+
+ options = options || {};
+
+ // don't animate if disabled, not supported or zoom difference is too large
+ if (!this._zoomAnimated || options.animate === false || this._nothingToAnimate() ||
+ Math.abs(zoom - this._zoom) > this.options.zoomAnimationThreshold) { return false; }
+
+ // offset is the pixel coords of the zoom origin relative to the current center
+ var scale = this.getZoomScale(zoom),
+ offset = this._getCenterOffset(center)._divideBy(1 - 1 / scale);
+
+ // don't animate if the zoom origin isn't within one screen from the current center, unless forced
+ if (options.animate !== true && !this.getSize().contains(offset)) { return false; }
+
+ L.Util.requestAnimFrame(function () {
+ this
+ ._moveStart(true)
+ ._animateZoom(center, zoom, true);
+ }, this);
+
+ return true;
+ },
+
+ _animateZoom: function (center, zoom, startAnim, noUpdate) {
+ if (startAnim) {
+ this._animatingZoom = true;
+
+ // remember what center/zoom to set after animation
+ this._animateToCenter = center;
+ this._animateToZoom = zoom;
+
+ L.DomUtil.addClass(this._mapPane, 'leaflet-zoom-anim');
+ }
+
+ // @event zoomanim: ZoomAnimEvent
+ // Fired on every frame of a zoom animation
+ this.fire('zoomanim', {
+ center: center,
+ zoom: zoom,
+ noUpdate: noUpdate
+ });
+
+ // Work around webkit not firing 'transitionend', see https://github.com/Leaflet/Leaflet/issues/3689, 2693
+ setTimeout(L.bind(this._onZoomTransitionEnd, this), 250);
+ },
+
+ _onZoomTransitionEnd: function () {
+ if (!this._animatingZoom) { return; }
+
+ L.DomUtil.removeClass(this._mapPane, 'leaflet-zoom-anim');
+
+ this._animatingZoom = false;
+
+ this._move(this._animateToCenter, this._animateToZoom);
+
+ // This anim frame should prevent an obscure iOS webkit tile loading race condition.
+ L.Util.requestAnimFrame(function () {
+ this._moveEnd(true);
+ }, this);
}
});
// @option pane: String = 'overlayPane'
// By default the layer will be added to the map's [overlay pane](#map-overlaypane). Overriding this option will cause the layer to be placed on another pane by default.
pane: 'overlayPane',
- nonBubblingEvents: [] // Array of events that should not be bubbled to DOM parents (like the map)
+ nonBubblingEvents: [], // Array of events that should not be bubbled to DOM parents (like the map),
+
+ // @option attribution: String = null
+ // String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ attribution: null,
},
/* @section
return this;
},
+ // @method getAttribution: String
+ // Used by the `attribution control`, returns the [attribution option](#gridlayer-attribution).
+ getAttribution: function () {
+ return this.options.attribution;
+ },
+
_layerAdd: function (e) {
var map = e.target;
if (oldZoomSpan !== this._getZoomSpan()) {
this.fire('zoomlevelschange');
}
+
+ if (this.options.maxZoom === undefined && this._layersMaxZoom && this.getZoom() > this._layersMaxZoom) {
+ this.setZoom(this._layersMaxZoom);
+ }
+ if (this.options.minZoom === undefined && this._layersMinZoom && this.getZoom() < this._layersMinZoom) {
+ this.setZoom(this._layersMinZoom);
+ }
}
});
/*
- * @namespace Projection
- * @projection L.Projection.Mercator
- *
- * Elliptical Mercator projection — more complex than Spherical Mercator. Takes into account that Earth is a geoid, not a perfect sphere. Used by the EPSG:3395 CRS.
+ * @namespace DomEvent
+ * Utility functions to work with the [DOM events](https://developer.mozilla.org/docs/Web/API/Event), used by Leaflet internally.
*/
-L.Projection.Mercator = {
- R: 6378137,
- R_MINOR: 6356752.314245179,
+// Inspired by John Resig, Dean Edwards and YUI addEvent implementations.
- bounds: L.bounds([-20037508.34279, -15496570.73972], [20037508.34279, 18764656.23138]),
- project: function (latlng) {
- var d = Math.PI / 180,
- r = this.R,
- y = latlng.lat * d,
- tmp = this.R_MINOR / r,
- e = Math.sqrt(1 - tmp * tmp),
- con = e * Math.sin(y);
- var ts = Math.tan(Math.PI / 4 - y / 2) / Math.pow((1 - con) / (1 + con), e / 2);
- y = -r * Math.log(Math.max(ts, 1E-10));
+var eventsKey = '_leaflet_events';
- return new L.Point(latlng.lng * d * r, y);
- },
+L.DomEvent = {
- unproject: function (point) {
- var d = 180 / Math.PI,
- r = this.R,
- tmp = this.R_MINOR / r,
- e = Math.sqrt(1 - tmp * tmp),
- ts = Math.exp(-point.y / r),
- phi = Math.PI / 2 - 2 * Math.atan(ts);
+ // @function on(el: HTMLElement, types: String, fn: Function, context?: Object): this
+ // Adds a listener function (`fn`) to a particular DOM event type of the
+ // element `el`. You can optionally specify the context of the listener
+ // (object the `this` keyword will point to). You can also pass several
+ // space-separated types (e.g. `'click dblclick'`).
- for (var i = 0, dphi = 0.1, con; i < 15 && Math.abs(dphi) > 1e-7; i++) {
- con = e * Math.sin(phi);
- con = Math.pow((1 - con) / (1 + con), e / 2);
- dphi = Math.PI / 2 - 2 * Math.atan(ts * con) - phi;
- phi += dphi;
+ // @alternative
+ // @function on(el: HTMLElement, eventMap: Object, context?: Object): this
+ // Adds a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}`
+ on: function (obj, types, fn, context) {
+
+ if (typeof types === 'object') {
+ for (var type in types) {
+ this._on(obj, type, types[type], fn);
+ }
+ } else {
+ types = L.Util.splitWords(types);
+
+ for (var i = 0, len = types.length; i < len; i++) {
+ this._on(obj, types[i], fn, context);
+ }
}
- return new L.LatLng(phi * d, point.x * d / r);
- }
-};
+ return this;
+ },
+ // @function off(el: HTMLElement, types: String, fn: Function, context?: Object): this
+ // Removes a previously added listener function. If no function is specified,
+ // it will remove all the listeners of that particular DOM event from the element.
+ // Note that if you passed a custom context to on, you must pass the same
+ // context to `off` in order to remove the listener.
+ // @alternative
+ // @function off(el: HTMLElement, eventMap: Object, context?: Object): this
+ // Removes a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}`
+ off: function (obj, types, fn, context) {
-/*
- * @namespace CRS
- * @crs L.CRS.EPSG3395
- *
- * Rarely used by some commercial tile providers. Uses Elliptical Mercator projection.
- */
+ if (typeof types === 'object') {
+ for (var type in types) {
+ this._off(obj, type, types[type], fn);
+ }
+ } else {
+ types = L.Util.splitWords(types);
-L.CRS.EPSG3395 = L.extend({}, L.CRS.Earth, {
- code: 'EPSG:3395',
- projection: L.Projection.Mercator,
+ for (var i = 0, len = types.length; i < len; i++) {
+ this._off(obj, types[i], fn, context);
+ }
+ }
- transformation: (function () {
- var scale = 0.5 / (Math.PI * L.Projection.Mercator.R);
- return new L.Transformation(scale, 0.5, -scale, 0.5);
- }())
-});
+ return this;
+ },
+ _on: function (obj, type, fn, context) {
+ var id = type + L.stamp(fn) + (context ? '_' + L.stamp(context) : '');
+ if (obj[eventsKey] && obj[eventsKey][id]) { return this; }
-/*
- * @class GridLayer
- * @inherits Layer
- * @aka L.GridLayer
- *
- * Generic class for handling a tiled grid of HTML elements. This is the base class for all tile layers and replaces `TileLayer.Canvas`.
- * GridLayer can be extended to create a tiled grid of HTML elements like `<canvas>`, `<img>` or `<div>`. GridLayer will handle creating and animating these DOM elements for you.
- *
- *
- * @section Synchronous usage
- * @example
- *
- * To create a custom layer, extend GridLayer and implement the `createTile()` method, which will be passed a `Point` object with the `x`, `y`, and `z` (zoom level) coordinates to draw your tile.
- *
- * ```js
- * var CanvasLayer = L.GridLayer.extend({
- * createTile: function(coords){
- * // create a <canvas> element for drawing
- * var tile = L.DomUtil.create('canvas', 'leaflet-tile');
- *
- * // setup tile width and height according to the options
- * var size = this.getTileSize();
- * tile.width = size.x;
- * tile.height = size.y;
- *
- * // get a canvas context and draw something on it using coords.x, coords.y and coords.z
- * var ctx = tile.getContext('2d');
- *
- * // return the tile so it can be rendered on screen
- * return tile;
- * }
- * });
- * ```
- *
- * @section Asynchronous usage
- * @example
- *
- * Tile creation can also be asynchronous, this is useful when using a third-party drawing library. Once the tile is finished drawing it can be passed to the `done()` callback.
- *
- * ```js
- * var CanvasLayer = L.GridLayer.extend({
- * createTile: function(coords, done){
- * var error;
- *
- * // create a <canvas> element for drawing
- * var tile = L.DomUtil.create('canvas', 'leaflet-tile');
- *
- * // setup tile width and height according to the options
- * var size = this.getTileSize();
- * tile.width = size.x;
- * tile.height = size.y;
- *
- * // draw something asynchronously and pass the tile to the done() callback
- * setTimeout(function() {
- * done(error, tile);
- * }, 1000);
- *
- * return tile;
- * }
- * });
- * ```
- *
- * @section
- */
+ var handler = function (e) {
+ return fn.call(context || obj, e || window.event);
+ };
+ var originalHandler = handler;
-L.GridLayer = L.Layer.extend({
+ if (L.Browser.pointer && type.indexOf('touch') === 0) {
+ this.addPointerListener(obj, type, handler, id);
- // @section
- // @aka GridLayer options
- options: {
- // @option tileSize: Number|Point = 256
- // Width and height of tiles in the grid. Use a number if width and height are equal, or `L.point(width, height)` otherwise.
- tileSize: 256,
+ } else if (L.Browser.touch && (type === 'dblclick') && this.addDoubleTapListener) {
+ this.addDoubleTapListener(obj, handler, id);
- // @option opacity: Number = 1.0
- // Opacity of the tiles. Can be used in the `createTile()` function.
- opacity: 1,
+ } else if ('addEventListener' in obj) {
- // @option updateWhenIdle: Boolean = depends
- // If `false`, new tiles are loaded during panning, otherwise only after it (for better performance). `true` by default on mobile browsers, otherwise `false`.
- updateWhenIdle: L.Browser.mobile,
+ if (type === 'mousewheel') {
+ obj.addEventListener('onwheel' in obj ? 'wheel' : 'mousewheel', handler, false);
- // @option updateWhenZooming: Boolean = true
- // By default, a smooth zoom animation (during a [touch zoom](#map-touchzoom) or a [`flyTo()`](#map-flyto)) will update grid layers every integer zoom level. Setting this option to `false` will update the grid layer only when the smooth animation ends.
- updateWhenZooming: true,
+ } else if ((type === 'mouseenter') || (type === 'mouseleave')) {
+ handler = function (e) {
+ e = e || window.event;
+ if (L.DomEvent._isExternalTarget(obj, e)) {
+ originalHandler(e);
+ }
+ };
+ obj.addEventListener(type === 'mouseenter' ? 'mouseover' : 'mouseout', handler, false);
- // @option updateInterval: Number = 200
- // Tiles will not update more than once every `updateInterval` milliseconds when panning.
- updateInterval: 200,
+ } else {
+ if (type === 'click' && L.Browser.android) {
+ handler = function (e) {
+ return L.DomEvent._filterClick(e, originalHandler);
+ };
+ }
+ obj.addEventListener(type, handler, false);
+ }
- // @option attribution: String = null
- // String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
- attribution: null,
+ } else if ('attachEvent' in obj) {
+ obj.attachEvent('on' + type, handler);
+ }
- // @option zIndex: Number = 1
- // The explicit zIndex of the tile layer.
- zIndex: 1,
+ obj[eventsKey] = obj[eventsKey] || {};
+ obj[eventsKey][id] = handler;
- // @option bounds: LatLngBounds = undefined
- // If set, tiles will only be loaded inside the set `LatLngBounds`.
- bounds: null,
+ return this;
+ },
- // @option minZoom: Number = 0
- // The minimum zoom level that tiles will be loaded at. By default the entire map.
- minZoom: 0,
+ _off: function (obj, type, fn, context) {
- // @option maxZoom: Number = undefined
- // The maximum zoom level that tiles will be loaded at.
- maxZoom: undefined,
+ var id = type + L.stamp(fn) + (context ? '_' + L.stamp(context) : ''),
+ handler = obj[eventsKey] && obj[eventsKey][id];
- // @option noWrap: Boolean = false
- // Whether the layer is wrapped around the antimeridian. If `true`, the
- // GridLayer will only be displayed once at low zoom levels. Has no
- // effect when the [map CRS](#map-crs) doesn't wrap around.
- noWrap: false,
+ if (!handler) { return this; }
- // @option pane: String = 'tilePane'
- // `Map pane` where the grid layer will be added.
- pane: 'tilePane',
+ if (L.Browser.pointer && type.indexOf('touch') === 0) {
+ this.removePointerListener(obj, type, id);
- // @option className: String = ''
- // A custom class name to assign to the tile layer. Empty by default.
- className: '',
+ } else if (L.Browser.touch && (type === 'dblclick') && this.removeDoubleTapListener) {
+ this.removeDoubleTapListener(obj, id);
- // @option keepBuffer: Number = 2
- // When panning the map, keep this many rows and columns of tiles before unloading them.
- keepBuffer: 2
- },
+ } else if ('removeEventListener' in obj) {
- initialize: function (options) {
- L.setOptions(this, options);
- },
+ if (type === 'mousewheel') {
+ obj.removeEventListener('onwheel' in obj ? 'wheel' : 'mousewheel', handler, false);
- onAdd: function () {
- this._initContainer();
+ } else {
+ obj.removeEventListener(
+ type === 'mouseenter' ? 'mouseover' :
+ type === 'mouseleave' ? 'mouseout' : type, handler, false);
+ }
- this._levels = {};
- this._tiles = {};
+ } else if ('detachEvent' in obj) {
+ obj.detachEvent('on' + type, handler);
+ }
- this._resetView();
- this._update();
- },
+ obj[eventsKey][id] = null;
- beforeAdd: function (map) {
- map._addZoomLimit(this);
+ return this;
},
- onRemove: function (map) {
- this._removeAllTiles();
- L.DomUtil.remove(this._container);
- map._removeZoomLimit(this);
- this._container = null;
- this._tileZoom = null;
- },
+ // @function stopPropagation(ev: DOMEvent): this
+ // Stop the given event from propagation to parent elements. Used inside the listener functions:
+ // ```js
+ // L.DomEvent.on(div, 'click', function (ev) {
+ // L.DomEvent.stopPropagation(ev);
+ // });
+ // ```
+ stopPropagation: function (e) {
- // @method bringToFront: this
- // Brings the tile layer to the top of all tile layers.
- bringToFront: function () {
- if (this._map) {
- L.DomUtil.toFront(this._container);
- this._setAutoZIndex(Math.max);
+ if (e.stopPropagation) {
+ e.stopPropagation();
+ } else if (e.originalEvent) { // In case of Leaflet event.
+ e.originalEvent._stopped = true;
+ } else {
+ e.cancelBubble = true;
}
- return this;
- },
+ L.DomEvent._skipped(e);
- // @method bringToBack: this
- // Brings the tile layer to the bottom of all tile layers.
- bringToBack: function () {
- if (this._map) {
- L.DomUtil.toBack(this._container);
- this._setAutoZIndex(Math.min);
- }
return this;
},
- // @method getAttribution: String
- // Used by the `attribution control`, returns the [attribution option](#gridlayer-attribution).
- getAttribution: function () {
- return this.options.attribution;
- },
-
- // @method getContainer: HTMLElement
- // Returns the HTML element that contains the tiles for this layer.
- getContainer: function () {
- return this._container;
+ // @function disableScrollPropagation(el: HTMLElement): this
+ // Adds `stopPropagation` to the element's `'mousewheel'` events (plus browser variants).
+ disableScrollPropagation: function (el) {
+ return L.DomEvent.on(el, 'mousewheel', L.DomEvent.stopPropagation);
},
- // @method setOpacity(opacity: Number): this
- // Changes the [opacity](#gridlayer-opacity) of the grid layer.
- setOpacity: function (opacity) {
- this.options.opacity = opacity;
- this._updateOpacity();
- return this;
- },
+ // @function disableClickPropagation(el: HTMLElement): this
+ // Adds `stopPropagation` to the element's `'click'`, `'doubleclick'`,
+ // `'mousedown'` and `'touchstart'` events (plus browser variants).
+ disableClickPropagation: function (el) {
+ var stop = L.DomEvent.stopPropagation;
- // @method setZIndex(zIndex: Number): this
- // Changes the [zIndex](#gridlayer-zindex) of the grid layer.
- setZIndex: function (zIndex) {
- this.options.zIndex = zIndex;
- this._updateZIndex();
+ L.DomEvent.on(el, L.Draggable.START.join(' '), stop);
- return this;
+ return L.DomEvent.on(el, {
+ click: L.DomEvent._fakeStop,
+ dblclick: stop
+ });
},
- // @method isLoading: Boolean
- // Returns `true` if any tile in the grid layer has not finished loading.
- isLoading: function () {
- return this._loading;
- },
+ // @function preventDefault(ev: DOMEvent): this
+ // Prevents the default action of the DOM Event `ev` from happening (such as
+ // following a link in the href of the a element, or doing a POST request
+ // with page reload when a `<form>` is submitted).
+ // Use it inside listener functions.
+ preventDefault: function (e) {
- // @method redraw: this
- // Causes the layer to clear all the tiles and request them again.
- redraw: function () {
- if (this._map) {
- this._removeAllTiles();
- this._update();
+ if (e.preventDefault) {
+ e.preventDefault();
+ } else {
+ e.returnValue = false;
}
return this;
},
- getEvents: function () {
- var events = {
- viewprereset: this._invalidateAll,
- viewreset: this._resetView,
- zoom: this._resetView,
- moveend: this._onMoveEnd
- };
-
- if (!this.options.updateWhenIdle) {
- // update tiles on move, but not more often than once per given interval
- if (!this._onMove) {
- this._onMove = L.Util.throttle(this._onMoveEnd, this.options.updateInterval, this);
- }
+ // @function stop(ev): this
+ // Does `stopPropagation` and `preventDefault` at the same time.
+ stop: function (e) {
+ return L.DomEvent
+ .preventDefault(e)
+ .stopPropagation(e);
+ },
- events.move = this._onMove;
+ // @function getMousePosition(ev: DOMEvent, container?: HTMLElement): Point
+ // Gets normalized mouse position from a DOM event relative to the
+ // `container` or to the whole page if not specified.
+ getMousePosition: function (e, container) {
+ if (!container) {
+ return new L.Point(e.clientX, e.clientY);
}
- if (this._zoomAnimated) {
- events.zoomanim = this._animateZoom;
- }
+ var rect = container.getBoundingClientRect();
- return events;
+ return new L.Point(
+ e.clientX - rect.left - container.clientLeft,
+ e.clientY - rect.top - container.clientTop);
},
- // @section Extension methods
- // Layers extending `GridLayer` shall reimplement the following method.
- // @method createTile(coords: Object, done?: Function): HTMLElement
- // Called only internally, must be overriden by classes extending `GridLayer`.
- // Returns the `HTMLElement` corresponding to the given `coords`. If the `done` callback
- // is specified, it must be called when the tile has finished loading and drawing.
- createTile: function () {
- return document.createElement('div');
- },
+ // Chrome on Win scrolls double the pixels as in other platforms (see #4538),
+ // and Firefox scrolls device pixels, not CSS pixels
+ _wheelPxFactor: (L.Browser.win && L.Browser.chrome) ? 2 :
+ L.Browser.gecko ? window.devicePixelRatio :
+ 1,
- // @section
- // @method getTileSize: Point
- // Normalizes the [tileSize option](#gridlayer-tilesize) into a point. Used by the `createTile()` method.
- getTileSize: function () {
- var s = this.options.tileSize;
- return s instanceof L.Point ? s : new L.Point(s, s);
+ // @function getWheelDelta(ev: DOMEvent): Number
+ // Gets normalized wheel delta from a mousewheel DOM event, in vertical
+ // pixels scrolled (negative if scrolling down).
+ // Events from pointing devices without precise scrolling are mapped to
+ // a best guess of 60 pixels.
+ getWheelDelta: function (e) {
+ return (L.Browser.edge) ? e.wheelDeltaY / 2 : // Don't trust window-geometry-based delta
+ (e.deltaY && e.deltaMode === 0) ? -e.deltaY / L.DomEvent._wheelPxFactor : // Pixels
+ (e.deltaY && e.deltaMode === 1) ? -e.deltaY * 20 : // Lines
+ (e.deltaY && e.deltaMode === 2) ? -e.deltaY * 60 : // Pages
+ (e.deltaX || e.deltaZ) ? 0 : // Skip horizontal/depth wheel events
+ e.wheelDelta ? (e.wheelDeltaY || e.wheelDelta) / 2 : // Legacy IE pixels
+ (e.detail && Math.abs(e.detail) < 32765) ? -e.detail * 20 : // Legacy Moz lines
+ e.detail ? e.detail / -32765 * 60 : // Legacy Moz pages
+ 0;
},
- _updateZIndex: function () {
- if (this._container && this.options.zIndex !== undefined && this.options.zIndex !== null) {
- this._container.style.zIndex = this.options.zIndex;
- }
+ _skipEvents: {},
+
+ _fakeStop: function (e) {
+ // fakes stopPropagation by setting a special event flag, checked/reset with L.DomEvent._skipped(e)
+ L.DomEvent._skipEvents[e.type] = true;
},
- _setAutoZIndex: function (compare) {
- // go through all other layers of the same pane, set zIndex to max + 1 (front) or min - 1 (back)
+ _skipped: function (e) {
+ var skipped = this._skipEvents[e.type];
+ // reset when checking, as it's only used in map container and propagates outside of the map
+ this._skipEvents[e.type] = false;
+ return skipped;
+ },
- var layers = this.getPane().children,
- edgeZIndex = -compare(-Infinity, Infinity); // -Infinity for max, Infinity for min
+ // check if element really left/entered the event target (for mouseenter/mouseleave)
+ _isExternalTarget: function (el, e) {
- for (var i = 0, len = layers.length, zIndex; i < len; i++) {
+ var related = e.relatedTarget;
- zIndex = layers[i].style.zIndex;
+ if (!related) { return true; }
- if (layers[i] !== this._container && zIndex) {
- edgeZIndex = compare(edgeZIndex, +zIndex);
+ try {
+ while (related && (related !== el)) {
+ related = related.parentNode;
}
+ } catch (err) {
+ return false;
}
-
- if (isFinite(edgeZIndex)) {
- this.options.zIndex = edgeZIndex + compare(-1, 1);
- this._updateZIndex();
- }
+ return (related !== el);
},
- _updateOpacity: function () {
- if (!this._map) { return; }
-
- // IE doesn't inherit filter opacity properly, so we're forced to set it on tiles
- if (L.Browser.ielt9) { return; }
-
- L.DomUtil.setOpacity(this._container, this.options.opacity);
-
- var now = +new Date(),
- nextFrame = false,
- willPrune = false;
-
- for (var key in this._tiles) {
- var tile = this._tiles[key];
- if (!tile.current || !tile.loaded) { continue; }
+ // this is a horrible workaround for a bug in Android where a single touch triggers two click events
+ _filterClick: function (e, handler) {
+ var timeStamp = (e.timeStamp || (e.originalEvent && e.originalEvent.timeStamp)),
+ elapsed = L.DomEvent._lastClick && (timeStamp - L.DomEvent._lastClick);
- var fade = Math.min(1, (now - tile.loaded) / 200);
+ // are they closer together than 500ms yet more than 100ms?
+ // Android typically triggers them ~300ms apart while multiple listeners
+ // on the same event should be triggered far faster;
+ // or check if click is simulated on the element, and if it is, reject any non-simulated events
- L.DomUtil.setOpacity(tile.el, fade);
- if (fade < 1) {
- nextFrame = true;
- } else {
- if (tile.active) { willPrune = true; }
- tile.active = true;
- }
+ if ((elapsed && elapsed > 100 && elapsed < 500) || (e.target._simulatedClick && !e._simulated)) {
+ L.DomEvent.stop(e);
+ return;
}
+ L.DomEvent._lastClick = timeStamp;
- if (willPrune && !this._noPrune) { this._pruneTiles(); }
+ handler(e);
+ }
+};
- if (nextFrame) {
- L.Util.cancelAnimFrame(this._fadeFrame);
- this._fadeFrame = L.Util.requestAnimFrame(this._updateOpacity, this);
- }
- },
+// @function addListener(…): this
+// Alias to [`L.DomEvent.on`](#domevent-on)
+L.DomEvent.addListener = L.DomEvent.on;
- _initContainer: function () {
- if (this._container) { return; }
+// @function removeListener(…): this
+// Alias to [`L.DomEvent.off`](#domevent-off)
+L.DomEvent.removeListener = L.DomEvent.off;
- this._container = L.DomUtil.create('div', 'leaflet-layer ' + (this.options.className || ''));
- this._updateZIndex();
- if (this.options.opacity < 1) {
- this._updateOpacity();
- }
- this.getPane().appendChild(this._container);
- },
-
- _updateLevels: function () {
-
- var zoom = this._tileZoom,
- maxZoom = this.options.maxZoom;
-
- if (zoom === undefined) { return undefined; }
-
- for (var z in this._levels) {
- if (this._levels[z].el.children.length || z === zoom) {
- this._levels[z].el.style.zIndex = maxZoom - Math.abs(zoom - z);
- } else {
- L.DomUtil.remove(this._levels[z].el);
- this._removeTilesAtZoom(z);
- delete this._levels[z];
- }
- }
+/*
+ * @class PosAnimation
+ * @aka L.PosAnimation
+ * @inherits Evented
+ * Used internally for panning animations, utilizing CSS3 Transitions for modern browsers and a timer fallback for IE6-9.
+ *
+ * @example
+ * ```js
+ * var fx = new L.PosAnimation();
+ * fx.run(el, [300, 500], 0.5);
+ * ```
+ *
+ * @constructor L.PosAnimation()
+ * Creates a `PosAnimation` object.
+ *
+ */
- var level = this._levels[zoom],
- map = this._map;
+L.PosAnimation = L.Evented.extend({
- if (!level) {
- level = this._levels[zoom] = {};
+ // @method run(el: HTMLElement, newPos: Point, duration?: Number, easeLinearity?: Number)
+ // Run an animation of a given element to a new position, optionally setting
+ // duration in seconds (`0.25` by default) and easing linearity factor (3rd
+ // argument of the [cubic bezier curve](http://cubic-bezier.com/#0,0,.5,1),
+ // `0.5` by default).
+ run: function (el, newPos, duration, easeLinearity) {
+ this.stop();
- level.el = L.DomUtil.create('div', 'leaflet-tile-container leaflet-zoom-animated', this._container);
- level.el.style.zIndex = maxZoom;
+ this._el = el;
+ this._inProgress = true;
+ this._duration = duration || 0.25;
+ this._easeOutPower = 1 / Math.max(easeLinearity || 0.5, 0.2);
- level.origin = map.project(map.unproject(map.getPixelOrigin()), zoom).round();
- level.zoom = zoom;
+ this._startPos = L.DomUtil.getPosition(el);
+ this._offset = newPos.subtract(this._startPos);
+ this._startTime = +new Date();
- this._setZoomTransform(level, map.getCenter(), map.getZoom());
+ // @event start: Event
+ // Fired when the animation starts
+ this.fire('start');
- // force the browser to consider the newly added element for transition
- L.Util.falseFn(level.el.offsetWidth);
- }
+ this._animate();
+ },
- this._level = level;
+ // @method stop()
+ // Stops the animation (if currently running).
+ stop: function () {
+ if (!this._inProgress) { return; }
- return level;
+ this._step(true);
+ this._complete();
},
- _pruneTiles: function () {
- if (!this._map) {
- return;
- }
-
- var key, tile;
+ _animate: function () {
+ // animation loop
+ this._animId = L.Util.requestAnimFrame(this._animate, this);
+ this._step();
+ },
- var zoom = this._map.getZoom();
- if (zoom > this.options.maxZoom ||
- zoom < this.options.minZoom) {
- this._removeAllTiles();
- return;
- }
+ _step: function (round) {
+ var elapsed = (+new Date()) - this._startTime,
+ duration = this._duration * 1000;
- for (key in this._tiles) {
- tile = this._tiles[key];
- tile.retain = tile.current;
+ if (elapsed < duration) {
+ this._runFrame(this._easeOut(elapsed / duration), round);
+ } else {
+ this._runFrame(1);
+ this._complete();
}
+ },
- for (key in this._tiles) {
- tile = this._tiles[key];
- if (tile.current && !tile.active) {
- var coords = tile.coords;
- if (!this._retainParent(coords.x, coords.y, coords.z, coords.z - 5)) {
- this._retainChildren(coords.x, coords.y, coords.z, coords.z + 2);
- }
- }
+ _runFrame: function (progress, round) {
+ var pos = this._startPos.add(this._offset.multiplyBy(progress));
+ if (round) {
+ pos._round();
}
+ L.DomUtil.setPosition(this._el, pos);
- for (key in this._tiles) {
- if (!this._tiles[key].retain) {
- this._removeTile(key);
- }
- }
+ // @event step: Event
+ // Fired continuously during the animation.
+ this.fire('step');
},
- _removeTilesAtZoom: function (zoom) {
- for (var key in this._tiles) {
- if (this._tiles[key].coords.z !== zoom) {
- continue;
- }
- this._removeTile(key);
- }
- },
+ _complete: function () {
+ L.Util.cancelAnimFrame(this._animId);
- _removeAllTiles: function () {
- for (var key in this._tiles) {
- this._removeTile(key);
- }
+ this._inProgress = false;
+ // @event end: Event
+ // Fired when the animation ends.
+ this.fire('end');
},
- _invalidateAll: function () {
- for (var z in this._levels) {
- L.DomUtil.remove(this._levels[z].el);
- delete this._levels[z];
- }
- this._removeAllTiles();
+ _easeOut: function (t) {
+ return 1 - Math.pow(1 - t, this._easeOutPower);
+ }
+});
- this._tileZoom = null;
- },
- _retainParent: function (x, y, z, minZoom) {
- var x2 = Math.floor(x / 2),
- y2 = Math.floor(y / 2),
- z2 = z - 1,
- coords2 = new L.Point(+x2, +y2);
- coords2.z = +z2;
- var key = this._tileCoordsToKey(coords2),
- tile = this._tiles[key];
+/*
+ * @namespace Projection
+ * @projection L.Projection.Mercator
+ *
+ * Elliptical Mercator projection — more complex than Spherical Mercator. Takes into account that Earth is a geoid, not a perfect sphere. Used by the EPSG:3395 CRS.
+ */
- if (tile && tile.active) {
- tile.retain = true;
- return true;
+L.Projection.Mercator = {
+ R: 6378137,
+ R_MINOR: 6356752.314245179,
- } else if (tile && tile.loaded) {
- tile.retain = true;
- }
+ bounds: L.bounds([-20037508.34279, -15496570.73972], [20037508.34279, 18764656.23138]),
- if (z2 > minZoom) {
- return this._retainParent(x2, y2, z2, minZoom);
- }
+ project: function (latlng) {
+ var d = Math.PI / 180,
+ r = this.R,
+ y = latlng.lat * d,
+ tmp = this.R_MINOR / r,
+ e = Math.sqrt(1 - tmp * tmp),
+ con = e * Math.sin(y);
- return false;
+ var ts = Math.tan(Math.PI / 4 - y / 2) / Math.pow((1 - con) / (1 + con), e / 2);
+ y = -r * Math.log(Math.max(ts, 1E-10));
+
+ return new L.Point(latlng.lng * d * r, y);
},
- _retainChildren: function (x, y, z, maxZoom) {
+ unproject: function (point) {
+ var d = 180 / Math.PI,
+ r = this.R,
+ tmp = this.R_MINOR / r,
+ e = Math.sqrt(1 - tmp * tmp),
+ ts = Math.exp(-point.y / r),
+ phi = Math.PI / 2 - 2 * Math.atan(ts);
- for (var i = 2 * x; i < 2 * x + 2; i++) {
- for (var j = 2 * y; j < 2 * y + 2; j++) {
+ for (var i = 0, dphi = 0.1, con; i < 15 && Math.abs(dphi) > 1e-7; i++) {
+ con = e * Math.sin(phi);
+ con = Math.pow((1 - con) / (1 + con), e / 2);
+ dphi = Math.PI / 2 - 2 * Math.atan(ts * con) - phi;
+ phi += dphi;
+ }
- var coords = new L.Point(i, j);
- coords.z = z + 1;
+ return new L.LatLng(phi * d, point.x * d / r);
+ }
+};
- var key = this._tileCoordsToKey(coords),
- tile = this._tiles[key];
- if (tile && tile.active) {
- tile.retain = true;
- continue;
- } else if (tile && tile.loaded) {
- tile.retain = true;
- }
+/*
+ * @namespace CRS
+ * @crs L.CRS.EPSG3395
+ *
+ * Rarely used by some commercial tile providers. Uses Elliptical Mercator projection.
+ */
- if (z + 1 < maxZoom) {
- this._retainChildren(i, j, z + 1, maxZoom);
- }
- }
- }
- },
+L.CRS.EPSG3395 = L.extend({}, L.CRS.Earth, {
+ code: 'EPSG:3395',
+ projection: L.Projection.Mercator,
- _resetView: function (e) {
- var animating = e && (e.pinch || e.flyTo);
- this._setView(this._map.getCenter(), this._map.getZoom(), animating, animating);
- },
+ transformation: (function () {
+ var scale = 0.5 / (Math.PI * L.Projection.Mercator.R);
+ return new L.Transformation(scale, 0.5, -scale, 0.5);
+ }())
+});
- _animateZoom: function (e) {
- this._setView(e.center, e.zoom, true, e.noUpdate);
- },
- _setView: function (center, zoom, noPrune, noUpdate) {
- var tileZoom = Math.round(zoom);
- if ((this.options.maxZoom !== undefined && tileZoom > this.options.maxZoom) ||
- (this.options.minZoom !== undefined && tileZoom < this.options.minZoom)) {
- tileZoom = undefined;
- }
- var tileZoomChanged = this.options.updateWhenZooming && (tileZoom !== this._tileZoom);
+/*
+ * @class GridLayer
+ * @inherits Layer
+ * @aka L.GridLayer
+ *
+ * Generic class for handling a tiled grid of HTML elements. This is the base class for all tile layers and replaces `TileLayer.Canvas`.
+ * GridLayer can be extended to create a tiled grid of HTML elements like `<canvas>`, `<img>` or `<div>`. GridLayer will handle creating and animating these DOM elements for you.
+ *
+ *
+ * @section Synchronous usage
+ * @example
+ *
+ * To create a custom layer, extend GridLayer and implement the `createTile()` method, which will be passed a `Point` object with the `x`, `y`, and `z` (zoom level) coordinates to draw your tile.
+ *
+ * ```js
+ * var CanvasLayer = L.GridLayer.extend({
+ * createTile: function(coords){
+ * // create a <canvas> element for drawing
+ * var tile = L.DomUtil.create('canvas', 'leaflet-tile');
+ *
+ * // setup tile width and height according to the options
+ * var size = this.getTileSize();
+ * tile.width = size.x;
+ * tile.height = size.y;
+ *
+ * // get a canvas context and draw something on it using coords.x, coords.y and coords.z
+ * var ctx = tile.getContext('2d');
+ *
+ * // return the tile so it can be rendered on screen
+ * return tile;
+ * }
+ * });
+ * ```
+ *
+ * @section Asynchronous usage
+ * @example
+ *
+ * Tile creation can also be asynchronous, this is useful when using a third-party drawing library. Once the tile is finished drawing it can be passed to the `done()` callback.
+ *
+ * ```js
+ * var CanvasLayer = L.GridLayer.extend({
+ * createTile: function(coords, done){
+ * var error;
+ *
+ * // create a <canvas> element for drawing
+ * var tile = L.DomUtil.create('canvas', 'leaflet-tile');
+ *
+ * // setup tile width and height according to the options
+ * var size = this.getTileSize();
+ * tile.width = size.x;
+ * tile.height = size.y;
+ *
+ * // draw something asynchronously and pass the tile to the done() callback
+ * setTimeout(function() {
+ * done(error, tile);
+ * }, 1000);
+ *
+ * return tile;
+ * }
+ * });
+ * ```
+ *
+ * @section
+ */
- if (!noUpdate || tileZoomChanged) {
- this._tileZoom = tileZoom;
+L.GridLayer = L.Layer.extend({
- if (this._abortLoading) {
- this._abortLoading();
- }
+ // @section
+ // @aka GridLayer options
+ options: {
+ // @option tileSize: Number|Point = 256
+ // Width and height of tiles in the grid. Use a number if width and height are equal, or `L.point(width, height)` otherwise.
+ tileSize: 256,
- this._updateLevels();
- this._resetGrid();
+ // @option opacity: Number = 1.0
+ // Opacity of the tiles. Can be used in the `createTile()` function.
+ opacity: 1,
- if (tileZoom !== undefined) {
- this._update(center);
- }
+ // @option updateWhenIdle: Boolean = depends
+ // If `false`, new tiles are loaded during panning, otherwise only after it (for better performance). `true` by default on mobile browsers, otherwise `false`.
+ updateWhenIdle: L.Browser.mobile,
- if (!noPrune) {
- this._pruneTiles();
- }
+ // @option updateWhenZooming: Boolean = true
+ // By default, a smooth zoom animation (during a [touch zoom](#map-touchzoom) or a [`flyTo()`](#map-flyto)) will update grid layers every integer zoom level. Setting this option to `false` will update the grid layer only when the smooth animation ends.
+ updateWhenZooming: true,
- // Flag to prevent _updateOpacity from pruning tiles during
- // a zoom anim or a pinch gesture
- this._noPrune = !!noPrune;
- }
+ // @option updateInterval: Number = 200
+ // Tiles will not update more than once every `updateInterval` milliseconds when panning.
+ updateInterval: 200,
- this._setZoomTransforms(center, zoom);
- },
+ // @option zIndex: Number = 1
+ // The explicit zIndex of the tile layer.
+ zIndex: 1,
- _setZoomTransforms: function (center, zoom) {
- for (var i in this._levels) {
- this._setZoomTransform(this._levels[i], center, zoom);
- }
- },
+ // @option bounds: LatLngBounds = undefined
+ // If set, tiles will only be loaded inside the set `LatLngBounds`.
+ bounds: null,
- _setZoomTransform: function (level, center, zoom) {
- var scale = this._map.getZoomScale(zoom, level.zoom),
- translate = level.origin.multiplyBy(scale)
- .subtract(this._map._getNewPixelOrigin(center, zoom)).round();
+ // @option minZoom: Number = 0
+ // The minimum zoom level that tiles will be loaded at. By default the entire map.
+ minZoom: 0,
- if (L.Browser.any3d) {
- L.DomUtil.setTransform(level.el, translate, scale);
- } else {
- L.DomUtil.setPosition(level.el, translate);
- }
- },
+ // @option maxZoom: Number = undefined
+ // The maximum zoom level that tiles will be loaded at.
+ maxZoom: undefined,
- _resetGrid: function () {
- var map = this._map,
- crs = map.options.crs,
- tileSize = this._tileSize = this.getTileSize(),
- tileZoom = this._tileZoom;
+ // @option noWrap: Boolean = false
+ // Whether the layer is wrapped around the antimeridian. If `true`, the
+ // GridLayer will only be displayed once at low zoom levels. Has no
+ // effect when the [map CRS](#map-crs) doesn't wrap around.
+ noWrap: false,
- var bounds = this._map.getPixelWorldBounds(this._tileZoom);
- if (bounds) {
- this._globalTileRange = this._pxBoundsToTileRange(bounds);
- }
+ // @option pane: String = 'tilePane'
+ // `Map pane` where the grid layer will be added.
+ pane: 'tilePane',
- this._wrapX = crs.wrapLng && !this.options.noWrap && [
- Math.floor(map.project([0, crs.wrapLng[0]], tileZoom).x / tileSize.x),
- Math.ceil(map.project([0, crs.wrapLng[1]], tileZoom).x / tileSize.y)
- ];
- this._wrapY = crs.wrapLat && !this.options.noWrap && [
- Math.floor(map.project([crs.wrapLat[0], 0], tileZoom).y / tileSize.x),
- Math.ceil(map.project([crs.wrapLat[1], 0], tileZoom).y / tileSize.y)
- ];
- },
+ // @option className: String = ''
+ // A custom class name to assign to the tile layer. Empty by default.
+ className: '',
- _onMoveEnd: function () {
- if (!this._map || this._map._animatingZoom) { return; }
+ // @option keepBuffer: Number = 2
+ // When panning the map, keep this many rows and columns of tiles before unloading them.
+ keepBuffer: 2
+ },
- this._update();
+ initialize: function (options) {
+ L.setOptions(this, options);
},
- _getTiledPixelBounds: function (center) {
- var map = this._map,
- mapZoom = map._animatingZoom ? Math.max(map._animateToZoom, map.getZoom()) : map.getZoom(),
- scale = map.getZoomScale(mapZoom, this._tileZoom),
- pixelCenter = map.project(center, this._tileZoom).floor(),
- halfSize = map.getSize().divideBy(scale * 2);
+ onAdd: function () {
+ this._initContainer();
- return new L.Bounds(pixelCenter.subtract(halfSize), pixelCenter.add(halfSize));
+ this._levels = {};
+ this._tiles = {};
+
+ this._resetView();
+ this._update();
},
- // Private method to load tiles in the grid's active zoom level according to map bounds
- _update: function (center) {
- var map = this._map;
- if (!map) { return; }
- var zoom = map.getZoom();
+ beforeAdd: function (map) {
+ map._addZoomLimit(this);
+ },
- if (center === undefined) { center = map.getCenter(); }
- if (this._tileZoom === undefined) { return; } // if out of minzoom/maxzoom
+ onRemove: function (map) {
+ this._removeAllTiles();
+ L.DomUtil.remove(this._container);
+ map._removeZoomLimit(this);
+ this._container = null;
+ this._tileZoom = null;
+ },
- var pixelBounds = this._getTiledPixelBounds(center),
- tileRange = this._pxBoundsToTileRange(pixelBounds),
- tileCenter = tileRange.getCenter(),
- queue = [],
- margin = this.options.keepBuffer,
- noPruneRange = new L.Bounds(tileRange.getBottomLeft().subtract([margin, -margin]),
- tileRange.getTopRight().add([margin, -margin]));
+ // @method bringToFront: this
+ // Brings the tile layer to the top of all tile layers.
+ bringToFront: function () {
+ if (this._map) {
+ L.DomUtil.toFront(this._container);
+ this._setAutoZIndex(Math.max);
+ }
+ return this;
+ },
- for (var key in this._tiles) {
- var c = this._tiles[key].coords;
- if (c.z !== this._tileZoom || !noPruneRange.contains(L.point(c.x, c.y))) {
- this._tiles[key].current = false;
- }
+ // @method bringToBack: this
+ // Brings the tile layer to the bottom of all tile layers.
+ bringToBack: function () {
+ if (this._map) {
+ L.DomUtil.toBack(this._container);
+ this._setAutoZIndex(Math.min);
}
+ return this;
+ },
- // _update just loads more tiles. If the tile zoom level differs too much
- // from the map's, let _setView reset levels and prune old tiles.
- if (Math.abs(zoom - this._tileZoom) > 1) { this._setView(center, zoom); return; }
+ // @method getContainer: HTMLElement
+ // Returns the HTML element that contains the tiles for this layer.
+ getContainer: function () {
+ return this._container;
+ },
- // create a queue of coordinates to load tiles from
- for (var j = tileRange.min.y; j <= tileRange.max.y; j++) {
- for (var i = tileRange.min.x; i <= tileRange.max.x; i++) {
- var coords = new L.Point(i, j);
- coords.z = this._tileZoom;
+ // @method setOpacity(opacity: Number): this
+ // Changes the [opacity](#gridlayer-opacity) of the grid layer.
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
+ this._updateOpacity();
+ return this;
+ },
- if (!this._isValidTile(coords)) { continue; }
+ // @method setZIndex(zIndex: Number): this
+ // Changes the [zIndex](#gridlayer-zindex) of the grid layer.
+ setZIndex: function (zIndex) {
+ this.options.zIndex = zIndex;
+ this._updateZIndex();
- var tile = this._tiles[this._tileCoordsToKey(coords)];
- if (tile) {
- tile.current = true;
- } else {
- queue.push(coords);
- }
- }
- }
+ return this;
+ },
- // sort tile queue to load tiles in order of their distance to center
- queue.sort(function (a, b) {
- return a.distanceTo(tileCenter) - b.distanceTo(tileCenter);
- });
+ // @method isLoading: Boolean
+ // Returns `true` if any tile in the grid layer has not finished loading.
+ isLoading: function () {
+ return this._loading;
+ },
- if (queue.length !== 0) {
- // if it's the first batch of tiles to load
- if (!this._loading) {
- this._loading = true;
- // @event loading: Event
- // Fired when the grid layer starts loading tiles.
- this.fire('loading');
- }
+ // @method redraw: this
+ // Causes the layer to clear all the tiles and request them again.
+ redraw: function () {
+ if (this._map) {
+ this._removeAllTiles();
+ this._update();
+ }
+ return this;
+ },
- // create DOM fragment to append tiles in one batch
- var fragment = document.createDocumentFragment();
+ getEvents: function () {
+ var events = {
+ viewprereset: this._invalidateAll,
+ viewreset: this._resetView,
+ zoom: this._resetView,
+ moveend: this._onMoveEnd
+ };
- for (i = 0; i < queue.length; i++) {
- this._addTile(queue[i], fragment);
+ if (!this.options.updateWhenIdle) {
+ // update tiles on move, but not more often than once per given interval
+ if (!this._onMove) {
+ this._onMove = L.Util.throttle(this._onMoveEnd, this.options.updateInterval, this);
}
- this._level.el.appendChild(fragment);
+ events.move = this._onMove;
}
- },
-
- _isValidTile: function (coords) {
- var crs = this._map.options.crs;
- if (!crs.infinite) {
- // don't load tile if it's out of bounds and not wrapped
- var bounds = this._globalTileRange;
- if ((!crs.wrapLng && (coords.x < bounds.min.x || coords.x > bounds.max.x)) ||
- (!crs.wrapLat && (coords.y < bounds.min.y || coords.y > bounds.max.y))) { return false; }
+ if (this._zoomAnimated) {
+ events.zoomanim = this._animateZoom;
}
- if (!this.options.bounds) { return true; }
+ return events;
+ },
- // don't load tile if it doesn't intersect the bounds in options
- var tileBounds = this._tileCoordsToBounds(coords);
- return L.latLngBounds(this.options.bounds).overlaps(tileBounds);
+ // @section Extension methods
+ // Layers extending `GridLayer` shall reimplement the following method.
+ // @method createTile(coords: Object, done?: Function): HTMLElement
+ // Called only internally, must be overriden by classes extending `GridLayer`.
+ // Returns the `HTMLElement` corresponding to the given `coords`. If the `done` callback
+ // is specified, it must be called when the tile has finished loading and drawing.
+ createTile: function () {
+ return document.createElement('div');
},
- _keyToBounds: function (key) {
- return this._tileCoordsToBounds(this._keyToTileCoords(key));
+ // @section
+ // @method getTileSize: Point
+ // Normalizes the [tileSize option](#gridlayer-tilesize) into a point. Used by the `createTile()` method.
+ getTileSize: function () {
+ var s = this.options.tileSize;
+ return s instanceof L.Point ? s : new L.Point(s, s);
},
- // converts tile coordinates to its geographical bounds
- _tileCoordsToBounds: function (coords) {
+ _updateZIndex: function () {
+ if (this._container && this.options.zIndex !== undefined && this.options.zIndex !== null) {
+ this._container.style.zIndex = this.options.zIndex;
+ }
+ },
- var map = this._map,
- tileSize = this.getTileSize(),
+ _setAutoZIndex: function (compare) {
+ // go through all other layers of the same pane, set zIndex to max + 1 (front) or min - 1 (back)
- nwPoint = coords.scaleBy(tileSize),
- sePoint = nwPoint.add(tileSize),
+ var layers = this.getPane().children,
+ edgeZIndex = -compare(-Infinity, Infinity); // -Infinity for max, Infinity for min
- nw = map.unproject(nwPoint, coords.z),
- se = map.unproject(sePoint, coords.z);
+ for (var i = 0, len = layers.length, zIndex; i < len; i++) {
- if (!this.options.noWrap) {
- nw = map.wrapLatLng(nw);
- se = map.wrapLatLng(se);
- }
+ zIndex = layers[i].style.zIndex;
- return new L.LatLngBounds(nw, se);
- },
+ if (layers[i] !== this._container && zIndex) {
+ edgeZIndex = compare(edgeZIndex, +zIndex);
+ }
+ }
- // converts tile coordinates to key for the tile cache
- _tileCoordsToKey: function (coords) {
- return coords.x + ':' + coords.y + ':' + coords.z;
+ if (isFinite(edgeZIndex)) {
+ this.options.zIndex = edgeZIndex + compare(-1, 1);
+ this._updateZIndex();
+ }
},
- // converts tile cache key to coordinates
- _keyToTileCoords: function (key) {
- var k = key.split(':'),
- coords = new L.Point(+k[0], +k[1]);
- coords.z = +k[2];
- return coords;
- },
+ _updateOpacity: function () {
+ if (!this._map) { return; }
- _removeTile: function (key) {
- var tile = this._tiles[key];
- if (!tile) { return; }
+ // IE doesn't inherit filter opacity properly, so we're forced to set it on tiles
+ if (L.Browser.ielt9) { return; }
- L.DomUtil.remove(tile.el);
+ L.DomUtil.setOpacity(this._container, this.options.opacity);
- delete this._tiles[key];
+ var now = +new Date(),
+ nextFrame = false,
+ willPrune = false;
- // @event tileunload: TileEvent
- // Fired when a tile is removed (e.g. when a tile goes off the screen).
- this.fire('tileunload', {
- tile: tile.el,
- coords: this._keyToTileCoords(key)
- });
- },
+ for (var key in this._tiles) {
+ var tile = this._tiles[key];
+ if (!tile.current || !tile.loaded) { continue; }
- _initTile: function (tile) {
- L.DomUtil.addClass(tile, 'leaflet-tile');
+ var fade = Math.min(1, (now - tile.loaded) / 200);
- var tileSize = this.getTileSize();
- tile.style.width = tileSize.x + 'px';
- tile.style.height = tileSize.y + 'px';
+ L.DomUtil.setOpacity(tile.el, fade);
+ if (fade < 1) {
+ nextFrame = true;
+ } else {
+ if (tile.active) { willPrune = true; }
+ tile.active = true;
+ }
+ }
- tile.onselectstart = L.Util.falseFn;
- tile.onmousemove = L.Util.falseFn;
+ if (willPrune && !this._noPrune) { this._pruneTiles(); }
- // update opacity on tiles in IE7-8 because of filter inheritance problems
- if (L.Browser.ielt9 && this.options.opacity < 1) {
- L.DomUtil.setOpacity(tile, this.options.opacity);
+ if (nextFrame) {
+ L.Util.cancelAnimFrame(this._fadeFrame);
+ this._fadeFrame = L.Util.requestAnimFrame(this._updateOpacity, this);
}
+ },
- // without this hack, tiles disappear after zoom on Chrome for Android
- // https://github.com/Leaflet/Leaflet/issues/2078
- if (L.Browser.android && !L.Browser.android23) {
- tile.style.WebkitBackfaceVisibility = 'hidden';
+ _initContainer: function () {
+ if (this._container) { return; }
+
+ this._container = L.DomUtil.create('div', 'leaflet-layer ' + (this.options.className || ''));
+ this._updateZIndex();
+
+ if (this.options.opacity < 1) {
+ this._updateOpacity();
}
+
+ this.getPane().appendChild(this._container);
},
- _addTile: function (coords, container) {
- var tilePos = this._getTilePos(coords),
- key = this._tileCoordsToKey(coords);
+ _updateLevels: function () {
- var tile = this.createTile(this._wrapCoords(coords), L.bind(this._tileReady, this, coords));
+ var zoom = this._tileZoom,
+ maxZoom = this.options.maxZoom;
- this._initTile(tile);
+ if (zoom === undefined) { return undefined; }
- // if createTile is defined with a second argument ("done" callback),
- // we know that tile is async and will be ready later; otherwise
- if (this.createTile.length < 2) {
- // mark tile as ready, but delay one frame for opacity animation to happen
- L.Util.requestAnimFrame(L.bind(this._tileReady, this, coords, null, tile));
+ for (var z in this._levels) {
+ if (this._levels[z].el.children.length || z === zoom) {
+ this._levels[z].el.style.zIndex = maxZoom - Math.abs(zoom - z);
+ } else {
+ L.DomUtil.remove(this._levels[z].el);
+ this._removeTilesAtZoom(z);
+ delete this._levels[z];
+ }
}
- L.DomUtil.setPosition(tile, tilePos);
+ var level = this._levels[zoom],
+ map = this._map;
- // save tile in cache
- this._tiles[key] = {
- el: tile,
- coords: coords,
- current: true
- };
+ if (!level) {
+ level = this._levels[zoom] = {};
- container.appendChild(tile);
- // @event tileloadstart: TileEvent
- // Fired when a tile is requested and starts loading.
- this.fire('tileloadstart', {
- tile: tile,
- coords: coords
- });
- },
+ level.el = L.DomUtil.create('div', 'leaflet-tile-container leaflet-zoom-animated', this._container);
+ level.el.style.zIndex = maxZoom;
- _tileReady: function (coords, err, tile) {
- if (!this._map) { return; }
+ level.origin = map.project(map.unproject(map.getPixelOrigin()), zoom).round();
+ level.zoom = zoom;
- if (err) {
- // @event tileerror: TileErrorEvent
- // Fired when there is an error loading a tile.
- this.fire('tileerror', {
- error: err,
- tile: tile,
- coords: coords
- });
+ this._setZoomTransform(level, map.getCenter(), map.getZoom());
+
+ // force the browser to consider the newly added element for transition
+ L.Util.falseFn(level.el.offsetWidth);
}
- var key = this._tileCoordsToKey(coords);
+ this._level = level;
- tile = this._tiles[key];
- if (!tile) { return; }
+ return level;
+ },
- tile.loaded = +new Date();
- if (this._map._fadeAnimated) {
- L.DomUtil.setOpacity(tile.el, 0);
- L.Util.cancelAnimFrame(this._fadeFrame);
- this._fadeFrame = L.Util.requestAnimFrame(this._updateOpacity, this);
- } else {
- tile.active = true;
- this._pruneTiles();
+ _pruneTiles: function () {
+ if (!this._map) {
+ return;
}
- if (!err) {
- L.DomUtil.addClass(tile.el, 'leaflet-tile-loaded');
+ var key, tile;
- // @event tileload: TileEvent
- // Fired when a tile loads.
- this.fire('tileload', {
- tile: tile.el,
- coords: coords
- });
+ var zoom = this._map.getZoom();
+ if (zoom > this.options.maxZoom ||
+ zoom < this.options.minZoom) {
+ this._removeAllTiles();
+ return;
}
- if (this._noTilesToLoad()) {
- this._loading = false;
- // @event load: Event
- // Fired when the grid layer loaded all visible tiles.
- this.fire('load');
+ for (key in this._tiles) {
+ tile = this._tiles[key];
+ tile.retain = tile.current;
+ }
- if (L.Browser.ielt9 || !this._map._fadeAnimated) {
- L.Util.requestAnimFrame(this._pruneTiles, this);
- } else {
- // Wait a bit more than 0.2 secs (the duration of the tile fade-in)
- // to trigger a pruning.
- setTimeout(L.bind(this._pruneTiles, this), 250);
+ for (key in this._tiles) {
+ tile = this._tiles[key];
+ if (tile.current && !tile.active) {
+ var coords = tile.coords;
+ if (!this._retainParent(coords.x, coords.y, coords.z, coords.z - 5)) {
+ this._retainChildren(coords.x, coords.y, coords.z, coords.z + 2);
+ }
}
}
- },
- _getTilePos: function (coords) {
- return coords.scaleBy(this.getTileSize()).subtract(this._level.origin);
+ for (key in this._tiles) {
+ if (!this._tiles[key].retain) {
+ this._removeTile(key);
+ }
+ }
},
- _wrapCoords: function (coords) {
- var newCoords = new L.Point(
- this._wrapX ? L.Util.wrapNum(coords.x, this._wrapX) : coords.x,
- this._wrapY ? L.Util.wrapNum(coords.y, this._wrapY) : coords.y);
- newCoords.z = coords.z;
- return newCoords;
+ _removeTilesAtZoom: function (zoom) {
+ for (var key in this._tiles) {
+ if (this._tiles[key].coords.z !== zoom) {
+ continue;
+ }
+ this._removeTile(key);
+ }
},
- _pxBoundsToTileRange: function (bounds) {
- var tileSize = this.getTileSize();
- return new L.Bounds(
- bounds.min.unscaleBy(tileSize).floor(),
- bounds.max.unscaleBy(tileSize).ceil().subtract([1, 1]));
+ _removeAllTiles: function () {
+ for (var key in this._tiles) {
+ this._removeTile(key);
+ }
},
- _noTilesToLoad: function () {
- for (var key in this._tiles) {
- if (!this._tiles[key].loaded) { return false; }
+ _invalidateAll: function () {
+ for (var z in this._levels) {
+ L.DomUtil.remove(this._levels[z].el);
+ delete this._levels[z];
}
- return true;
- }
-});
+ this._removeAllTiles();
-// @factory L.gridLayer(options?: GridLayer options)
-// Creates a new instance of GridLayer with the supplied options.
-L.gridLayer = function (options) {
- return new L.GridLayer(options);
-};
+ this._tileZoom = null;
+ },
+ _retainParent: function (x, y, z, minZoom) {
+ var x2 = Math.floor(x / 2),
+ y2 = Math.floor(y / 2),
+ z2 = z - 1,
+ coords2 = new L.Point(+x2, +y2);
+ coords2.z = +z2;
+ var key = this._tileCoordsToKey(coords2),
+ tile = this._tiles[key];
-/*
- * @class TileLayer
- * @inherits GridLayer
- * @aka L.TileLayer
- * Used to load and display tile layers on the map. Extends `GridLayer`.
- *
- * @example
- *
- * ```js
- * L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);
- * ```
- *
- * @section URL template
- * @example
- *
- * A string of the following form:
- *
- * ```
- * 'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
- * ```
- *
- * `{s}` means one of the available subdomains (used sequentially to help with browser parallel requests per domain limitation; subdomain values are specified in options; `a`, `b` or `c` by default, can be omitted), `{z}` — zoom level, `{x}` and `{y}` — tile coordinates. `{r}` can be used to add @2x to the URL to load retina tiles.
- *
- * You can use custom keys in the template, which will be [evaluated](#util-template) from TileLayer options, like this:
- *
- * ```
- * L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});
- * ```
- */
+ if (tile && tile.active) {
+ tile.retain = true;
+ return true;
+ } else if (tile && tile.loaded) {
+ tile.retain = true;
+ }
-L.TileLayer = L.GridLayer.extend({
+ if (z2 > minZoom) {
+ return this._retainParent(x2, y2, z2, minZoom);
+ }
- // @section
- // @aka TileLayer options
- options: {
- // @option minZoom: Number = 0
- // Minimum zoom number.
- minZoom: 0,
+ return false;
+ },
- // @option maxZoom: Number = 18
- // Maximum zoom number.
- maxZoom: 18,
+ _retainChildren: function (x, y, z, maxZoom) {
- // @option maxNativeZoom: Number = null
- // Maximum zoom number the tile source has available. If it is specified,
- // the tiles on all zoom levels higher than `maxNativeZoom` will be loaded
- // from `maxNativeZoom` level and auto-scaled.
- maxNativeZoom: null,
+ for (var i = 2 * x; i < 2 * x + 2; i++) {
+ for (var j = 2 * y; j < 2 * y + 2; j++) {
- // @option subdomains: String|String[] = 'abc'
- // Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.
- subdomains: 'abc',
+ var coords = new L.Point(i, j);
+ coords.z = z + 1;
- // @option errorTileUrl: String = ''
- // URL to the tile image to show in place of the tile that failed to load.
- errorTileUrl: '',
+ var key = this._tileCoordsToKey(coords),
+ tile = this._tiles[key];
- // @option zoomOffset: Number = 0
- // The zoom number used in tile URLs will be offset with this value.
- zoomOffset: 0,
+ if (tile && tile.active) {
+ tile.retain = true;
+ continue;
- // @option tms: Boolean = false
- // If `true`, inverses Y axis numbering for tiles (turn this on for [TMS](https://en.wikipedia.org/wiki/Tile_Map_Service) services).
- tms: false,
+ } else if (tile && tile.loaded) {
+ tile.retain = true;
+ }
- // @option zoomReverse: Boolean = false
- // If set to true, the zoom number used in tile URLs will be reversed (`maxZoom - zoom` instead of `zoom`)
- zoomReverse: false,
+ if (z + 1 < maxZoom) {
+ this._retainChildren(i, j, z + 1, maxZoom);
+ }
+ }
+ }
+ },
- // @option detectRetina: Boolean = false
- // If `true` and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.
- detectRetina: false,
+ _resetView: function (e) {
+ var animating = e && (e.pinch || e.flyTo);
+ this._setView(this._map.getCenter(), this._map.getZoom(), animating, animating);
+ },
- // @option crossOrigin: Boolean = false
- // If true, all tiles will have their crossOrigin attribute set to ''. This is needed if you want to access tile pixel data.
- crossOrigin: false
+ _animateZoom: function (e) {
+ this._setView(e.center, e.zoom, true, e.noUpdate);
},
- initialize: function (url, options) {
+ _setView: function (center, zoom, noPrune, noUpdate) {
+ var tileZoom = Math.round(zoom);
+ if ((this.options.maxZoom !== undefined && tileZoom > this.options.maxZoom) ||
+ (this.options.minZoom !== undefined && tileZoom < this.options.minZoom)) {
+ tileZoom = undefined;
+ }
- this._url = url;
+ var tileZoomChanged = this.options.updateWhenZooming && (tileZoom !== this._tileZoom);
- options = L.setOptions(this, options);
+ if (!noUpdate || tileZoomChanged) {
- // detecting retina displays, adjusting tileSize and zoom levels
- if (options.detectRetina && L.Browser.retina && options.maxZoom > 0) {
+ this._tileZoom = tileZoom;
- options.tileSize = Math.floor(options.tileSize / 2);
+ if (this._abortLoading) {
+ this._abortLoading();
+ }
- if (!options.zoomReverse) {
- options.zoomOffset++;
- options.maxZoom--;
- } else {
- options.zoomOffset--;
- options.minZoom++;
+ this._updateLevels();
+ this._resetGrid();
+
+ if (tileZoom !== undefined) {
+ this._update(center);
}
- options.minZoom = Math.max(0, options.minZoom);
- }
+ if (!noPrune) {
+ this._pruneTiles();
+ }
- if (typeof options.subdomains === 'string') {
- options.subdomains = options.subdomains.split('');
+ // Flag to prevent _updateOpacity from pruning tiles during
+ // a zoom anim or a pinch gesture
+ this._noPrune = !!noPrune;
}
- // for https://github.com/Leaflet/Leaflet/issues/137
- if (!L.Browser.android) {
- this.on('tileunload', this._onTileRemove);
- }
+ this._setZoomTransforms(center, zoom);
},
- // @method setUrl(url: String, noRedraw?: Boolean): this
- // Updates the layer's URL template and redraws it (unless `noRedraw` is set to `true`).
- setUrl: function (url, noRedraw) {
- this._url = url;
-
- if (!noRedraw) {
- this.redraw();
+ _setZoomTransforms: function (center, zoom) {
+ for (var i in this._levels) {
+ this._setZoomTransform(this._levels[i], center, zoom);
}
- return this;
},
- // @method createTile(coords: Object, done?: Function): HTMLElement
- // Called only internally, overrides GridLayer's [`createTile()`](#gridlayer-createtile)
- // to return an `<img>` HTML element with the appropiate image URL given `coords`. The `done`
- // callback is called when the tile has been loaded.
- createTile: function (coords, done) {
- var tile = document.createElement('img');
-
- L.DomEvent.on(tile, 'load', L.bind(this._tileOnLoad, this, done, tile));
- L.DomEvent.on(tile, 'error', L.bind(this._tileOnError, this, done, tile));
+ _setZoomTransform: function (level, center, zoom) {
+ var scale = this._map.getZoomScale(zoom, level.zoom),
+ translate = level.origin.multiplyBy(scale)
+ .subtract(this._map._getNewPixelOrigin(center, zoom)).round();
- if (this.options.crossOrigin) {
- tile.crossOrigin = '';
+ if (L.Browser.any3d) {
+ L.DomUtil.setTransform(level.el, translate, scale);
+ } else {
+ L.DomUtil.setPosition(level.el, translate);
}
-
- /*
- Alt tag is set to empty string to keep screen readers from reading URL and for compliance reasons
- http://www.w3.org/TR/WCAG20-TECHS/H67
- */
- tile.alt = '';
-
- tile.src = this.getTileUrl(coords);
-
- return tile;
},
- // @section Extension methods
- // @uninheritable
- // Layers extending `TileLayer` might reimplement the following method.
- // @method getTileUrl(coords: Object): String
- // Called only internally, returns the URL for a tile given its coordinates.
- // Classes extending `TileLayer` can override this function to provide custom tile URL naming schemes.
- getTileUrl: function (coords) {
- var data = {
- r: L.Browser.retina ? '@2x' : '',
- s: this._getSubdomain(coords),
- x: coords.x,
- y: coords.y,
- z: this._getZoomForUrl()
- };
- if (this._map && !this._map.options.crs.infinite) {
- var invertedY = this._globalTileRange.max.y - coords.y;
- if (this.options.tms) {
- data['y'] = invertedY;
- }
- data['-y'] = invertedY;
+ _resetGrid: function () {
+ var map = this._map,
+ crs = map.options.crs,
+ tileSize = this._tileSize = this.getTileSize(),
+ tileZoom = this._tileZoom;
+
+ var bounds = this._map.getPixelWorldBounds(this._tileZoom);
+ if (bounds) {
+ this._globalTileRange = this._pxBoundsToTileRange(bounds);
}
- return L.Util.template(this._url, L.extend(data, this.options));
+ this._wrapX = crs.wrapLng && !this.options.noWrap && [
+ Math.floor(map.project([0, crs.wrapLng[0]], tileZoom).x / tileSize.x),
+ Math.ceil(map.project([0, crs.wrapLng[1]], tileZoom).x / tileSize.y)
+ ];
+ this._wrapY = crs.wrapLat && !this.options.noWrap && [
+ Math.floor(map.project([crs.wrapLat[0], 0], tileZoom).y / tileSize.x),
+ Math.ceil(map.project([crs.wrapLat[1], 0], tileZoom).y / tileSize.y)
+ ];
},
- _tileOnLoad: function (done, tile) {
- // For https://github.com/Leaflet/Leaflet/issues/3332
- if (L.Browser.ielt9) {
- setTimeout(L.bind(done, this, null, tile), 0);
- } else {
- done(null, tile);
- }
- },
+ _onMoveEnd: function () {
+ if (!this._map || this._map._animatingZoom) { return; }
- _tileOnError: function (done, tile, e) {
- var errorUrl = this.options.errorTileUrl;
- if (errorUrl) {
- tile.src = errorUrl;
- }
- done(e, tile);
+ this._update();
},
- getTileSize: function () {
+ _getTiledPixelBounds: function (center) {
var map = this._map,
- tileSize = L.GridLayer.prototype.getTileSize.call(this),
- zoom = this._tileZoom + this.options.zoomOffset,
- zoomN = this.options.maxNativeZoom;
+ mapZoom = map._animatingZoom ? Math.max(map._animateToZoom, map.getZoom()) : map.getZoom(),
+ scale = map.getZoomScale(mapZoom, this._tileZoom),
+ pixelCenter = map.project(center, this._tileZoom).floor(),
+ halfSize = map.getSize().divideBy(scale * 2);
- // increase tile size when overscaling
- return zoomN !== null && zoom > zoomN ?
- tileSize.divideBy(map.getZoomScale(zoomN, zoom)).round() :
- tileSize;
+ return new L.Bounds(pixelCenter.subtract(halfSize), pixelCenter.add(halfSize));
},
- _onTileRemove: function (e) {
- e.tile.onload = null;
- },
+ // Private method to load tiles in the grid's active zoom level according to map bounds
+ _update: function (center) {
+ var map = this._map;
+ if (!map) { return; }
+ var zoom = map.getZoom();
- _getZoomForUrl: function () {
+ if (center === undefined) { center = map.getCenter(); }
+ if (this._tileZoom === undefined) { return; } // if out of minzoom/maxzoom
- var options = this.options,
- zoom = this._tileZoom;
+ var pixelBounds = this._getTiledPixelBounds(center),
+ tileRange = this._pxBoundsToTileRange(pixelBounds),
+ tileCenter = tileRange.getCenter(),
+ queue = [],
+ margin = this.options.keepBuffer,
+ noPruneRange = new L.Bounds(tileRange.getBottomLeft().subtract([margin, -margin]),
+ tileRange.getTopRight().add([margin, -margin]));
- if (options.zoomReverse) {
- zoom = options.maxZoom - zoom;
+ for (var key in this._tiles) {
+ var c = this._tiles[key].coords;
+ if (c.z !== this._tileZoom || !noPruneRange.contains(L.point(c.x, c.y))) {
+ this._tiles[key].current = false;
+ }
}
- zoom += options.zoomOffset;
-
- return options.maxNativeZoom !== null ? Math.min(zoom, options.maxNativeZoom) : zoom;
- },
-
- _getSubdomain: function (tilePoint) {
- var index = Math.abs(tilePoint.x + tilePoint.y) % this.options.subdomains.length;
- return this.options.subdomains[index];
- },
+ // _update just loads more tiles. If the tile zoom level differs too much
+ // from the map's, let _setView reset levels and prune old tiles.
+ if (Math.abs(zoom - this._tileZoom) > 1) { this._setView(center, zoom); return; }
- // stops loading all tiles in the background layer
- _abortLoading: function () {
- var i, tile;
- for (i in this._tiles) {
- if (this._tiles[i].coords.z !== this._tileZoom) {
- tile = this._tiles[i].el;
+ // create a queue of coordinates to load tiles from
+ for (var j = tileRange.min.y; j <= tileRange.max.y; j++) {
+ for (var i = tileRange.min.x; i <= tileRange.max.x; i++) {
+ var coords = new L.Point(i, j);
+ coords.z = this._tileZoom;
- tile.onload = L.Util.falseFn;
- tile.onerror = L.Util.falseFn;
+ if (!this._isValidTile(coords)) { continue; }
- if (!tile.complete) {
- tile.src = L.Util.emptyImageUrl;
- L.DomUtil.remove(tile);
+ var tile = this._tiles[this._tileCoordsToKey(coords)];
+ if (tile) {
+ tile.current = true;
+ } else {
+ queue.push(coords);
}
}
}
- }
-});
-
-
-// @factory L.tilelayer(urlTemplate: String, options?: TileLayer options)
-// Instantiates a tile layer object given a `URL template` and optionally an options object.
-
-L.tileLayer = function (url, options) {
- return new L.TileLayer(url, options);
-};
+ // sort tile queue to load tiles in order of their distance to center
+ queue.sort(function (a, b) {
+ return a.distanceTo(tileCenter) - b.distanceTo(tileCenter);
+ });
+ if (queue.length !== 0) {
+ // if it's the first batch of tiles to load
+ if (!this._loading) {
+ this._loading = true;
+ // @event loading: Event
+ // Fired when the grid layer starts loading tiles.
+ this.fire('loading');
+ }
-/*
- * @class TileLayer.WMS
- * @inherits TileLayer
- * @aka L.TileLayer.WMS
- * Used to display [WMS](https://en.wikipedia.org/wiki/Web_Map_Service) services as tile layers on the map. Extends `TileLayer`.
- *
- * @example
- *
- * ```js
- * var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
- * layers: 'nexrad-n0r-900913',
- * format: 'image/png',
- * transparent: true,
- * attribution: "Weather data © 2012 IEM Nexrad"
- * });
- * ```
- */
+ // create DOM fragment to append tiles in one batch
+ var fragment = document.createDocumentFragment();
-L.TileLayer.WMS = L.TileLayer.extend({
+ for (i = 0; i < queue.length; i++) {
+ this._addTile(queue[i], fragment);
+ }
- // @section
- // @aka TileLayer.WMS options
- // If any custom options not documented here are used, they will be sent to the
- // WMS server as extra parameters in each request URL. This can be useful for
- // [non-standard vendor WMS parameters](http://docs.geoserver.org/stable/en/user/services/wms/vendor.html).
- defaultWmsParams: {
- service: 'WMS',
- request: 'GetMap',
+ this._level.el.appendChild(fragment);
+ }
+ },
- // @option layers: String = ''
- // **(required)** Comma-separated list of WMS layers to show.
- layers: '',
+ _isValidTile: function (coords) {
+ var crs = this._map.options.crs;
- // @option styles: String = ''
- // Comma-separated list of WMS styles.
- styles: '',
+ if (!crs.infinite) {
+ // don't load tile if it's out of bounds and not wrapped
+ var bounds = this._globalTileRange;
+ if ((!crs.wrapLng && (coords.x < bounds.min.x || coords.x > bounds.max.x)) ||
+ (!crs.wrapLat && (coords.y < bounds.min.y || coords.y > bounds.max.y))) { return false; }
+ }
- // @option format: String = 'image/jpeg'
- // WMS image format (use `'image/png'` for layers with transparency).
- format: 'image/jpeg',
+ if (!this.options.bounds) { return true; }
- // @option transparent: Boolean = false
- // If `true`, the WMS service will return images with transparency.
- transparent: false,
+ // don't load tile if it doesn't intersect the bounds in options
+ var tileBounds = this._tileCoordsToBounds(coords);
+ return L.latLngBounds(this.options.bounds).overlaps(tileBounds);
+ },
- // @option version: String = '1.1.1'
- // Version of the WMS service to use
- version: '1.1.1'
+ _keyToBounds: function (key) {
+ return this._tileCoordsToBounds(this._keyToTileCoords(key));
},
- options: {
- // @option crs: CRS = null
- // Coordinate Reference System to use for the WMS requests, defaults to
- // map CRS. Don't change this if you're not sure what it means.
- crs: null,
+ // converts tile coordinates to its geographical bounds
+ _tileCoordsToBounds: function (coords) {
- // @option uppercase: Boolean = false
- // If `true`, WMS request parameter keys will be uppercase.
- uppercase: false
- },
+ var map = this._map,
+ tileSize = this.getTileSize(),
- initialize: function (url, options) {
+ nwPoint = coords.scaleBy(tileSize),
+ sePoint = nwPoint.add(tileSize),
- this._url = url;
+ nw = map.unproject(nwPoint, coords.z),
+ se = map.unproject(sePoint, coords.z);
- var wmsParams = L.extend({}, this.defaultWmsParams);
+ if (!this.options.noWrap) {
+ nw = map.wrapLatLng(nw);
+ se = map.wrapLatLng(se);
+ }
- // all keys that are not TileLayer options go to WMS params
- for (var i in options) {
- if (!(i in this.options)) {
- wmsParams[i] = options[i];
- }
- }
+ return new L.LatLngBounds(nw, se);
+ },
- options = L.setOptions(this, options);
+ // converts tile coordinates to key for the tile cache
+ _tileCoordsToKey: function (coords) {
+ return coords.x + ':' + coords.y + ':' + coords.z;
+ },
- wmsParams.width = wmsParams.height = options.tileSize * (options.detectRetina && L.Browser.retina ? 2 : 1);
+ // converts tile cache key to coordinates
+ _keyToTileCoords: function (key) {
+ var k = key.split(':'),
+ coords = new L.Point(+k[0], +k[1]);
+ coords.z = +k[2];
+ return coords;
+ },
- this.wmsParams = wmsParams;
+ _removeTile: function (key) {
+ var tile = this._tiles[key];
+ if (!tile) { return; }
+
+ L.DomUtil.remove(tile.el);
+
+ delete this._tiles[key];
+
+ // @event tileunload: TileEvent
+ // Fired when a tile is removed (e.g. when a tile goes off the screen).
+ this.fire('tileunload', {
+ tile: tile.el,
+ coords: this._keyToTileCoords(key)
+ });
},
- onAdd: function (map) {
+ _initTile: function (tile) {
+ L.DomUtil.addClass(tile, 'leaflet-tile');
- this._crs = this.options.crs || map.options.crs;
- this._wmsVersion = parseFloat(this.wmsParams.version);
+ var tileSize = this.getTileSize();
+ tile.style.width = tileSize.x + 'px';
+ tile.style.height = tileSize.y + 'px';
- var projectionKey = this._wmsVersion >= 1.3 ? 'crs' : 'srs';
- this.wmsParams[projectionKey] = this._crs.code;
+ tile.onselectstart = L.Util.falseFn;
+ tile.onmousemove = L.Util.falseFn;
- L.TileLayer.prototype.onAdd.call(this, map);
+ // update opacity on tiles in IE7-8 because of filter inheritance problems
+ if (L.Browser.ielt9 && this.options.opacity < 1) {
+ L.DomUtil.setOpacity(tile, this.options.opacity);
+ }
+
+ // without this hack, tiles disappear after zoom on Chrome for Android
+ // https://github.com/Leaflet/Leaflet/issues/2078
+ if (L.Browser.android && !L.Browser.android23) {
+ tile.style.WebkitBackfaceVisibility = 'hidden';
+ }
},
- getTileUrl: function (coords) {
+ _addTile: function (coords, container) {
+ var tilePos = this._getTilePos(coords),
+ key = this._tileCoordsToKey(coords);
- var tileBounds = this._tileCoordsToBounds(coords),
- nw = this._crs.project(tileBounds.getNorthWest()),
- se = this._crs.project(tileBounds.getSouthEast()),
+ var tile = this.createTile(this._wrapCoords(coords), L.bind(this._tileReady, this, coords));
- bbox = (this._wmsVersion >= 1.3 && this._crs === L.CRS.EPSG4326 ?
- [se.y, nw.x, nw.y, se.x] :
- [nw.x, se.y, se.x, nw.y]).join(','),
+ this._initTile(tile);
- url = L.TileLayer.prototype.getTileUrl.call(this, coords);
+ // if createTile is defined with a second argument ("done" callback),
+ // we know that tile is async and will be ready later; otherwise
+ if (this.createTile.length < 2) {
+ // mark tile as ready, but delay one frame for opacity animation to happen
+ L.Util.requestAnimFrame(L.bind(this._tileReady, this, coords, null, tile));
+ }
- return url +
- L.Util.getParamString(this.wmsParams, url, this.options.uppercase) +
- (this.options.uppercase ? '&BBOX=' : '&bbox=') + bbox;
+ L.DomUtil.setPosition(tile, tilePos);
+
+ // save tile in cache
+ this._tiles[key] = {
+ el: tile,
+ coords: coords,
+ current: true
+ };
+
+ container.appendChild(tile);
+ // @event tileloadstart: TileEvent
+ // Fired when a tile is requested and starts loading.
+ this.fire('tileloadstart', {
+ tile: tile,
+ coords: coords
+ });
},
- // @method setParams(params: Object, noRedraw?: Boolean): this
- // Merges an object with the new parameters and re-requests tiles on the current screen (unless `noRedraw` was set to true).
- setParams: function (params, noRedraw) {
+ _tileReady: function (coords, err, tile) {
+ if (!this._map) { return; }
- L.extend(this.wmsParams, params);
+ if (err) {
+ // @event tileerror: TileErrorEvent
+ // Fired when there is an error loading a tile.
+ this.fire('tileerror', {
+ error: err,
+ tile: tile,
+ coords: coords
+ });
+ }
- if (!noRedraw) {
- this.redraw();
+ var key = this._tileCoordsToKey(coords);
+
+ tile = this._tiles[key];
+ if (!tile) { return; }
+
+ tile.loaded = +new Date();
+ if (this._map._fadeAnimated) {
+ L.DomUtil.setOpacity(tile.el, 0);
+ L.Util.cancelAnimFrame(this._fadeFrame);
+ this._fadeFrame = L.Util.requestAnimFrame(this._updateOpacity, this);
+ } else {
+ tile.active = true;
+ this._pruneTiles();
}
- return this;
+ if (!err) {
+ L.DomUtil.addClass(tile.el, 'leaflet-tile-loaded');
+
+ // @event tileload: TileEvent
+ // Fired when a tile loads.
+ this.fire('tileload', {
+ tile: tile.el,
+ coords: coords
+ });
+ }
+
+ if (this._noTilesToLoad()) {
+ this._loading = false;
+ // @event load: Event
+ // Fired when the grid layer loaded all visible tiles.
+ this.fire('load');
+
+ if (L.Browser.ielt9 || !this._map._fadeAnimated) {
+ L.Util.requestAnimFrame(this._pruneTiles, this);
+ } else {
+ // Wait a bit more than 0.2 secs (the duration of the tile fade-in)
+ // to trigger a pruning.
+ setTimeout(L.bind(this._pruneTiles, this), 250);
+ }
+ }
+ },
+
+ _getTilePos: function (coords) {
+ return coords.scaleBy(this.getTileSize()).subtract(this._level.origin);
+ },
+
+ _wrapCoords: function (coords) {
+ var newCoords = new L.Point(
+ this._wrapX ? L.Util.wrapNum(coords.x, this._wrapX) : coords.x,
+ this._wrapY ? L.Util.wrapNum(coords.y, this._wrapY) : coords.y);
+ newCoords.z = coords.z;
+ return newCoords;
+ },
+
+ _pxBoundsToTileRange: function (bounds) {
+ var tileSize = this.getTileSize();
+ return new L.Bounds(
+ bounds.min.unscaleBy(tileSize).floor(),
+ bounds.max.unscaleBy(tileSize).ceil().subtract([1, 1]));
+ },
+
+ _noTilesToLoad: function () {
+ for (var key in this._tiles) {
+ if (!this._tiles[key].loaded) { return false; }
+ }
+ return true;
}
});
-
-// @factory L.tileLayer.wms(baseUrl: String, options: TileLayer.WMS options)
-// Instantiates a WMS tile layer object given a base URL of the WMS service and a WMS parameters/options object.
-L.tileLayer.wms = function (url, options) {
- return new L.TileLayer.WMS(url, options);
+// @factory L.gridLayer(options?: GridLayer options)
+// Creates a new instance of GridLayer with the supplied options.
+L.gridLayer = function (options) {
+ return new L.GridLayer(options);
};
/*
- * @class ImageOverlay
- * @aka L.ImageOverlay
- * @inherits Interactive layer
- *
- * Used to load and display a single image over specific bounds of the map. Extends `Layer`.
+ * @class TileLayer
+ * @inherits GridLayer
+ * @aka L.TileLayer
+ * Used to load and display tile layers on the map. Extends `GridLayer`.
*
* @example
*
* ```js
- * var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
- * imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
- * L.imageOverlay(imageUrl, imageBounds).addTo(map);
+ * L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);
+ * ```
+ *
+ * @section URL template
+ * @example
+ *
+ * A string of the following form:
+ *
+ * ```
+ * 'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
+ * ```
+ *
+ * `{s}` means one of the available subdomains (used sequentially to help with browser parallel requests per domain limitation; subdomain values are specified in options; `a`, `b` or `c` by default, can be omitted), `{z}` — zoom level, `{x}` and `{y}` — tile coordinates. `{r}` can be used to add @2x to the URL to load retina tiles.
+ *
+ * You can use custom keys in the template, which will be [evaluated](#util-template) from TileLayer options, like this:
+ *
+ * ```
+ * L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});
* ```
*/
-L.ImageOverlay = L.Layer.extend({
+
+L.TileLayer = L.GridLayer.extend({
// @section
- // @aka ImageOverlay options
+ // @aka TileLayer options
options: {
- // @option opacity: Number = 1.0
- // The opacity of the image overlay.
- opacity: 1,
-
- // @option alt: String = ''
- // Text for the `alt` attribute of the image (useful for accessibility).
- alt: '',
+ // @option minZoom: Number = 0
+ // Minimum zoom number.
+ minZoom: 0,
- // @option interactive: Boolean = false
- // If `true`, the image overlay will emit [mouse events](#interactive-layer) when clicked or hovered.
- interactive: false,
+ // @option maxZoom: Number = 18
+ // Maximum zoom number.
+ maxZoom: 18,
- // @option attribution: String = null
- // An optional string containing HTML to be shown on the `Attribution control`
- attribution: null,
+ // @option maxNativeZoom: Number = null
+ // Maximum zoom number the tile source has available. If it is specified,
+ // the tiles on all zoom levels higher than `maxNativeZoom` will be loaded
+ // from `maxNativeZoom` level and auto-scaled.
+ maxNativeZoom: null,
- // @option crossOrigin: Boolean = false
- // If true, the image will have its crossOrigin attribute set to ''. This is needed if you want to access image pixel data.
- crossOrigin: false
- },
+ // @option minNativeZoom: Number = null
+ // Minimum zoom number the tile source has available. If it is specified,
+ // the tiles on all zoom levels lower than `minNativeZoom` will be loaded
+ // from `minNativeZoom` level and auto-scaled.
+ minNativeZoom: null,
- initialize: function (url, bounds, options) { // (String, LatLngBounds, Object)
- this._url = url;
- this._bounds = L.latLngBounds(bounds);
+ // @option subdomains: String|String[] = 'abc'
+ // Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.
+ subdomains: 'abc',
- L.setOptions(this, options);
+ // @option errorTileUrl: String = ''
+ // URL to the tile image to show in place of the tile that failed to load.
+ errorTileUrl: '',
+
+ // @option zoomOffset: Number = 0
+ // The zoom number used in tile URLs will be offset with this value.
+ zoomOffset: 0,
+
+ // @option tms: Boolean = false
+ // If `true`, inverses Y axis numbering for tiles (turn this on for [TMS](https://en.wikipedia.org/wiki/Tile_Map_Service) services).
+ tms: false,
+
+ // @option zoomReverse: Boolean = false
+ // If set to true, the zoom number used in tile URLs will be reversed (`maxZoom - zoom` instead of `zoom`)
+ zoomReverse: false,
+
+ // @option detectRetina: Boolean = false
+ // If `true` and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.
+ detectRetina: false,
+
+ // @option crossOrigin: Boolean = false
+ // If true, all tiles will have their crossOrigin attribute set to ''. This is needed if you want to access tile pixel data.
+ crossOrigin: false
},
- onAdd: function () {
- if (!this._image) {
- this._initImage();
+ initialize: function (url, options) {
- if (this.options.opacity < 1) {
- this._updateOpacity();
+ this._url = url;
+
+ options = L.setOptions(this, options);
+
+ // detecting retina displays, adjusting tileSize and zoom levels
+ if (options.detectRetina && L.Browser.retina && options.maxZoom > 0) {
+
+ options.tileSize = Math.floor(options.tileSize / 2);
+
+ if (!options.zoomReverse) {
+ options.zoomOffset++;
+ options.maxZoom--;
+ } else {
+ options.zoomOffset--;
+ options.minZoom++;
}
- }
- if (this.options.interactive) {
- L.DomUtil.addClass(this._image, 'leaflet-interactive');
- this.addInteractiveTarget(this._image);
+ options.minZoom = Math.max(0, options.minZoom);
}
- this.getPane().appendChild(this._image);
- this._reset();
- },
+ if (typeof options.subdomains === 'string') {
+ options.subdomains = options.subdomains.split('');
+ }
- onRemove: function () {
- L.DomUtil.remove(this._image);
- if (this.options.interactive) {
- this.removeInteractiveTarget(this._image);
+ // for https://github.com/Leaflet/Leaflet/issues/137
+ if (!L.Browser.android) {
+ this.on('tileunload', this._onTileRemove);
}
},
- // @method setOpacity(opacity: Number): this
- // Sets the opacity of the overlay.
- setOpacity: function (opacity) {
- this.options.opacity = opacity;
+ // @method setUrl(url: String, noRedraw?: Boolean): this
+ // Updates the layer's URL template and redraws it (unless `noRedraw` is set to `true`).
+ setUrl: function (url, noRedraw) {
+ this._url = url;
- if (this._image) {
- this._updateOpacity();
+ if (!noRedraw) {
+ this.redraw();
}
return this;
},
- setStyle: function (styleOpts) {
- if (styleOpts.opacity) {
- this.setOpacity(styleOpts.opacity);
- }
- return this;
- },
+ // @method createTile(coords: Object, done?: Function): HTMLElement
+ // Called only internally, overrides GridLayer's [`createTile()`](#gridlayer-createtile)
+ // to return an `<img>` HTML element with the appropiate image URL given `coords`. The `done`
+ // callback is called when the tile has been loaded.
+ createTile: function (coords, done) {
+ var tile = document.createElement('img');
- // @method bringToFront(): this
- // Brings the layer to the top of all overlays.
- bringToFront: function () {
- if (this._map) {
- L.DomUtil.toFront(this._image);
+ L.DomEvent.on(tile, 'load', L.bind(this._tileOnLoad, this, done, tile));
+ L.DomEvent.on(tile, 'error', L.bind(this._tileOnError, this, done, tile));
+
+ if (this.options.crossOrigin) {
+ tile.crossOrigin = '';
}
- return this;
+
+ /*
+ Alt tag is set to empty string to keep screen readers from reading URL and for compliance reasons
+ http://www.w3.org/TR/WCAG20-TECHS/H67
+ */
+ tile.alt = '';
+
+ /*
+ Set role="presentation" to force screen readers to ignore this
+ https://www.w3.org/TR/wai-aria/roles#textalternativecomputation
+ */
+ tile.setAttribute('role', 'presentation');
+
+ tile.src = this.getTileUrl(coords);
+
+ return tile;
},
- // @method bringToBack(): this
- // Brings the layer to the bottom of all overlays.
- bringToBack: function () {
- if (this._map) {
- L.DomUtil.toBack(this._image);
+ // @section Extension methods
+ // @uninheritable
+ // Layers extending `TileLayer` might reimplement the following method.
+ // @method getTileUrl(coords: Object): String
+ // Called only internally, returns the URL for a tile given its coordinates.
+ // Classes extending `TileLayer` can override this function to provide custom tile URL naming schemes.
+ getTileUrl: function (coords) {
+ var data = {
+ r: L.Browser.retina ? '@2x' : '',
+ s: this._getSubdomain(coords),
+ x: coords.x,
+ y: coords.y,
+ z: this._getZoomForUrl()
+ };
+ if (this._map && !this._map.options.crs.infinite) {
+ var invertedY = this._globalTileRange.max.y - coords.y;
+ if (this.options.tms) {
+ data['y'] = invertedY;
+ }
+ data['-y'] = invertedY;
}
- return this;
- },
- // @method setUrl(url: String): this
- // Changes the URL of the image.
- setUrl: function (url) {
- this._url = url;
+ return L.Util.template(this._url, L.extend(data, this.options));
+ },
- if (this._image) {
- this._image.src = url;
+ _tileOnLoad: function (done, tile) {
+ // For https://github.com/Leaflet/Leaflet/issues/3332
+ if (L.Browser.ielt9) {
+ setTimeout(L.bind(done, this, null, tile), 0);
+ } else {
+ done(null, tile);
}
- return this;
},
- setBounds: function (bounds) {
- this._bounds = bounds;
-
- if (this._map) {
- this._reset();
+ _tileOnError: function (done, tile, e) {
+ var errorUrl = this.options.errorTileUrl;
+ if (errorUrl) {
+ tile.src = errorUrl;
}
- return this;
+ done(e, tile);
},
- getAttribution: function () {
- return this.options.attribution;
- },
+ getTileSize: function () {
+ var map = this._map,
+ tileSize = L.GridLayer.prototype.getTileSize.call(this),
+ zoom = this._tileZoom + this.options.zoomOffset,
+ minNativeZoom = this.options.minNativeZoom,
+ maxNativeZoom = this.options.maxNativeZoom;
- getEvents: function () {
- var events = {
- zoom: this._reset,
- viewreset: this._reset
- };
+ // decrease tile size when scaling below minNativeZoom
+ if (minNativeZoom !== null && zoom < minNativeZoom) {
+ return tileSize.divideBy(map.getZoomScale(minNativeZoom, zoom)).round();
+ }
- if (this._zoomAnimated) {
- events.zoomanim = this._animateZoom;
+ // increase tile size when scaling above maxNativeZoom
+ if (maxNativeZoom !== null && zoom > maxNativeZoom) {
+ return tileSize.divideBy(map.getZoomScale(maxNativeZoom, zoom)).round();
}
- return events;
+ return tileSize;
},
- getBounds: function () {
- return this._bounds;
+ _onTileRemove: function (e) {
+ e.tile.onload = null;
},
- getElement: function () {
- return this._image;
- },
+ _getZoomForUrl: function () {
+ var zoom = this._tileZoom,
+ maxZoom = this.options.maxZoom,
+ zoomReverse = this.options.zoomReverse,
+ zoomOffset = this.options.zoomOffset,
+ minNativeZoom = this.options.minNativeZoom,
+ maxNativeZoom = this.options.maxNativeZoom;
- _initImage: function () {
- var img = this._image = L.DomUtil.create('img',
- 'leaflet-image-layer ' + (this._zoomAnimated ? 'leaflet-zoom-animated' : ''));
+ if (zoomReverse) {
+ zoom = maxZoom - zoom;
+ }
- img.onselectstart = L.Util.falseFn;
- img.onmousemove = L.Util.falseFn;
+ zoom += zoomOffset;
- img.onload = L.bind(this.fire, this, 'load');
+ if (minNativeZoom !== null && zoom < minNativeZoom) {
+ return minNativeZoom;
+ }
- if (this.options.crossOrigin) {
- img.crossOrigin = '';
+ if (maxNativeZoom !== null && zoom > maxNativeZoom) {
+ return maxNativeZoom;
}
- img.src = this._url;
- img.alt = this.options.alt;
+ return zoom;
},
- _animateZoom: function (e) {
- var scale = this._map.getZoomScale(e.zoom),
- offset = this._map._latLngToNewLayerPoint(this._bounds.getNorthWest(), e.zoom, e.center);
-
- L.DomUtil.setTransform(this._image, offset, scale);
+ _getSubdomain: function (tilePoint) {
+ var index = Math.abs(tilePoint.x + tilePoint.y) % this.options.subdomains.length;
+ return this.options.subdomains[index];
},
- _reset: function () {
- var image = this._image,
- bounds = new L.Bounds(
- this._map.latLngToLayerPoint(this._bounds.getNorthWest()),
- this._map.latLngToLayerPoint(this._bounds.getSouthEast())),
- size = bounds.getSize();
-
- L.DomUtil.setPosition(image, bounds.min);
+ // stops loading all tiles in the background layer
+ _abortLoading: function () {
+ var i, tile;
+ for (i in this._tiles) {
+ if (this._tiles[i].coords.z !== this._tileZoom) {
+ tile = this._tiles[i].el;
- image.style.width = size.x + 'px';
- image.style.height = size.y + 'px';
- },
+ tile.onload = L.Util.falseFn;
+ tile.onerror = L.Util.falseFn;
- _updateOpacity: function () {
- L.DomUtil.setOpacity(this._image, this.options.opacity);
+ if (!tile.complete) {
+ tile.src = L.Util.emptyImageUrl;
+ L.DomUtil.remove(tile);
+ }
+ }
+ }
}
});
-// @factory L.imageOverlay(imageUrl: String, bounds: LatLngBounds, options?: ImageOverlay options)
-// Instantiates an image overlay object given the URL of the image and the
-// geographical bounds it is tied to.
-L.imageOverlay = function (url, bounds, options) {
- return new L.ImageOverlay(url, bounds, options);
+
+// @factory L.tilelayer(urlTemplate: String, options?: TileLayer options)
+// Instantiates a tile layer object given a `URL template` and optionally an options object.
+
+L.tileLayer = function (url, options) {
+ return new L.TileLayer(url, options);
};
/*
- * @class Icon
- * @aka L.Icon
- * @inherits Layer
- *
- * Represents an icon to provide when creating a marker.
+ * @class TileLayer.WMS
+ * @inherits TileLayer
+ * @aka L.TileLayer.WMS
+ * Used to display [WMS](https://en.wikipedia.org/wiki/Web_Map_Service) services as tile layers on the map. Extends `TileLayer`.
*
* @example
*
* ```js
- * var myIcon = L.icon({
- * iconUrl: 'my-icon.png',
- * iconRetinaUrl: 'my-icon@2x.png',
- * iconSize: [38, 95],
- * iconAnchor: [22, 94],
- * popupAnchor: [-3, -76],
- * shadowUrl: 'my-icon-shadow.png',
- * shadowRetinaUrl: 'my-icon-shadow@2x.png',
- * shadowSize: [68, 95],
- * shadowAnchor: [22, 94]
+ * var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
+ * layers: 'nexrad-n0r-900913',
+ * format: 'image/png',
+ * transparent: true,
+ * attribution: "Weather data © 2012 IEM Nexrad"
* });
- *
- * L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
* ```
- *
- * `L.Icon.Default` extends `L.Icon` and is the blue icon Leaflet uses for markers by default.
- *
*/
-L.Icon = L.Class.extend({
+L.TileLayer.WMS = L.TileLayer.extend({
- /* @section
- * @aka Icon options
- *
- * @option iconUrl: String = null
- * **(required)** The URL to the icon image (absolute or relative to your script path).
- *
- * @option iconRetinaUrl: String = null
- * The URL to a retina sized version of the icon image (absolute or relative to your
- * script path). Used for Retina screen devices.
- *
- * @option iconSize: Point = null
- * Size of the icon image in pixels.
- *
- * @option iconAnchor: Point = null
- * The coordinates of the "tip" of the icon (relative to its top left corner). The icon
- * will be aligned so that this point is at the marker's geographical location. Centered
- * by default if size is specified, also can be set in CSS with negative margins.
- *
- * @option popupAnchor: Point = null
- * The coordinates of the point from which popups will "open", relative to the icon anchor.
- *
- * @option shadowUrl: String = null
- * The URL to the icon shadow image. If not specified, no shadow image will be created.
- *
- * @option shadowRetinaUrl: String = null
- *
- * @option shadowSize: Point = null
- * Size of the shadow image in pixels.
- *
- * @option shadowAnchor: Point = null
- * The coordinates of the "tip" of the shadow (relative to its top left corner) (the same
- * as iconAnchor if not specified).
- *
- * @option className: String = ''
- * A custom class name to assign to both icon and shadow images. Empty by default.
- */
+ // @section
+ // @aka TileLayer.WMS options
+ // If any custom options not documented here are used, they will be sent to the
+ // WMS server as extra parameters in each request URL. This can be useful for
+ // [non-standard vendor WMS parameters](http://docs.geoserver.org/stable/en/user/services/wms/vendor.html).
+ defaultWmsParams: {
+ service: 'WMS',
+ request: 'GetMap',
- initialize: function (options) {
- L.setOptions(this, options);
- },
+ // @option layers: String = ''
+ // **(required)** Comma-separated list of WMS layers to show.
+ layers: '',
- // @method createIcon(oldIcon?: HTMLElement): HTMLElement
- // Called internally when the icon has to be shown, returns a `<img>` HTML element
- // styled according to the options.
- createIcon: function (oldIcon) {
- return this._createIcon('icon', oldIcon);
- },
+ // @option styles: String = ''
+ // Comma-separated list of WMS styles.
+ styles: '',
- // @method createShadow(oldIcon?: HTMLElement): HTMLElement
- // As `createIcon`, but for the shadow beneath it.
- createShadow: function (oldIcon) {
- return this._createIcon('shadow', oldIcon);
- },
+ // @option format: String = 'image/jpeg'
+ // WMS image format (use `'image/png'` for layers with transparency).
+ format: 'image/jpeg',
- _createIcon: function (name, oldIcon) {
- var src = this._getIconUrl(name);
+ // @option transparent: Boolean = false
+ // If `true`, the WMS service will return images with transparency.
+ transparent: false,
- if (!src) {
- if (name === 'icon') {
- throw new Error('iconUrl not set in Icon options (see the docs).');
- }
- return null;
- }
+ // @option version: String = '1.1.1'
+ // Version of the WMS service to use
+ version: '1.1.1'
+ },
- var img = this._createImg(src, oldIcon && oldIcon.tagName === 'IMG' ? oldIcon : null);
- this._setIconStyles(img, name);
+ options: {
+ // @option crs: CRS = null
+ // Coordinate Reference System to use for the WMS requests, defaults to
+ // map CRS. Don't change this if you're not sure what it means.
+ crs: null,
- return img;
+ // @option uppercase: Boolean = false
+ // If `true`, WMS request parameter keys will be uppercase.
+ uppercase: false
},
- _setIconStyles: function (img, name) {
- var options = this.options;
- var sizeOption = options[name + 'Size'];
-
- if (typeof sizeOption === 'number') {
- sizeOption = [sizeOption, sizeOption];
- }
+ initialize: function (url, options) {
- var size = L.point(sizeOption),
- anchor = L.point(name === 'shadow' && options.shadowAnchor || options.iconAnchor ||
- size && size.divideBy(2, true));
+ this._url = url;
- img.className = 'leaflet-marker-' + name + ' ' + (options.className || '');
+ var wmsParams = L.extend({}, this.defaultWmsParams);
- if (anchor) {
- img.style.marginLeft = (-anchor.x) + 'px';
- img.style.marginTop = (-anchor.y) + 'px';
+ // all keys that are not TileLayer options go to WMS params
+ for (var i in options) {
+ if (!(i in this.options)) {
+ wmsParams[i] = options[i];
+ }
}
- if (size) {
- img.style.width = size.x + 'px';
- img.style.height = size.y + 'px';
- }
- },
+ options = L.setOptions(this, options);
- _createImg: function (src, el) {
- el = el || document.createElement('img');
- el.src = src;
- return el;
- },
+ wmsParams.width = wmsParams.height = options.tileSize * (options.detectRetina && L.Browser.retina ? 2 : 1);
- _getIconUrl: function (name) {
- return L.Browser.retina && this.options[name + 'RetinaUrl'] || this.options[name + 'Url'];
- }
-});
+ this.wmsParams = wmsParams;
+ },
+ onAdd: function (map) {
-// @factory L.icon(options: Icon options)
-// Creates an icon instance with the given options.
-L.icon = function (options) {
- return new L.Icon(options);
-};
+ this._crs = this.options.crs || map.options.crs;
+ this._wmsVersion = parseFloat(this.wmsParams.version);
+ var projectionKey = this._wmsVersion >= 1.3 ? 'crs' : 'srs';
+ this.wmsParams[projectionKey] = this._crs.code;
+ L.TileLayer.prototype.onAdd.call(this, map);
+ },
-/*
- * @miniclass Icon.Default (Icon)
- * @aka L.Icon.Default
- * @section
- *
- * A trivial subclass of `Icon`, represents the icon to use in `Marker`s when
- * no icon is specified. Points to the blue marker image distributed with Leaflet
- * releases.
- *
- * In order to change the default icon, just change the properties of `L.Icon.Default.prototype.options`
- * (which is a set of `Icon options`).
- */
+ getTileUrl: function (coords) {
-L.Icon.Default = L.Icon.extend({
+ var tileBounds = this._tileCoordsToBounds(coords),
+ nw = this._crs.project(tileBounds.getNorthWest()),
+ se = this._crs.project(tileBounds.getSouthEast()),
- options: {
- iconUrl: 'marker-icon.png',
- iconRetinaUrl: 'marker-icon-2x.png',
- shadowUrl: 'marker-shadow.png',
- iconSize: [25, 41],
- iconAnchor: [12, 41],
- popupAnchor: [1, -34],
- tooltipAnchor: [16, -28],
- shadowSize: [41, 41]
- },
+ bbox = (this._wmsVersion >= 1.3 && this._crs === L.CRS.EPSG4326 ?
+ [se.y, nw.x, nw.y, se.x] :
+ [nw.x, se.y, se.x, nw.y]).join(','),
- _getIconUrl: function (name) {
- if (!L.Icon.Default.imagePath) { // Deprecated, backwards-compatibility only
- L.Icon.Default.imagePath = this._detectIconPath();
- }
+ url = L.TileLayer.prototype.getTileUrl.call(this, coords);
- // @option imagePath: String
- // `L.Icon.Default` will try to auto-detect the absolute location of the
- // blue icon images. If you are placing these images in a non-standard
- // way, set this option to point to the right absolute path.
- return (this.options.imagePath || L.Icon.Default.imagePath) + L.Icon.prototype._getIconUrl.call(this, name);
+ return url +
+ L.Util.getParamString(this.wmsParams, url, this.options.uppercase) +
+ (this.options.uppercase ? '&BBOX=' : '&bbox=') + bbox;
},
- _detectIconPath: function () {
- var el = L.DomUtil.create('div', 'leaflet-default-icon-path', document.body);
- var path = L.DomUtil.getStyle(el, 'background-image') ||
- L.DomUtil.getStyle(el, 'backgroundImage'); // IE8
+ // @method setParams(params: Object, noRedraw?: Boolean): this
+ // Merges an object with the new parameters and re-requests tiles on the current screen (unless `noRedraw` was set to true).
+ setParams: function (params, noRedraw) {
- document.body.removeChild(el);
+ L.extend(this.wmsParams, params);
- return path.indexOf('url') === 0 ?
- path.replace(/^url\([\"\']?/, '').replace(/marker-icon\.png[\"\']?\)$/, '') : '';
+ if (!noRedraw) {
+ this.redraw();
+ }
+
+ return this;
}
});
+// @factory L.tileLayer.wms(baseUrl: String, options: TileLayer.WMS options)
+// Instantiates a WMS tile layer object given a base URL of the WMS service and a WMS parameters/options object.
+L.tileLayer.wms = function (url, options) {
+ return new L.TileLayer.WMS(url, options);
+};
+
+
/*
- * @class Marker
+ * @class ImageOverlay
+ * @aka L.ImageOverlay
* @inherits Interactive layer
- * @aka L.Marker
- * L.Marker is used to display clickable/draggable icons on the map. Extends `Layer`.
+ *
+ * Used to load and display a single image over specific bounds of the map. Extends `Layer`.
*
* @example
*
* ```js
- * L.marker([50.5, 30.5]).addTo(map);
+ * var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
+ * imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
+ * L.imageOverlay(imageUrl, imageBounds).addTo(map);
* ```
*/
-L.Marker = L.Layer.extend({
+L.ImageOverlay = L.Layer.extend({
// @section
- // @aka Marker options
+ // @aka ImageOverlay options
options: {
- // @option icon: Icon = *
- // Icon class to use for rendering the marker. See [Icon documentation](#L.Icon) for details on how to customize the marker icon. If not specified, a new `L.Icon.Default` is used.
- icon: new L.Icon.Default(),
+ // @option opacity: Number = 1.0
+ // The opacity of the image overlay.
+ opacity: 1,
- // Option inherited from "Interactive layer" abstract class
- interactive: true,
+ // @option alt: String = ''
+ // Text for the `alt` attribute of the image (useful for accessibility).
+ alt: '',
- // @option draggable: Boolean = false
- // Whether the marker is draggable with mouse/touch or not.
- draggable: false,
-
- // @option keyboard: Boolean = true
- // Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.
- keyboard: true,
-
- // @option title: String = ''
- // Text for the browser tooltip that appear on marker hover (no tooltip by default).
- title: '',
-
- // @option alt: String = ''
- // Text for the `alt` attribute of the icon image (useful for accessibility).
- alt: '',
-
- // @option zIndexOffset: Number = 0
- // By default, marker images zIndex is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like `1000` (or high negative value, respectively).
- zIndexOffset: 0,
-
- // @option opacity: Number = 1.0
- // The opacity of the marker.
- opacity: 1,
-
- // @option riseOnHover: Boolean = false
- // If `true`, the marker will get on top of others when you hover the mouse over it.
- riseOnHover: false,
-
- // @option riseOffset: Number = 250
- // The z-index offset used for the `riseOnHover` feature.
- riseOffset: 250,
-
- // @option pane: String = 'markerPane'
- // `Map pane` where the markers icon will be added.
- pane: 'markerPane',
+ // @option interactive: Boolean = false
+ // If `true`, the image overlay will emit [mouse events](#interactive-layer) when clicked or hovered.
+ interactive: false,
- // FIXME: shadowPane is no longer a valid option
- nonBubblingEvents: ['click', 'dblclick', 'mouseover', 'mouseout', 'contextmenu']
+ // @option crossOrigin: Boolean = false
+ // If true, the image will have its crossOrigin attribute set to ''. This is needed if you want to access image pixel data.
+ crossOrigin: false
},
- /* @section
- *
- * In addition to [shared layer methods](#Layer) like `addTo()` and `remove()` and [popup methods](#Popup) like bindPopup() you can also use the following methods:
- */
+ initialize: function (url, bounds, options) { // (String, LatLngBounds, Object)
+ this._url = url;
+ this._bounds = L.latLngBounds(bounds);
- initialize: function (latlng, options) {
L.setOptions(this, options);
- this._latlng = L.latLng(latlng);
},
- onAdd: function (map) {
- this._zoomAnimated = this._zoomAnimated && map.options.markerZoomAnimation;
-
- if (this._zoomAnimated) {
- map.on('zoomanim', this._animateZoom, this);
- }
-
- this._initIcon();
- this.update();
- },
+ onAdd: function () {
+ if (!this._image) {
+ this._initImage();
- onRemove: function (map) {
- if (this.dragging && this.dragging.enabled()) {
- this.options.draggable = true;
- this.dragging.removeHooks();
+ if (this.options.opacity < 1) {
+ this._updateOpacity();
+ }
}
- if (this._zoomAnimated) {
- map.off('zoomanim', this._animateZoom, this);
+ if (this.options.interactive) {
+ L.DomUtil.addClass(this._image, 'leaflet-interactive');
+ this.addInteractiveTarget(this._image);
}
- this._removeIcon();
- this._removeShadow();
- },
-
- getEvents: function () {
- return {
- zoom: this.update,
- viewreset: this.update
- };
+ this.getPane().appendChild(this._image);
+ this._reset();
},
- // @method getLatLng: LatLng
- // Returns the current geographical position of the marker.
- getLatLng: function () {
- return this._latlng;
+ onRemove: function () {
+ L.DomUtil.remove(this._image);
+ if (this.options.interactive) {
+ this.removeInteractiveTarget(this._image);
+ }
},
- // @method setLatLng(latlng: LatLng): this
- // Changes the marker position to the given point.
- setLatLng: function (latlng) {
- var oldLatLng = this._latlng;
- this._latlng = L.latLng(latlng);
- this.update();
+ // @method setOpacity(opacity: Number): this
+ // Sets the opacity of the overlay.
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
- // @event move: Event
- // Fired when the marker is moved via [`setLatLng`](#marker-setlatlng) or by [dragging](#marker-dragging). Old and new coordinates are included in event arguments as `oldLatLng`, `latlng`.
- return this.fire('move', {oldLatLng: oldLatLng, latlng: this._latlng});
+ if (this._image) {
+ this._updateOpacity();
+ }
+ return this;
},
- // @method setZIndexOffset(offset: Number): this
- // Changes the [zIndex offset](#marker-zindexoffset) of the marker.
- setZIndexOffset: function (offset) {
- this.options.zIndexOffset = offset;
- return this.update();
+ setStyle: function (styleOpts) {
+ if (styleOpts.opacity) {
+ this.setOpacity(styleOpts.opacity);
+ }
+ return this;
},
- // @method setIcon(icon: Icon): this
- // Changes the marker icon.
- setIcon: function (icon) {
-
- this.options.icon = icon;
-
+ // @method bringToFront(): this
+ // Brings the layer to the top of all overlays.
+ bringToFront: function () {
if (this._map) {
- this._initIcon();
- this.update();
- }
-
- if (this._popup) {
- this.bindPopup(this._popup, this._popup.options);
+ L.DomUtil.toFront(this._image);
}
-
return this;
},
- getElement: function () {
- return this._icon;
+ // @method bringToBack(): this
+ // Brings the layer to the bottom of all overlays.
+ bringToBack: function () {
+ if (this._map) {
+ L.DomUtil.toBack(this._image);
+ }
+ return this;
},
- update: function () {
+ // @method setUrl(url: String): this
+ // Changes the URL of the image.
+ setUrl: function (url) {
+ this._url = url;
- if (this._icon) {
- var pos = this._map.latLngToLayerPoint(this._latlng).round();
- this._setPos(pos);
+ if (this._image) {
+ this._image.src = url;
}
-
return this;
},
- _initIcon: function () {
- var options = this.options,
- classToAdd = 'leaflet-zoom-' + (this._zoomAnimated ? 'animated' : 'hide');
-
- var icon = options.icon.createIcon(this._icon),
- addIcon = false;
-
- // if we're not reusing the icon, remove the old one and init new one
- if (icon !== this._icon) {
- if (this._icon) {
- this._removeIcon();
- }
- addIcon = true;
+ setBounds: function (bounds) {
+ this._bounds = bounds;
- if (options.title) {
- icon.title = options.title;
- }
- if (options.alt) {
- icon.alt = options.alt;
- }
+ if (this._map) {
+ this._reset();
}
+ return this;
+ },
- L.DomUtil.addClass(icon, classToAdd);
+ getEvents: function () {
+ var events = {
+ zoom: this._reset,
+ viewreset: this._reset
+ };
- if (options.keyboard) {
- icon.tabIndex = '0';
+ if (this._zoomAnimated) {
+ events.zoomanim = this._animateZoom;
}
- this._icon = icon;
+ return events;
+ },
- if (options.riseOnHover) {
- this.on({
- mouseover: this._bringToFront,
- mouseout: this._resetZIndex
- });
- }
+ getBounds: function () {
+ return this._bounds;
+ },
- var newShadow = options.icon.createShadow(this._shadow),
- addShadow = false;
+ getElement: function () {
+ return this._image;
+ },
- if (newShadow !== this._shadow) {
- this._removeShadow();
- addShadow = true;
- }
+ _initImage: function () {
+ var img = this._image = L.DomUtil.create('img',
+ 'leaflet-image-layer ' + (this._zoomAnimated ? 'leaflet-zoom-animated' : ''));
- if (newShadow) {
- L.DomUtil.addClass(newShadow, classToAdd);
- }
- this._shadow = newShadow;
+ img.onselectstart = L.Util.falseFn;
+ img.onmousemove = L.Util.falseFn;
+ img.onload = L.bind(this.fire, this, 'load');
- if (options.opacity < 1) {
- this._updateOpacity();
+ if (this.options.crossOrigin) {
+ img.crossOrigin = '';
}
-
- if (addIcon) {
- this.getPane().appendChild(this._icon);
- }
- this._initInteraction();
- if (newShadow && addShadow) {
- this.getPane('shadowPane').appendChild(this._shadow);
- }
+ img.src = this._url;
+ img.alt = this.options.alt;
},
- _removeIcon: function () {
- if (this.options.riseOnHover) {
- this.off({
- mouseover: this._bringToFront,
- mouseout: this._resetZIndex
- });
- }
-
- L.DomUtil.remove(this._icon);
- this.removeInteractiveTarget(this._icon);
+ _animateZoom: function (e) {
+ var scale = this._map.getZoomScale(e.zoom),
+ offset = this._map._latLngBoundsToNewLayerBounds(this._bounds, e.zoom, e.center).min;
- this._icon = null;
+ L.DomUtil.setTransform(this._image, offset, scale);
},
- _removeShadow: function () {
- if (this._shadow) {
- L.DomUtil.remove(this._shadow);
- }
- this._shadow = null;
- },
+ _reset: function () {
+ var image = this._image,
+ bounds = new L.Bounds(
+ this._map.latLngToLayerPoint(this._bounds.getNorthWest()),
+ this._map.latLngToLayerPoint(this._bounds.getSouthEast())),
+ size = bounds.getSize();
- _setPos: function (pos) {
- L.DomUtil.setPosition(this._icon, pos);
+ L.DomUtil.setPosition(image, bounds.min);
- if (this._shadow) {
- L.DomUtil.setPosition(this._shadow, pos);
- }
+ image.style.width = size.x + 'px';
+ image.style.height = size.y + 'px';
+ },
- this._zIndex = pos.y + this.options.zIndexOffset;
+ _updateOpacity: function () {
+ L.DomUtil.setOpacity(this._image, this.options.opacity);
+ }
+});
- this._resetZIndex();
- },
+// @factory L.imageOverlay(imageUrl: String, bounds: LatLngBounds, options?: ImageOverlay options)
+// Instantiates an image overlay object given the URL of the image and the
+// geographical bounds it is tied to.
+L.imageOverlay = function (url, bounds, options) {
+ return new L.ImageOverlay(url, bounds, options);
+};
- _updateZIndex: function (offset) {
- this._icon.style.zIndex = this._zIndex + offset;
- },
- _animateZoom: function (opt) {
- var pos = this._map._latLngToNewLayerPoint(this._latlng, opt.zoom, opt.center).round();
- this._setPos(pos);
- },
+/*
+ * @class Icon
+ * @aka L.Icon
+ * @inherits Layer
+ *
+ * Represents an icon to provide when creating a marker.
+ *
+ * @example
+ *
+ * ```js
+ * var myIcon = L.icon({
+ * iconUrl: 'my-icon.png',
+ * iconRetinaUrl: 'my-icon@2x.png',
+ * iconSize: [38, 95],
+ * iconAnchor: [22, 94],
+ * popupAnchor: [-3, -76],
+ * shadowUrl: 'my-icon-shadow.png',
+ * shadowRetinaUrl: 'my-icon-shadow@2x.png',
+ * shadowSize: [68, 95],
+ * shadowAnchor: [22, 94]
+ * });
+ *
+ * L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
+ * ```
+ *
+ * `L.Icon.Default` extends `L.Icon` and is the blue icon Leaflet uses for markers by default.
+ *
+ */
- _initInteraction: function () {
+L.Icon = L.Class.extend({
- if (!this.options.interactive) { return; }
+ /* @section
+ * @aka Icon options
+ *
+ * @option iconUrl: String = null
+ * **(required)** The URL to the icon image (absolute or relative to your script path).
+ *
+ * @option iconRetinaUrl: String = null
+ * The URL to a retina sized version of the icon image (absolute or relative to your
+ * script path). Used for Retina screen devices.
+ *
+ * @option iconSize: Point = null
+ * Size of the icon image in pixels.
+ *
+ * @option iconAnchor: Point = null
+ * The coordinates of the "tip" of the icon (relative to its top left corner). The icon
+ * will be aligned so that this point is at the marker's geographical location. Centered
+ * by default if size is specified, also can be set in CSS with negative margins.
+ *
+ * @option popupAnchor: Point = null
+ * The coordinates of the point from which popups will "open", relative to the icon anchor.
+ *
+ * @option shadowUrl: String = null
+ * The URL to the icon shadow image. If not specified, no shadow image will be created.
+ *
+ * @option shadowRetinaUrl: String = null
+ *
+ * @option shadowSize: Point = null
+ * Size of the shadow image in pixels.
+ *
+ * @option shadowAnchor: Point = null
+ * The coordinates of the "tip" of the shadow (relative to its top left corner) (the same
+ * as iconAnchor if not specified).
+ *
+ * @option className: String = ''
+ * A custom class name to assign to both icon and shadow images. Empty by default.
+ */
- L.DomUtil.addClass(this._icon, 'leaflet-interactive');
+ initialize: function (options) {
+ L.setOptions(this, options);
+ },
- this.addInteractiveTarget(this._icon);
+ // @method createIcon(oldIcon?: HTMLElement): HTMLElement
+ // Called internally when the icon has to be shown, returns a `<img>` HTML element
+ // styled according to the options.
+ createIcon: function (oldIcon) {
+ return this._createIcon('icon', oldIcon);
+ },
- if (L.Handler.MarkerDrag) {
- var draggable = this.options.draggable;
- if (this.dragging) {
- draggable = this.dragging.enabled();
- this.dragging.disable();
- }
+ // @method createShadow(oldIcon?: HTMLElement): HTMLElement
+ // As `createIcon`, but for the shadow beneath it.
+ createShadow: function (oldIcon) {
+ return this._createIcon('shadow', oldIcon);
+ },
- this.dragging = new L.Handler.MarkerDrag(this);
+ _createIcon: function (name, oldIcon) {
+ var src = this._getIconUrl(name);
- if (draggable) {
- this.dragging.enable();
+ if (!src) {
+ if (name === 'icon') {
+ throw new Error('iconUrl not set in Icon options (see the docs).');
}
+ return null;
}
+
+ var img = this._createImg(src, oldIcon && oldIcon.tagName === 'IMG' ? oldIcon : null);
+ this._setIconStyles(img, name);
+
+ return img;
},
- // @method setOpacity(opacity: Number): this
- // Changes the opacity of the marker.
- setOpacity: function (opacity) {
- this.options.opacity = opacity;
- if (this._map) {
- this._updateOpacity();
+ _setIconStyles: function (img, name) {
+ var options = this.options;
+ var sizeOption = options[name + 'Size'];
+
+ if (typeof sizeOption === 'number') {
+ sizeOption = [sizeOption, sizeOption];
}
- return this;
- },
+ var size = L.point(sizeOption),
+ anchor = L.point(name === 'shadow' && options.shadowAnchor || options.iconAnchor ||
+ size && size.divideBy(2, true));
- _updateOpacity: function () {
- var opacity = this.options.opacity;
+ img.className = 'leaflet-marker-' + name + ' ' + (options.className || '');
- L.DomUtil.setOpacity(this._icon, opacity);
+ if (anchor) {
+ img.style.marginLeft = (-anchor.x) + 'px';
+ img.style.marginTop = (-anchor.y) + 'px';
+ }
- if (this._shadow) {
- L.DomUtil.setOpacity(this._shadow, opacity);
+ if (size) {
+ img.style.width = size.x + 'px';
+ img.style.height = size.y + 'px';
}
},
- _bringToFront: function () {
- this._updateZIndex(this.options.riseOffset);
+ _createImg: function (src, el) {
+ el = el || document.createElement('img');
+ el.src = src;
+ return el;
},
- _resetZIndex: function () {
- this._updateZIndex(0);
+ _getIconUrl: function (name) {
+ return L.Browser.retina && this.options[name + 'RetinaUrl'] || this.options[name + 'Url'];
}
});
-// factory L.marker(latlng: LatLng, options? : Marker options)
-
-// @factory L.marker(latlng: LatLng, options? : Marker options)
-// Instantiates a Marker object given a geographical point and optionally an options object.
-L.marker = function (latlng, options) {
- return new L.Marker(latlng, options);
+// @factory L.icon(options: Icon options)
+// Creates an icon instance with the given options.
+L.icon = function (options) {
+ return new L.Icon(options);
};
/*
- * @class DivIcon
- * @aka L.DivIcon
- * @inherits Icon
- *
- * Represents a lightweight icon for markers that uses a simple `<div>`
- * element instead of an image. Inherits from `Icon` but ignores the `iconUrl` and shadow options.
+ * @miniclass Icon.Default (Icon)
+ * @aka L.Icon.Default
+ * @section
*
- * @example
- * ```js
- * var myIcon = L.divIcon({className: 'my-div-icon'});
- * // you can set .my-div-icon styles in CSS
+ * A trivial subclass of `Icon`, represents the icon to use in `Marker`s when
+ * no icon is specified. Points to the blue marker image distributed with Leaflet
+ * releases.
*
- * L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
- * ```
+ * In order to customize the default icon, just change the properties of `L.Icon.Default.prototype.options`
+ * (which is a set of `Icon options`).
*
- * By default, it has a 'leaflet-div-icon' CSS class and is styled as a little white square with a shadow.
+ * If you want to _completely_ replace the default icon, override the
+ * `L.Marker.prototype.options.icon` with your own icon instead.
*/
-L.DivIcon = L.Icon.extend({
- options: {
- // @section
- // @aka DivIcon options
- iconSize: [12, 12], // also can be set through CSS
-
- // iconAnchor: (Point),
- // popupAnchor: (Point),
+L.Icon.Default = L.Icon.extend({
- // @option html: String = ''
- // Custom HTML code to put inside the div element, empty by default.
- html: false,
+ options: {
+ iconUrl: 'marker-icon.png',
+ iconRetinaUrl: 'marker-icon-2x.png',
+ shadowUrl: 'marker-shadow.png',
+ iconSize: [25, 41],
+ iconAnchor: [12, 41],
+ popupAnchor: [1, -34],
+ tooltipAnchor: [16, -28],
+ shadowSize: [41, 41]
+ },
- // @option bgPos: Point = [0, 0]
- // Optional relative position of the background, in pixels
- bgPos: null,
+ _getIconUrl: function (name) {
+ if (!L.Icon.Default.imagePath) { // Deprecated, backwards-compatibility only
+ L.Icon.Default.imagePath = this._detectIconPath();
+ }
- className: 'leaflet-div-icon'
+ // @option imagePath: String
+ // `L.Icon.Default` will try to auto-detect the absolute location of the
+ // blue icon images. If you are placing these images in a non-standard
+ // way, set this option to point to the right absolute path.
+ return (this.options.imagePath || L.Icon.Default.imagePath) + L.Icon.prototype._getIconUrl.call(this, name);
},
- createIcon: function (oldIcon) {
- var div = (oldIcon && oldIcon.tagName === 'DIV') ? oldIcon : document.createElement('div'),
- options = this.options;
+ _detectIconPath: function () {
+ var el = L.DomUtil.create('div', 'leaflet-default-icon-path', document.body);
+ var path = L.DomUtil.getStyle(el, 'background-image') ||
+ L.DomUtil.getStyle(el, 'backgroundImage'); // IE8
- div.innerHTML = options.html !== false ? options.html : '';
+ document.body.removeChild(el);
- if (options.bgPos) {
- var bgPos = L.point(options.bgPos);
- div.style.backgroundPosition = (-bgPos.x) + 'px ' + (-bgPos.y) + 'px';
- }
- this._setIconStyles(div, 'icon');
-
- return div;
- },
-
- createShadow: function () {
- return null;
+ return path.indexOf('url') === 0 ?
+ path.replace(/^url\([\"\']?/, '').replace(/marker-icon\.png[\"\']?\)$/, '') : '';
}
});
-// @factory L.divIcon(options: DivIcon options)
-// Creates a `DivIcon` instance with the given options.
-L.divIcon = function (options) {
- return new L.DivIcon(options);
-};
-
/*
- * @class DivOverlay
- * @inherits Layer
- * @aka L.DivOverlay
- * Base model for L.Popup and L.Tooltip. Inherit from it for custom popup like plugins.
+ * @class Marker
+ * @inherits Interactive layer
+ * @aka L.Marker
+ * L.Marker is used to display clickable/draggable icons on the map. Extends `Layer`.
+ *
+ * @example
+ *
+ * ```js
+ * L.marker([50.5, 30.5]).addTo(map);
+ * ```
*/
-// @namespace DivOverlay
-L.DivOverlay = L.Layer.extend({
+L.Marker = L.Layer.extend({
// @section
- // @aka DivOverlay options
+ // @aka Marker options
options: {
- // @option offset: Point = Point(0, 7)
- // The offset of the popup position. Useful to control the anchor
- // of the popup when opening it on some overlays.
- offset: [0, 7],
+ // @option icon: Icon = *
+ // Icon class to use for rendering the marker. See [Icon documentation](#L.Icon) for details on how to customize the marker icon. If not specified, a new `L.Icon.Default` is used.
+ icon: new L.Icon.Default(),
- // @option className: String = ''
- // A custom CSS class name to assign to the popup.
- className: '',
+ // Option inherited from "Interactive layer" abstract class
+ interactive: true,
- // @option pane: String = 'popupPane'
- // `Map pane` where the popup will be added.
- pane: 'popupPane'
+ // @option draggable: Boolean = false
+ // Whether the marker is draggable with mouse/touch or not.
+ draggable: false,
+
+ // @option keyboard: Boolean = true
+ // Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.
+ keyboard: true,
+
+ // @option title: String = ''
+ // Text for the browser tooltip that appear on marker hover (no tooltip by default).
+ title: '',
+
+ // @option alt: String = ''
+ // Text for the `alt` attribute of the icon image (useful for accessibility).
+ alt: '',
+
+ // @option zIndexOffset: Number = 0
+ // By default, marker images zIndex is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like `1000` (or high negative value, respectively).
+ zIndexOffset: 0,
+
+ // @option opacity: Number = 1.0
+ // The opacity of the marker.
+ opacity: 1,
+
+ // @option riseOnHover: Boolean = false
+ // If `true`, the marker will get on top of others when you hover the mouse over it.
+ riseOnHover: false,
+
+ // @option riseOffset: Number = 250
+ // The z-index offset used for the `riseOnHover` feature.
+ riseOffset: 250,
+
+ // @option pane: String = 'markerPane'
+ // `Map pane` where the markers icon will be added.
+ pane: 'markerPane',
+
+ // FIXME: shadowPane is no longer a valid option
+ nonBubblingEvents: ['click', 'dblclick', 'mouseover', 'mouseout', 'contextmenu']
},
- initialize: function (options, source) {
- L.setOptions(this, options);
+ /* @section
+ *
+ * In addition to [shared layer methods](#Layer) like `addTo()` and `remove()` and [popup methods](#Popup) like bindPopup() you can also use the following methods:
+ */
- this._source = source;
+ initialize: function (latlng, options) {
+ L.setOptions(this, options);
+ this._latlng = L.latLng(latlng);
},
onAdd: function (map) {
- this._zoomAnimated = map._zoomAnimated;
-
- if (!this._container) {
- this._initLayout();
- }
+ this._zoomAnimated = this._zoomAnimated && map.options.markerZoomAnimation;
- if (map._fadeAnimated) {
- L.DomUtil.setOpacity(this._container, 0);
+ if (this._zoomAnimated) {
+ map.on('zoomanim', this._animateZoom, this);
}
- clearTimeout(this._removeTimeout);
- this.getPane().appendChild(this._container);
+ this._initIcon();
this.update();
+ },
- if (map._fadeAnimated) {
- L.DomUtil.setOpacity(this._container, 1);
+ onRemove: function (map) {
+ if (this.dragging && this.dragging.enabled()) {
+ this.options.draggable = true;
+ this.dragging.removeHooks();
}
- this.bringToFront();
+ if (this._zoomAnimated) {
+ map.off('zoomanim', this._animateZoom, this);
+ }
+
+ this._removeIcon();
+ this._removeShadow();
},
- onRemove: function (map) {
- if (map._fadeAnimated) {
- L.DomUtil.setOpacity(this._container, 0);
- this._removeTimeout = setTimeout(L.bind(L.DomUtil.remove, L.DomUtil, this._container), 200);
- } else {
- L.DomUtil.remove(this._container);
- }
+ getEvents: function () {
+ return {
+ zoom: this.update,
+ viewreset: this.update
+ };
},
- // @namespace Popup
// @method getLatLng: LatLng
- // Returns the geographical point of popup.
+ // Returns the current geographical position of the marker.
getLatLng: function () {
return this._latlng;
},
// @method setLatLng(latlng: LatLng): this
- // Sets the geographical point where the popup will open.
+ // Changes the marker position to the given point.
setLatLng: function (latlng) {
+ var oldLatLng = this._latlng;
this._latlng = L.latLng(latlng);
- if (this._map) {
- this._updatePosition();
- this._adjustPan();
- }
- return this;
- },
-
- // @method getContent: String|HTMLElement
- // Returns the content of the popup.
- getContent: function () {
- return this._content;
- },
-
- // @method setContent(htmlContent: String|HTMLElement|Function): this
- // Sets the HTML content of the popup. If a function is passed the source layer will be passed to the function. The function should return a `String` or `HTMLElement` to be used in the popup.
- setContent: function (content) {
- this._content = content;
this.update();
- return this;
+
+ // @event move: Event
+ // Fired when the marker is moved via [`setLatLng`](#marker-setlatlng) or by [dragging](#marker-dragging). Old and new coordinates are included in event arguments as `oldLatLng`, `latlng`.
+ return this.fire('move', {oldLatLng: oldLatLng, latlng: this._latlng});
},
- // @method getElement: String|HTMLElement
- // Alias for [getContent()](#popup-getcontent)
- getElement: function () {
- return this._container;
+ // @method setZIndexOffset(offset: Number): this
+ // Changes the [zIndex offset](#marker-zindexoffset) of the marker.
+ setZIndexOffset: function (offset) {
+ this.options.zIndexOffset = offset;
+ return this.update();
},
- // @method update: null
- // Updates the popup content, layout and position. Useful for updating the popup after something inside changed, e.g. image loaded.
- update: function () {
- if (!this._map) { return; }
+ // @method setIcon(icon: Icon): this
+ // Changes the marker icon.
+ setIcon: function (icon) {
- this._container.style.visibility = 'hidden';
+ this.options.icon = icon;
- this._updateContent();
- this._updateLayout();
- this._updatePosition();
+ if (this._map) {
+ this._initIcon();
+ this.update();
+ }
- this._container.style.visibility = '';
+ if (this._popup) {
+ this.bindPopup(this._popup, this._popup.options);
+ }
- this._adjustPan();
+ return this;
},
- getEvents: function () {
- var events = {
- zoom: this._updatePosition,
- viewreset: this._updatePosition
- };
-
- if (this._zoomAnimated) {
- events.zoomanim = this._animateZoom;
- }
- return events;
+ getElement: function () {
+ return this._icon;
},
- // @method isOpen: Boolean
- // Returns `true` when the popup is visible on the map.
- isOpen: function () {
- return !!this._map && this._map.hasLayer(this);
- },
+ update: function () {
- // @method bringToFront: this
- // Brings this popup in front of other popups (in the same map pane).
- bringToFront: function () {
- if (this._map) {
- L.DomUtil.toFront(this._container);
+ if (this._icon) {
+ var pos = this._map.latLngToLayerPoint(this._latlng).round();
+ this._setPos(pos);
}
- return this;
- },
- // @method bringToBack: this
- // Brings this popup to the back of other popups (in the same map pane).
- bringToBack: function () {
- if (this._map) {
- L.DomUtil.toBack(this._container);
- }
return this;
},
- _updateContent: function () {
- if (!this._content) { return; }
+ _initIcon: function () {
+ var options = this.options,
+ classToAdd = 'leaflet-zoom-' + (this._zoomAnimated ? 'animated' : 'hide');
- var node = this._contentNode;
- var content = (typeof this._content === 'function') ? this._content(this._source || this) : this._content;
+ var icon = options.icon.createIcon(this._icon),
+ addIcon = false;
- if (typeof content === 'string') {
- node.innerHTML = content;
- } else {
- while (node.hasChildNodes()) {
- node.removeChild(node.firstChild);
+ // if we're not reusing the icon, remove the old one and init new one
+ if (icon !== this._icon) {
+ if (this._icon) {
+ this._removeIcon();
}
- node.appendChild(content);
- }
- this.fire('contentupdate');
- },
+ addIcon = true;
- _updatePosition: function () {
- if (!this._map) { return; }
+ if (options.title) {
+ icon.title = options.title;
+ }
+ if (options.alt) {
+ icon.alt = options.alt;
+ }
+ }
- var pos = this._map.latLngToLayerPoint(this._latlng),
- offset = L.point(this.options.offset),
- anchor = this._getAnchor();
+ L.DomUtil.addClass(icon, classToAdd);
- if (this._zoomAnimated) {
- L.DomUtil.setPosition(this._container, pos.add(anchor));
- } else {
- offset = offset.add(pos).add(anchor);
+ if (options.keyboard) {
+ icon.tabIndex = '0';
}
- var bottom = this._containerBottom = -offset.y,
- left = this._containerLeft = -Math.round(this._containerWidth / 2) + offset.x;
+ this._icon = icon;
- // bottom position the popup in case the height of the popup changes (images loading etc)
- this._container.style.bottom = bottom + 'px';
- this._container.style.left = left + 'px';
- },
+ if (options.riseOnHover) {
+ this.on({
+ mouseover: this._bringToFront,
+ mouseout: this._resetZIndex
+ });
+ }
- _getAnchor: function () {
- return [0, 0];
- }
+ var newShadow = options.icon.createShadow(this._shadow),
+ addShadow = false;
-});
+ if (newShadow !== this._shadow) {
+ this._removeShadow();
+ addShadow = true;
+ }
+ if (newShadow) {
+ L.DomUtil.addClass(newShadow, classToAdd);
+ }
+ this._shadow = newShadow;
-/*
- * @class Popup
- * @inherits DivOverlay
- * @aka L.Popup
- * Used to open popups in certain places of the map. Use [Map.openPopup](#map-openpopup) to
- * open popups while making sure that only one popup is open at one time
- * (recommended for usability), or use [Map.addLayer](#map-addlayer) to open as many as you want.
- *
- * @example
- *
- * If you want to just bind a popup to marker click and then open it, it's really easy:
- *
- * ```js
- * marker.bindPopup(popupContent).openPopup();
- * ```
- * Path overlays like polylines also have a `bindPopup` method.
- * Here's a more complicated way to open a popup on a map:
- *
- * ```js
- * var popup = L.popup()
- * .setLatLng(latlng)
- * .setContent('<p>Hello world!<br />This is a nice popup.</p>')
- * .openOn(map);
- * ```
- */
+ if (options.opacity < 1) {
+ this._updateOpacity();
+ }
-// @namespace Popup
-L.Popup = L.DivOverlay.extend({
+ if (addIcon) {
+ this.getPane().appendChild(this._icon);
+ }
+ this._initInteraction();
+ if (newShadow && addShadow) {
+ this.getPane('shadowPane').appendChild(this._shadow);
+ }
+ },
- // @section
- // @aka Popup options
- options: {
- // @option maxWidth: Number = 300
- // Max width of the popup, in pixels.
- maxWidth: 300,
+ _removeIcon: function () {
+ if (this.options.riseOnHover) {
+ this.off({
+ mouseover: this._bringToFront,
+ mouseout: this._resetZIndex
+ });
+ }
- // @option minWidth: Number = 50
- // Min width of the popup, in pixels.
- minWidth: 50,
+ L.DomUtil.remove(this._icon);
+ this.removeInteractiveTarget(this._icon);
- // @option maxHeight: Number = null
- // If set, creates a scrollable container of the given height
- // inside a popup if its content exceeds it.
- maxHeight: null,
+ this._icon = null;
+ },
- // @option autoPan: Boolean = true
- // Set it to `false` if you don't want the map to do panning animation
- // to fit the opened popup.
- autoPan: true,
+ _removeShadow: function () {
+ if (this._shadow) {
+ L.DomUtil.remove(this._shadow);
+ }
+ this._shadow = null;
+ },
- // @option autoPanPaddingTopLeft: Point = null
- // The margin between the popup and the top left corner of the map
- // view after autopanning was performed.
- autoPanPaddingTopLeft: null,
+ _setPos: function (pos) {
+ L.DomUtil.setPosition(this._icon, pos);
- // @option autoPanPaddingBottomRight: Point = null
- // The margin between the popup and the bottom right corner of the map
- // view after autopanning was performed.
- autoPanPaddingBottomRight: null,
+ if (this._shadow) {
+ L.DomUtil.setPosition(this._shadow, pos);
+ }
- // @option autoPanPadding: Point = Point(5, 5)
- // Equivalent of setting both top left and bottom right autopan padding to the same value.
- autoPanPadding: [5, 5],
+ this._zIndex = pos.y + this.options.zIndexOffset;
- // @option keepInView: Boolean = false
- // Set it to `true` if you want to prevent users from panning the popup
- // off of the screen while it is open.
- keepInView: false,
+ this._resetZIndex();
+ },
- // @option closeButton: Boolean = true
- // Controls the presence of a close button in the popup.
- closeButton: true,
+ _updateZIndex: function (offset) {
+ this._icon.style.zIndex = this._zIndex + offset;
+ },
- // @option autoClose: Boolean = true
- // Set it to `false` if you want to override the default behavior of
- // the popup closing when user clicks the map (set globally by
- // the Map's [closePopupOnClick](#map-closepopuponclick) option).
- autoClose: true,
+ _animateZoom: function (opt) {
+ var pos = this._map._latLngToNewLayerPoint(this._latlng, opt.zoom, opt.center).round();
- // @option className: String = ''
- // A custom CSS class name to assign to the popup.
- className: ''
+ this._setPos(pos);
},
- // @namespace Popup
- // @method openOn(map: Map): this
- // Adds the popup to the map and closes the previous one. The same as `map.openPopup(popup)`.
- openOn: function (map) {
- map.openPopup(this);
- return this;
- },
+ _initInteraction: function () {
- onAdd: function (map) {
- L.DivOverlay.prototype.onAdd.call(this, map);
+ if (!this.options.interactive) { return; }
- // @namespace Map
- // @section Popup events
- // @event popupopen: PopupEvent
- // Fired when a popup is opened in the map
- map.fire('popupopen', {popup: this});
+ L.DomUtil.addClass(this._icon, 'leaflet-interactive');
- if (this._source) {
- // @namespace Layer
- // @section Popup events
- // @event popupopen: PopupEvent
- // Fired when a popup bound to this layer is opened
- this._source.fire('popupopen', {popup: this}, true);
- // For non-path layers, we toggle the popup when clicking
- // again the layer, so prevent the map to reopen it.
- if (!(this._source instanceof L.Path)) {
- this._source.on('preclick', L.DomEvent.stopPropagation);
- }
- }
- },
+ this.addInteractiveTarget(this._icon);
- onRemove: function (map) {
- L.DivOverlay.prototype.onRemove.call(this, map);
+ if (L.Handler.MarkerDrag) {
+ var draggable = this.options.draggable;
+ if (this.dragging) {
+ draggable = this.dragging.enabled();
+ this.dragging.disable();
+ }
- // @namespace Map
- // @section Popup events
- // @event popupclose: PopupEvent
- // Fired when a popup in the map is closed
- map.fire('popupclose', {popup: this});
+ this.dragging = new L.Handler.MarkerDrag(this);
- if (this._source) {
- // @namespace Layer
- // @section Popup events
- // @event popupclose: PopupEvent
- // Fired when a popup bound to this layer is closed
- this._source.fire('popupclose', {popup: this}, true);
- if (!(this._source instanceof L.Path)) {
- this._source.off('preclick', L.DomEvent.stopPropagation);
+ if (draggable) {
+ this.dragging.enable();
}
}
},
- getEvents: function () {
- var events = L.DivOverlay.prototype.getEvents.call(this);
-
- if ('closeOnClick' in this.options ? this.options.closeOnClick : this._map.options.closePopupOnClick) {
- events.preclick = this._close;
- }
-
- if (this.options.keepInView) {
- events.moveend = this._adjustPan;
+ // @method setOpacity(opacity: Number): this
+ // Changes the opacity of the marker.
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
+ if (this._map) {
+ this._updateOpacity();
}
- return events;
+ return this;
},
- _close: function () {
- if (this._map) {
- this._map.closePopup(this);
+ _updateOpacity: function () {
+ var opacity = this.options.opacity;
+
+ L.DomUtil.setOpacity(this._icon, opacity);
+
+ if (this._shadow) {
+ L.DomUtil.setOpacity(this._shadow, opacity);
}
},
- _initLayout: function () {
- var prefix = 'leaflet-popup',
- container = this._container = L.DomUtil.create('div',
- prefix + ' ' + (this.options.className || '') +
- ' leaflet-zoom-animated');
+ _bringToFront: function () {
+ this._updateZIndex(this.options.riseOffset);
+ },
- if (this.options.closeButton) {
- var closeButton = this._closeButton = L.DomUtil.create('a', prefix + '-close-button', container);
- closeButton.href = '#close';
- closeButton.innerHTML = '×';
+ _resetZIndex: function () {
+ this._updateZIndex(0);
+ },
- L.DomEvent.on(closeButton, 'click', this._onCloseButtonClick, this);
- }
-
- var wrapper = this._wrapper = L.DomUtil.create('div', prefix + '-content-wrapper', container);
- this._contentNode = L.DomUtil.create('div', prefix + '-content', wrapper);
-
- L.DomEvent
- .disableClickPropagation(wrapper)
- .disableScrollPropagation(this._contentNode)
- .on(wrapper, 'contextmenu', L.DomEvent.stopPropagation);
-
- this._tipContainer = L.DomUtil.create('div', prefix + '-tip-container', container);
- this._tip = L.DomUtil.create('div', prefix + '-tip', this._tipContainer);
+ _getPopupAnchor: function () {
+ return this.options.icon.options.popupAnchor || [0, 0];
},
- _updateLayout: function () {
- var container = this._contentNode,
- style = container.style;
+ _getTooltipAnchor: function () {
+ return this.options.icon.options.tooltipAnchor || [0, 0];
+ }
+});
- style.width = '';
- style.whiteSpace = 'nowrap';
- var width = container.offsetWidth;
- width = Math.min(width, this.options.maxWidth);
- width = Math.max(width, this.options.minWidth);
+// factory L.marker(latlng: LatLng, options? : Marker options)
- style.width = (width + 1) + 'px';
- style.whiteSpace = '';
+// @factory L.marker(latlng: LatLng, options? : Marker options)
+// Instantiates a Marker object given a geographical point and optionally an options object.
+L.marker = function (latlng, options) {
+ return new L.Marker(latlng, options);
+};
- style.height = '';
- var height = container.offsetHeight,
- maxHeight = this.options.maxHeight,
- scrolledClass = 'leaflet-popup-scrolled';
- if (maxHeight && height > maxHeight) {
- style.height = maxHeight + 'px';
- L.DomUtil.addClass(container, scrolledClass);
- } else {
- L.DomUtil.removeClass(container, scrolledClass);
- }
+/*
+ * @class DivIcon
+ * @aka L.DivIcon
+ * @inherits Icon
+ *
+ * Represents a lightweight icon for markers that uses a simple `<div>`
+ * element instead of an image. Inherits from `Icon` but ignores the `iconUrl` and shadow options.
+ *
+ * @example
+ * ```js
+ * var myIcon = L.divIcon({className: 'my-div-icon'});
+ * // you can set .my-div-icon styles in CSS
+ *
+ * L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
+ * ```
+ *
+ * By default, it has a 'leaflet-div-icon' CSS class and is styled as a little white square with a shadow.
+ */
- this._containerWidth = this._container.offsetWidth;
- },
+L.DivIcon = L.Icon.extend({
+ options: {
+ // @section
+ // @aka DivIcon options
+ iconSize: [12, 12], // also can be set through CSS
- _animateZoom: function (e) {
- var pos = this._map._latLngToNewLayerPoint(this._latlng, e.zoom, e.center),
- anchor = this._getAnchor();
- L.DomUtil.setPosition(this._container, pos.add(anchor));
- },
+ // iconAnchor: (Point),
+ // popupAnchor: (Point),
- _adjustPan: function () {
- if (!this.options.autoPan || (this._map._panAnim && this._map._panAnim._inProgress)) { return; }
+ // @option html: String = ''
+ // Custom HTML code to put inside the div element, empty by default.
+ html: false,
- var map = this._map,
- marginBottom = parseInt(L.DomUtil.getStyle(this._container, 'marginBottom'), 10) || 0,
- containerHeight = this._container.offsetHeight + marginBottom,
- containerWidth = this._containerWidth,
- layerPos = new L.Point(this._containerLeft, -containerHeight - this._containerBottom);
+ // @option bgPos: Point = [0, 0]
+ // Optional relative position of the background, in pixels
+ bgPos: null,
- layerPos._add(L.DomUtil.getPosition(this._container));
+ className: 'leaflet-div-icon'
+ },
- var containerPos = map.layerPointToContainerPoint(layerPos),
- padding = L.point(this.options.autoPanPadding),
- paddingTL = L.point(this.options.autoPanPaddingTopLeft || padding),
- paddingBR = L.point(this.options.autoPanPaddingBottomRight || padding),
- size = map.getSize(),
- dx = 0,
- dy = 0;
+ createIcon: function (oldIcon) {
+ var div = (oldIcon && oldIcon.tagName === 'DIV') ? oldIcon : document.createElement('div'),
+ options = this.options;
- if (containerPos.x + containerWidth + paddingBR.x > size.x) { // right
- dx = containerPos.x + containerWidth - size.x + paddingBR.x;
- }
- if (containerPos.x - dx - paddingTL.x < 0) { // left
- dx = containerPos.x - paddingTL.x;
- }
- if (containerPos.y + containerHeight + paddingBR.y > size.y) { // bottom
- dy = containerPos.y + containerHeight - size.y + paddingBR.y;
- }
- if (containerPos.y - dy - paddingTL.y < 0) { // top
- dy = containerPos.y - paddingTL.y;
- }
+ div.innerHTML = options.html !== false ? options.html : '';
- // @namespace Map
- // @section Popup events
- // @event autopanstart: Event
- // Fired when the map starts autopanning when opening a popup.
- if (dx || dy) {
- map
- .fire('autopanstart')
- .panBy([dx, dy]);
+ if (options.bgPos) {
+ var bgPos = L.point(options.bgPos);
+ div.style.backgroundPosition = (-bgPos.x) + 'px ' + (-bgPos.y) + 'px';
}
- },
+ this._setIconStyles(div, 'icon');
- _onCloseButtonClick: function (e) {
- this._close();
- L.DomEvent.stop(e);
+ return div;
},
- _getAnchor: function () {
- // Where should we anchor the popup on the source layer?
- return L.point(this._source && this._source._getPopupAnchor ? this._source._getPopupAnchor() : [0, 0]);
+ createShadow: function () {
+ return null;
}
-
});
-// @namespace Popup
-// @factory L.popup(options?: Popup options, source?: Layer)
-// Instantiates a `Popup` object given an optional `options` object that describes its appearance and location and an optional `source` object that is used to tag the popup with a reference to the Layer to which it refers.
-L.popup = function (options, source) {
- return new L.Popup(options, source);
+// @factory L.divIcon(options: DivIcon options)
+// Creates a `DivIcon` instance with the given options.
+L.divIcon = function (options) {
+ return new L.DivIcon(options);
};
-/* @namespace Map
- * @section Interaction Options
- * @option closePopupOnClick: Boolean = true
- * Set it to `false` if you don't want popups to close when user clicks the map.
+
+/*
+ * @class DivOverlay
+ * @inherits Layer
+ * @aka L.DivOverlay
+ * Base model for L.Popup and L.Tooltip. Inherit from it for custom popup like plugins.
*/
-L.Map.mergeOptions({
- closePopupOnClick: true
-});
+// @namespace DivOverlay
+L.DivOverlay = L.Layer.extend({
-// @namespace Map
-// @section Methods for Layers and Controls
-L.Map.include({
- // @method openPopup(popup: Popup): this
- // Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).
- // @alternative
- // @method openPopup(content: String|HTMLElement, latlng: LatLng, options?: Popup options): this
- // Creates a popup with the specified content and options and opens it in the given point on a map.
- openPopup: function (popup, latlng, options) {
- if (!(popup instanceof L.Popup)) {
- popup = new L.Popup(options).setContent(popup);
- }
+ // @section
+ // @aka DivOverlay options
+ options: {
+ // @option offset: Point = Point(0, 7)
+ // The offset of the popup position. Useful to control the anchor
+ // of the popup when opening it on some overlays.
+ offset: [0, 7],
- if (latlng) {
- popup.setLatLng(latlng);
+ // @option className: String = ''
+ // A custom CSS class name to assign to the popup.
+ className: '',
+
+ // @option pane: String = 'popupPane'
+ // `Map pane` where the popup will be added.
+ pane: 'popupPane'
+ },
+
+ initialize: function (options, source) {
+ L.setOptions(this, options);
+
+ this._source = source;
+ },
+
+ onAdd: function (map) {
+ this._zoomAnimated = map._zoomAnimated;
+
+ if (!this._container) {
+ this._initLayout();
}
- if (this.hasLayer(popup)) {
- return this;
+ if (map._fadeAnimated) {
+ L.DomUtil.setOpacity(this._container, 0);
}
- if (this._popup && this._popup.options.autoClose) {
- this.closePopup();
+ clearTimeout(this._removeTimeout);
+ this.getPane().appendChild(this._container);
+ this.update();
+
+ if (map._fadeAnimated) {
+ L.DomUtil.setOpacity(this._container, 1);
}
- this._popup = popup;
- return this.addLayer(popup);
+ this.bringToFront();
},
- // @method closePopup(popup?: Popup): this
- // Closes the popup previously opened with [openPopup](#map-openpopup) (or the given one).
- closePopup: function (popup) {
- if (!popup || popup === this._popup) {
- popup = this._popup;
- this._popup = null;
+ onRemove: function (map) {
+ if (map._fadeAnimated) {
+ L.DomUtil.setOpacity(this._container, 0);
+ this._removeTimeout = setTimeout(L.bind(L.DomUtil.remove, L.DomUtil, this._container), 200);
+ } else {
+ L.DomUtil.remove(this._container);
}
- if (popup) {
- this.removeLayer(popup);
+ },
+
+ // @namespace Popup
+ // @method getLatLng: LatLng
+ // Returns the geographical point of popup.
+ getLatLng: function () {
+ return this._latlng;
+ },
+
+ // @method setLatLng(latlng: LatLng): this
+ // Sets the geographical point where the popup will open.
+ setLatLng: function (latlng) {
+ this._latlng = L.latLng(latlng);
+ if (this._map) {
+ this._updatePosition();
+ this._adjustPan();
}
return this;
- }
-});
+ },
+ // @method getContent: String|HTMLElement
+ // Returns the content of the popup.
+ getContent: function () {
+ return this._content;
+ },
-
-/*
- * @namespace Layer
- * @section Popup methods example
- *
- * All layers share a set of methods convenient for binding popups to it.
- *
- * ```js
- * var layer = L.Polygon(latlngs).bindPopup('Hi There!').addTo(map);
- * layer.openPopup();
- * layer.closePopup();
- * ```
- *
- * Popups will also be automatically opened when the layer is clicked on and closed when the layer is removed from the map or another popup is opened.
- */
-
-// @section Popup methods
-L.Layer.include({
-
- // @method bindPopup(content: String|HTMLElement|Function|Popup, options?: Popup options): this
- // Binds a popup to the layer with the passed `content` and sets up the
- // neccessary event listeners. If a `Function` is passed it will receive
- // the layer as the first argument and should return a `String` or `HTMLElement`.
- bindPopup: function (content, options) {
-
- if (content instanceof L.Popup) {
- L.setOptions(content, options);
- this._popup = content;
- content._source = this;
- } else {
- if (!this._popup || options) {
- this._popup = new L.Popup(options, this);
- }
- this._popup.setContent(content);
- }
-
- if (!this._popupHandlersAdded) {
- this.on({
- click: this._openPopup,
- remove: this.closePopup,
- move: this._movePopup
- });
- this._popupHandlersAdded = true;
- }
-
+ // @method setContent(htmlContent: String|HTMLElement|Function): this
+ // Sets the HTML content of the popup. If a function is passed the source layer will be passed to the function. The function should return a `String` or `HTMLElement` to be used in the popup.
+ setContent: function (content) {
+ this._content = content;
+ this.update();
return this;
},
- // @method unbindPopup(): this
- // Removes the popup previously bound with `bindPopup`.
- unbindPopup: function () {
- if (this._popup) {
- this.off({
- click: this._openPopup,
- remove: this.closePopup,
- move: this._movePopup
- });
- this._popupHandlersAdded = false;
- this._popup = null;
- }
- return this;
+ // @method getElement: String|HTMLElement
+ // Alias for [getContent()](#popup-getcontent)
+ getElement: function () {
+ return this._container;
},
- // @method openPopup(latlng?: LatLng): this
- // Opens the bound popup at the specificed `latlng` or at the default popup anchor if no `latlng` is passed.
- openPopup: function (layer, latlng) {
- if (!(layer instanceof L.Layer)) {
- latlng = layer;
- layer = this;
- }
-
- if (layer instanceof L.FeatureGroup) {
- for (var id in this._layers) {
- layer = this._layers[id];
- break;
- }
- }
-
- if (!latlng) {
- latlng = layer.getCenter ? layer.getCenter() : layer.getLatLng();
- }
+ // @method update: null
+ // Updates the popup content, layout and position. Useful for updating the popup after something inside changed, e.g. image loaded.
+ update: function () {
+ if (!this._map) { return; }
- if (this._popup && this._map) {
- // set popup source to this layer
- this._popup._source = layer;
+ this._container.style.visibility = 'hidden';
- // update the popup (content, layout, ect...)
- this._popup.update();
+ this._updateContent();
+ this._updateLayout();
+ this._updatePosition();
- // open the popup on the map
- this._map.openPopup(this._popup, latlng);
- }
+ this._container.style.visibility = '';
- return this;
+ this._adjustPan();
},
- // @method closePopup(): this
- // Closes the popup bound to this layer if it is open.
- closePopup: function () {
- if (this._popup) {
- this._popup._close();
- }
- return this;
- },
+ getEvents: function () {
+ var events = {
+ zoom: this._updatePosition,
+ viewreset: this._updatePosition
+ };
- // @method togglePopup(): this
- // Opens or closes the popup bound to this layer depending on its current state.
- togglePopup: function (target) {
- if (this._popup) {
- if (this._popup._map) {
- this.closePopup();
- } else {
- this.openPopup(target);
- }
+ if (this._zoomAnimated) {
+ events.zoomanim = this._animateZoom;
}
- return this;
+ return events;
},
- // @method isPopupOpen(): boolean
- // Returns `true` if the popup bound to this layer is currently open.
- isPopupOpen: function () {
- return this._popup.isOpen();
+ // @method isOpen: Boolean
+ // Returns `true` when the popup is visible on the map.
+ isOpen: function () {
+ return !!this._map && this._map.hasLayer(this);
},
- // @method setPopupContent(content: String|HTMLElement|Popup): this
- // Sets the content of the popup bound to this layer.
- setPopupContent: function (content) {
- if (this._popup) {
- this._popup.setContent(content);
+ // @method bringToFront: this
+ // Brings this popup in front of other popups (in the same map pane).
+ bringToFront: function () {
+ if (this._map) {
+ L.DomUtil.toFront(this._container);
}
return this;
},
- // @method getPopup(): Popup
- // Returns the popup bound to this layer.
- getPopup: function () {
- return this._popup;
+ // @method bringToBack: this
+ // Brings this popup to the back of other popups (in the same map pane).
+ bringToBack: function () {
+ if (this._map) {
+ L.DomUtil.toBack(this._container);
+ }
+ return this;
},
- _openPopup: function (e) {
- var layer = e.layer || e.target;
+ _updateContent: function () {
+ if (!this._content) { return; }
- if (!this._popup) {
- return;
- }
+ var node = this._contentNode;
+ var content = (typeof this._content === 'function') ? this._content(this._source || this) : this._content;
- if (!this._map) {
- return;
+ if (typeof content === 'string') {
+ node.innerHTML = content;
+ } else {
+ while (node.hasChildNodes()) {
+ node.removeChild(node.firstChild);
+ }
+ node.appendChild(content);
}
+ this.fire('contentupdate');
+ },
- // prevent map click
- L.DomEvent.stop(e);
+ _updatePosition: function () {
+ if (!this._map) { return; }
- // if this inherits from Path its a vector and we can just
- // open the popup at the new location
- if (layer instanceof L.Path) {
- this.openPopup(e.layer || e.target, e.latlng);
- return;
- }
+ var pos = this._map.latLngToLayerPoint(this._latlng),
+ offset = L.point(this.options.offset),
+ anchor = this._getAnchor();
- // otherwise treat it like a marker and figure out
- // if we should toggle it open/closed
- if (this._map.hasLayer(this._popup) && this._popup._source === layer) {
- this.closePopup();
+ if (this._zoomAnimated) {
+ L.DomUtil.setPosition(this._container, pos.add(anchor));
} else {
- this.openPopup(layer, e.latlng);
+ offset = offset.add(pos).add(anchor);
}
- },
-
- _movePopup: function (e) {
- this._popup.setLatLng(e.latlng);
- }
-});
-
+ var bottom = this._containerBottom = -offset.y,
+ left = this._containerLeft = -Math.round(this._containerWidth / 2) + offset.x;
-/*
- * Popup extension to L.Marker, adding popup-related methods.
- */
+ // bottom position the popup in case the height of the popup changes (images loading etc)
+ this._container.style.bottom = bottom + 'px';
+ this._container.style.left = left + 'px';
+ },
-L.Marker.include({
- _getPopupAnchor: function () {
- return this.options.icon.options.popupAnchor || [0, 0];
+ _getAnchor: function () {
+ return [0, 0];
}
+
});
/*
- * @class Tooltip
+ * @class Popup
* @inherits DivOverlay
- * @aka L.Tooltip
- * Used to display small texts on top of map layers.
+ * @aka L.Popup
+ * Used to open popups in certain places of the map. Use [Map.openPopup](#map-openpopup) to
+ * open popups while making sure that only one popup is open at one time
+ * (recommended for usability), or use [Map.addLayer](#map-addlayer) to open as many as you want.
*
* @example
*
+ * If you want to just bind a popup to marker click and then open it, it's really easy:
+ *
* ```js
- * marker.bindTooltip("my tooltip text").openTooltip();
+ * marker.bindPopup(popupContent).openPopup();
+ * ```
+ * Path overlays like polylines also have a `bindPopup` method.
+ * Here's a more complicated way to open a popup on a map:
+ *
+ * ```js
+ * var popup = L.popup()
+ * .setLatLng(latlng)
+ * .setContent('<p>Hello world!<br />This is a nice popup.</p>')
+ * .openOn(map);
* ```
- * Note about tooltip offset. Leaflet takes two options in consideration
- * for computing tooltip offseting:
- * - the `offset` Tooltip option: it defaults to [0, 0], and it's specific to one tooltip.
- * Add a positive x offset to move the tooltip to the right, and a positive y offset to
- * move it to the bottom. Negatives will move to the left and top.
- * - the `tooltipAnchor` Icon option: this will only be considered for Marker. You
- * should adapt this value if you use a custom icon.
*/
-// @namespace Tooltip
-L.Tooltip = L.DivOverlay.extend({
+// @namespace Popup
+L.Popup = L.DivOverlay.extend({
// @section
- // @aka Tooltip options
+ // @aka Popup options
options: {
- // @option pane: String = 'tooltipPane'
- // `Map pane` where the tooltip will be added.
- pane: 'tooltipPane',
+ // @option maxWidth: Number = 300
+ // Max width of the popup, in pixels.
+ maxWidth: 300,
- // @option offset: Point = Point(0, 0)
- // Optional offset of the tooltip position.
- offset: [0, 0],
+ // @option minWidth: Number = 50
+ // Min width of the popup, in pixels.
+ minWidth: 50,
- // @option direction: String = 'auto'
- // Direction where to open the tooltip. Possible values are: `right`, `left`,
- // `top`, `bottom`, `center`, `auto`.
- // `auto` will dynamicaly switch between `right` and `left` according to the tooltip
- // position on the map.
- direction: 'auto',
+ // @option maxHeight: Number = null
+ // If set, creates a scrollable container of the given height
+ // inside a popup if its content exceeds it.
+ maxHeight: null,
- // @option permanent: Boolean = false
- // Whether to open the tooltip permanently or only on mouseover.
- permanent: false,
+ // @option autoPan: Boolean = true
+ // Set it to `false` if you don't want the map to do panning animation
+ // to fit the opened popup.
+ autoPan: true,
- // @option sticky: Boolean = false
- // If true, the tooltip will follow the mouse instead of being fixed at the feature center.
- sticky: false,
+ // @option autoPanPaddingTopLeft: Point = null
+ // The margin between the popup and the top left corner of the map
+ // view after autopanning was performed.
+ autoPanPaddingTopLeft: null,
- // @option interactive: Boolean = false
- // If true, the tooltip will listen to the feature events.
- interactive: false,
+ // @option autoPanPaddingBottomRight: Point = null
+ // The margin between the popup and the bottom right corner of the map
+ // view after autopanning was performed.
+ autoPanPaddingBottomRight: null,
- // @option opacity: Number = 0.9
- // Tooltip container opacity.
- opacity: 0.9
+ // @option autoPanPadding: Point = Point(5, 5)
+ // Equivalent of setting both top left and bottom right autopan padding to the same value.
+ autoPanPadding: [5, 5],
+
+ // @option keepInView: Boolean = false
+ // Set it to `true` if you want to prevent users from panning the popup
+ // off of the screen while it is open.
+ keepInView: false,
+
+ // @option closeButton: Boolean = true
+ // Controls the presence of a close button in the popup.
+ closeButton: true,
+
+ // @option autoClose: Boolean = true
+ // Set it to `false` if you want to override the default behavior of
+ // the popup closing when user clicks the map (set globally by
+ // the Map's [closePopupOnClick](#map-closepopuponclick) option).
+ autoClose: true,
+
+ // @option className: String = ''
+ // A custom CSS class name to assign to the popup.
+ className: ''
+ },
+
+ // @namespace Popup
+ // @method openOn(map: Map): this
+ // Adds the popup to the map and closes the previous one. The same as `map.openPopup(popup)`.
+ openOn: function (map) {
+ map.openPopup(this);
+ return this;
},
onAdd: function (map) {
L.DivOverlay.prototype.onAdd.call(this, map);
- this.setOpacity(this.options.opacity);
// @namespace Map
- // @section Tooltip events
- // @event tooltipopen: TooltipEvent
- // Fired when a tooltip is opened in the map.
- map.fire('tooltipopen', {tooltip: this});
+ // @section Popup events
+ // @event popupopen: PopupEvent
+ // Fired when a popup is opened in the map
+ map.fire('popupopen', {popup: this});
if (this._source) {
// @namespace Layer
- // @section Tooltip events
- // @event tooltipopen: TooltipEvent
- // Fired when a tooltip bound to this layer is opened.
- this._source.fire('tooltipopen', {tooltip: this}, true);
+ // @section Popup events
+ // @event popupopen: PopupEvent
+ // Fired when a popup bound to this layer is opened
+ this._source.fire('popupopen', {popup: this}, true);
+ // For non-path layers, we toggle the popup when clicking
+ // again the layer, so prevent the map to reopen it.
+ if (!(this._source instanceof L.Path)) {
+ this._source.on('preclick', L.DomEvent.stopPropagation);
+ }
}
},
L.DivOverlay.prototype.onRemove.call(this, map);
// @namespace Map
- // @section Tooltip events
- // @event tooltipclose: TooltipEvent
- // Fired when a tooltip in the map is closed.
- map.fire('tooltipclose', {tooltip: this});
+ // @section Popup events
+ // @event popupclose: PopupEvent
+ // Fired when a popup in the map is closed
+ map.fire('popupclose', {popup: this});
if (this._source) {
// @namespace Layer
- // @section Tooltip events
- // @event tooltipclose: TooltipEvent
- // Fired when a tooltip bound to this layer is closed.
- this._source.fire('tooltipclose', {tooltip: this}, true);
+ // @section Popup events
+ // @event popupclose: PopupEvent
+ // Fired when a popup bound to this layer is closed
+ this._source.fire('popupclose', {popup: this}, true);
+ if (!(this._source instanceof L.Path)) {
+ this._source.off('preclick', L.DomEvent.stopPropagation);
+ }
}
},
getEvents: function () {
var events = L.DivOverlay.prototype.getEvents.call(this);
- if (L.Browser.touch && !this.options.permanent) {
+ if ('closeOnClick' in this.options ? this.options.closeOnClick : this._map.options.closePopupOnClick) {
events.preclick = this._close;
}
+ if (this.options.keepInView) {
+ events.moveend = this._adjustPan;
+ }
+
return events;
},
_close: function () {
if (this._map) {
- this._map.closeTooltip(this);
+ this._map.closePopup(this);
}
},
_initLayout: function () {
- var prefix = 'leaflet-tooltip',
- className = prefix + ' ' + (this.options.className || '') + ' leaflet-zoom-' + (this._zoomAnimated ? 'animated' : 'hide');
+ var prefix = 'leaflet-popup',
+ container = this._container = L.DomUtil.create('div',
+ prefix + ' ' + (this.options.className || '') +
+ ' leaflet-zoom-animated');
- this._contentNode = this._container = L.DomUtil.create('div', className);
+ if (this.options.closeButton) {
+ var closeButton = this._closeButton = L.DomUtil.create('a', prefix + '-close-button', container);
+ closeButton.href = '#close';
+ closeButton.innerHTML = '×';
+
+ L.DomEvent.on(closeButton, 'click', this._onCloseButtonClick, this);
+ }
+
+ var wrapper = this._wrapper = L.DomUtil.create('div', prefix + '-content-wrapper', container);
+ this._contentNode = L.DomUtil.create('div', prefix + '-content', wrapper);
+
+ L.DomEvent
+ .disableClickPropagation(wrapper)
+ .disableScrollPropagation(this._contentNode)
+ .on(wrapper, 'contextmenu', L.DomEvent.stopPropagation);
+
+ this._tipContainer = L.DomUtil.create('div', prefix + '-tip-container', container);
+ this._tip = L.DomUtil.create('div', prefix + '-tip', this._tipContainer);
},
- _updateLayout: function () {},
+ _updateLayout: function () {
+ var container = this._contentNode,
+ style = container.style;
- _adjustPan: function () {},
+ style.width = '';
+ style.whiteSpace = 'nowrap';
- _setPosition: function (pos) {
- var map = this._map,
- container = this._container,
- centerPoint = map.latLngToContainerPoint(map.getCenter()),
- tooltipPoint = map.layerPointToContainerPoint(pos),
- direction = this.options.direction,
- tooltipWidth = container.offsetWidth,
- tooltipHeight = container.offsetHeight,
- offset = L.point(this.options.offset),
- anchor = this._getAnchor();
+ var width = container.offsetWidth;
+ width = Math.min(width, this.options.maxWidth);
+ width = Math.max(width, this.options.minWidth);
- if (direction === 'top') {
- pos = pos.add(L.point(-tooltipWidth / 2 + offset.x, -tooltipHeight + offset.y + anchor.y));
- } else if (direction === 'bottom') {
- pos = pos.subtract(L.point(tooltipWidth / 2 - offset.x, -offset.y));
- } else if (direction === 'center') {
- pos = pos.subtract(L.point(tooltipWidth / 2 + offset.x, tooltipHeight / 2 - anchor.y + offset.y));
- } else if (direction === 'right' || direction === 'auto' && tooltipPoint.x < centerPoint.x) {
- direction = 'right';
- pos = pos.add([offset.x + anchor.x, anchor.y - tooltipHeight / 2 + offset.y]);
+ style.width = (width + 1) + 'px';
+ style.whiteSpace = '';
+
+ style.height = '';
+
+ var height = container.offsetHeight,
+ maxHeight = this.options.maxHeight,
+ scrolledClass = 'leaflet-popup-scrolled';
+
+ if (maxHeight && height > maxHeight) {
+ style.height = maxHeight + 'px';
+ L.DomUtil.addClass(container, scrolledClass);
} else {
- direction = 'left';
- pos = pos.subtract(L.point(tooltipWidth + anchor.x - offset.x, tooltipHeight / 2 - anchor.y - offset.y));
+ L.DomUtil.removeClass(container, scrolledClass);
}
- L.DomUtil.removeClass(container, 'leaflet-tooltip-right');
- L.DomUtil.removeClass(container, 'leaflet-tooltip-left');
- L.DomUtil.removeClass(container, 'leaflet-tooltip-top');
- L.DomUtil.removeClass(container, 'leaflet-tooltip-bottom');
- L.DomUtil.addClass(container, 'leaflet-tooltip-' + direction);
- L.DomUtil.setPosition(container, pos);
+ this._containerWidth = this._container.offsetWidth;
},
- _updatePosition: function () {
- var pos = this._map.latLngToLayerPoint(this._latlng);
- this._setPosition(pos);
+ _animateZoom: function (e) {
+ var pos = this._map._latLngToNewLayerPoint(this._latlng, e.zoom, e.center),
+ anchor = this._getAnchor();
+ L.DomUtil.setPosition(this._container, pos.add(anchor));
},
- setOpacity: function (opacity) {
- this.options.opacity = opacity;
+ _adjustPan: function () {
+ if (!this.options.autoPan || (this._map._panAnim && this._map._panAnim._inProgress)) { return; }
- if (this._container) {
- L.DomUtil.setOpacity(this._container, opacity);
+ var map = this._map,
+ marginBottom = parseInt(L.DomUtil.getStyle(this._container, 'marginBottom'), 10) || 0,
+ containerHeight = this._container.offsetHeight + marginBottom,
+ containerWidth = this._containerWidth,
+ layerPos = new L.Point(this._containerLeft, -containerHeight - this._containerBottom);
+
+ layerPos._add(L.DomUtil.getPosition(this._container));
+
+ var containerPos = map.layerPointToContainerPoint(layerPos),
+ padding = L.point(this.options.autoPanPadding),
+ paddingTL = L.point(this.options.autoPanPaddingTopLeft || padding),
+ paddingBR = L.point(this.options.autoPanPaddingBottomRight || padding),
+ size = map.getSize(),
+ dx = 0,
+ dy = 0;
+
+ if (containerPos.x + containerWidth + paddingBR.x > size.x) { // right
+ dx = containerPos.x + containerWidth - size.x + paddingBR.x;
+ }
+ if (containerPos.x - dx - paddingTL.x < 0) { // left
+ dx = containerPos.x - paddingTL.x;
+ }
+ if (containerPos.y + containerHeight + paddingBR.y > size.y) { // bottom
+ dy = containerPos.y + containerHeight - size.y + paddingBR.y;
+ }
+ if (containerPos.y - dy - paddingTL.y < 0) { // top
+ dy = containerPos.y - paddingTL.y;
+ }
+
+ // @namespace Map
+ // @section Popup events
+ // @event autopanstart: Event
+ // Fired when the map starts autopanning when opening a popup.
+ if (dx || dy) {
+ map
+ .fire('autopanstart')
+ .panBy([dx, dy]);
}
},
- _animateZoom: function (e) {
- var pos = this._map._latLngToNewLayerPoint(this._latlng, e.zoom, e.center);
- this._setPosition(pos);
+ _onCloseButtonClick: function (e) {
+ this._close();
+ L.DomEvent.stop(e);
},
_getAnchor: function () {
- // Where should we anchor the tooltip on the source layer?
- return L.point(this._source && this._source._getTooltipAnchor && !this.options.sticky ? this._source._getTooltipAnchor() : [0, 0]);
+ // Where should we anchor the popup on the source layer?
+ return L.point(this._source && this._source._getPopupAnchor ? this._source._getPopupAnchor() : [0, 0]);
}
});
-// @namespace Tooltip
-// @factory L.tooltip(options?: Tooltip options, source?: Layer)
-// Instantiates a Tooltip object given an optional `options` object that describes its appearance and location and an optional `source` object that is used to tag the tooltip with a reference to the Layer to which it refers.
-L.tooltip = function (options, source) {
- return new L.Tooltip(options, source);
+// @namespace Popup
+// @factory L.popup(options?: Popup options, source?: Layer)
+// Instantiates a `Popup` object given an optional `options` object that describes its appearance and location and an optional `source` object that is used to tag the popup with a reference to the Layer to which it refers.
+L.popup = function (options, source) {
+ return new L.Popup(options, source);
};
+
+/* @namespace Map
+ * @section Interaction Options
+ * @option closePopupOnClick: Boolean = true
+ * Set it to `false` if you don't want popups to close when user clicks the map.
+ */
+L.Map.mergeOptions({
+ closePopupOnClick: true
+});
+
+
// @namespace Map
// @section Methods for Layers and Controls
L.Map.include({
-
- // @method openTooltip(tooltip: Tooltip): this
- // Opens the specified tooltip.
+ // @method openPopup(popup: Popup): this
+ // Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).
// @alternative
- // @method openTooltip(content: String|HTMLElement, latlng: LatLng, options?: Tooltip options): this
- // Creates a tooltip with the specified content and options and open it.
- openTooltip: function (tooltip, latlng, options) {
- if (!(tooltip instanceof L.Tooltip)) {
- tooltip = new L.Tooltip(options).setContent(tooltip);
+ // @method openPopup(content: String|HTMLElement, latlng: LatLng, options?: Popup options): this
+ // Creates a popup with the specified content and options and opens it in the given point on a map.
+ openPopup: function (popup, latlng, options) {
+ if (!(popup instanceof L.Popup)) {
+ popup = new L.Popup(options).setContent(popup);
}
if (latlng) {
- tooltip.setLatLng(latlng);
+ popup.setLatLng(latlng);
}
- if (this.hasLayer(tooltip)) {
+ if (this.hasLayer(popup)) {
return this;
}
- return this.addLayer(tooltip);
+ if (this._popup && this._popup.options.autoClose) {
+ this.closePopup();
+ }
+
+ this._popup = popup;
+ return this.addLayer(popup);
},
- // @method closeTooltip(tooltip?: Tooltip): this
- // Closes the tooltip given as parameter.
- closeTooltip: function (tooltip) {
- if (tooltip) {
- this.removeLayer(tooltip);
+ // @method closePopup(popup?: Popup): this
+ // Closes the popup previously opened with [openPopup](#map-openpopup) (or the given one).
+ closePopup: function (popup) {
+ if (!popup || popup === this._popup) {
+ popup = this._popup;
+ this._popup = null;
+ }
+ if (popup) {
+ this.removeLayer(popup);
}
return this;
}
-
});
-
-
/*
* @namespace Layer
- * @section Tooltip methods example
+ * @section Popup methods example
*
- * All layers share a set of methods convenient for binding tooltips to it.
+ * All layers share a set of methods convenient for binding popups to it.
*
* ```js
- * var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map);
- * layer.openTooltip();
- * layer.closeTooltip();
+ * var layer = L.Polygon(latlngs).bindPopup('Hi There!').addTo(map);
+ * layer.openPopup();
+ * layer.closePopup();
* ```
+ *
+ * Popups will also be automatically opened when the layer is clicked on and closed when the layer is removed from the map or another popup is opened.
*/
-// @section Tooltip methods
+// @section Popup methods
L.Layer.include({
- // @method bindTooltip(content: String|HTMLElement|Function|Tooltip, options?: Tooltip options): this
- // Binds a tooltip to the layer with the passed `content` and sets up the
+ // @method bindPopup(content: String|HTMLElement|Function|Popup, options?: Popup options): this
+ // Binds a popup to the layer with the passed `content` and sets up the
// neccessary event listeners. If a `Function` is passed it will receive
// the layer as the first argument and should return a `String` or `HTMLElement`.
- bindTooltip: function (content, options) {
+ bindPopup: function (content, options) {
- if (content instanceof L.Tooltip) {
+ if (content instanceof L.Popup) {
L.setOptions(content, options);
- this._tooltip = content;
+ this._popup = content;
content._source = this;
} else {
- if (!this._tooltip || options) {
- this._tooltip = L.tooltip(options, this);
+ if (!this._popup || options) {
+ this._popup = new L.Popup(options, this);
}
- this._tooltip.setContent(content);
-
+ this._popup.setContent(content);
}
- this._initTooltipInteractions();
-
- if (this._tooltip.options.permanent && this._map && this._map.hasLayer(this)) {
- this.openTooltip();
+ if (!this._popupHandlersAdded) {
+ this.on({
+ click: this._openPopup,
+ remove: this.closePopup,
+ move: this._movePopup
+ });
+ this._popupHandlersAdded = true;
}
return this;
},
- // @method unbindTooltip(): this
- // Removes the tooltip previously bound with `bindTooltip`.
- unbindTooltip: function () {
- if (this._tooltip) {
- this._initTooltipInteractions(true);
- this.closeTooltip();
- this._tooltip = null;
+ // @method unbindPopup(): this
+ // Removes the popup previously bound with `bindPopup`.
+ unbindPopup: function () {
+ if (this._popup) {
+ this.off({
+ click: this._openPopup,
+ remove: this.closePopup,
+ move: this._movePopup
+ });
+ this._popupHandlersAdded = false;
+ this._popup = null;
}
return this;
},
- _initTooltipInteractions: function (remove) {
- if (!remove && this._tooltipHandlersAdded) { return; }
- var onOff = remove ? 'off' : 'on',
- events = {
- remove: this.closeTooltip,
- move: this._moveTooltip
- };
- if (!this._tooltip.options.permanent) {
- events.mouseover = this._openTooltip;
- events.mouseout = this.closeTooltip;
- if (this._tooltip.options.sticky) {
- events.mousemove = this._moveTooltip;
- }
- if (L.Browser.touch) {
- events.click = this._openTooltip;
- }
- } else {
- events.add = this._openTooltip;
- }
- this[onOff](events);
- this._tooltipHandlersAdded = !remove;
- },
-
- // @method openTooltip(latlng?: LatLng): this
- // Opens the bound tooltip at the specificed `latlng` or at the default tooltip anchor if no `latlng` is passed.
- openTooltip: function (layer, latlng) {
+ // @method openPopup(latlng?: LatLng): this
+ // Opens the bound popup at the specificed `latlng` or at the default popup anchor if no `latlng` is passed.
+ openPopup: function (layer, latlng) {
if (!(layer instanceof L.Layer)) {
latlng = layer;
layer = this;
latlng = layer.getCenter ? layer.getCenter() : layer.getLatLng();
}
- if (this._tooltip && this._map) {
-
- // set tooltip source to this layer
- this._tooltip._source = layer;
-
- // update the tooltip (content, layout, ect...)
- this._tooltip.update();
+ if (this._popup && this._map) {
+ // set popup source to this layer
+ this._popup._source = layer;
- // open the tooltip on the map
- this._map.openTooltip(this._tooltip, latlng);
+ // update the popup (content, layout, ect...)
+ this._popup.update();
- // Tooltip container may not be defined if not permanent and never
- // opened.
- if (this._tooltip.options.interactive && this._tooltip._container) {
- L.DomUtil.addClass(this._tooltip._container, 'leaflet-clickable');
- this.addInteractiveTarget(this._tooltip._container);
- }
+ // open the popup on the map
+ this._map.openPopup(this._popup, latlng);
}
return this;
},
- // @method closeTooltip(): this
- // Closes the tooltip bound to this layer if it is open.
- closeTooltip: function () {
- if (this._tooltip) {
- this._tooltip._close();
- if (this._tooltip.options.interactive && this._tooltip._container) {
- L.DomUtil.removeClass(this._tooltip._container, 'leaflet-clickable');
- this.removeInteractiveTarget(this._tooltip._container);
- }
+ // @method closePopup(): this
+ // Closes the popup bound to this layer if it is open.
+ closePopup: function () {
+ if (this._popup) {
+ this._popup._close();
}
return this;
},
- // @method toggleTooltip(): this
- // Opens or closes the tooltip bound to this layer depending on its current state.
- toggleTooltip: function (target) {
- if (this._tooltip) {
- if (this._tooltip._map) {
- this.closeTooltip();
+ // @method togglePopup(): this
+ // Opens or closes the popup bound to this layer depending on its current state.
+ togglePopup: function (target) {
+ if (this._popup) {
+ if (this._popup._map) {
+ this.closePopup();
} else {
- this.openTooltip(target);
+ this.openPopup(target);
}
}
return this;
},
- // @method isTooltipOpen(): boolean
- // Returns `true` if the tooltip bound to this layer is currently open.
- isTooltipOpen: function () {
- return this._tooltip.isOpen();
+ // @method isPopupOpen(): boolean
+ // Returns `true` if the popup bound to this layer is currently open.
+ isPopupOpen: function () {
+ return this._popup.isOpen();
},
- // @method setTooltipContent(content: String|HTMLElement|Tooltip): this
- // Sets the content of the tooltip bound to this layer.
- setTooltipContent: function (content) {
- if (this._tooltip) {
- this._tooltip.setContent(content);
+ // @method setPopupContent(content: String|HTMLElement|Popup): this
+ // Sets the content of the popup bound to this layer.
+ setPopupContent: function (content) {
+ if (this._popup) {
+ this._popup.setContent(content);
}
return this;
},
- // @method getTooltip(): Tooltip
- // Returns the tooltip bound to this layer.
- getTooltip: function () {
- return this._tooltip;
+ // @method getPopup(): Popup
+ // Returns the popup bound to this layer.
+ getPopup: function () {
+ return this._popup;
},
- _openTooltip: function (e) {
+ _openPopup: function (e) {
var layer = e.layer || e.target;
- if (!this._tooltip || !this._map) {
+ if (!this._popup) {
return;
}
- this.openTooltip(layer, this._tooltip.options.sticky ? e.latlng : undefined);
- },
- _moveTooltip: function (e) {
- var latlng = e.latlng, containerPoint, layerPoint;
- if (this._tooltip.options.sticky && e.originalEvent) {
- containerPoint = this._map.mouseEventToContainerPoint(e.originalEvent);
- layerPoint = this._map.containerPointToLayerPoint(containerPoint);
- latlng = this._map.layerPointToLatLng(layerPoint);
+ if (!this._map) {
+ return;
}
- this._tooltip.setLatLng(latlng);
- }
-});
-
+ // prevent map click
+ L.DomEvent.stop(e);
-/*
- * Tooltip extension to L.Marker, adding tooltip-related methods.
- */
+ // if this inherits from Path its a vector and we can just
+ // open the popup at the new location
+ if (layer instanceof L.Path) {
+ this.openPopup(e.layer || e.target, e.latlng);
+ return;
+ }
-L.Marker.include({
- _getTooltipAnchor: function () {
- return this.options.icon.options.tooltipAnchor || [0, 0];
+ // otherwise treat it like a marker and figure out
+ // if we should toggle it open/closed
+ if (this._map.hasLayer(this._popup) && this._popup._source === layer) {
+ this.closePopup();
+ } else {
+ this.openPopup(layer, e.latlng);
+ }
+ },
+
+ _movePopup: function (e) {
+ this._popup.setLatLng(e.latlng);
}
});
/*
- * @class LayerGroup
- * @aka L.LayerGroup
- * @inherits Layer
- *
- * Used to group several layers and handle them as one. If you add it to the map,
- * any layers added or removed from the group will be added/removed on the map as
- * well. Extends `Layer`.
+ * @class Tooltip
+ * @inherits DivOverlay
+ * @aka L.Tooltip
+ * Used to display small texts on top of map layers.
*
* @example
*
* ```js
- * L.layerGroup([marker1, marker2])
- * .addLayer(polyline)
- * .addTo(map);
+ * marker.bindTooltip("my tooltip text").openTooltip();
* ```
+ * Note about tooltip offset. Leaflet takes two options in consideration
+ * for computing tooltip offseting:
+ * - the `offset` Tooltip option: it defaults to [0, 0], and it's specific to one tooltip.
+ * Add a positive x offset to move the tooltip to the right, and a positive y offset to
+ * move it to the bottom. Negatives will move to the left and top.
+ * - the `tooltipAnchor` Icon option: this will only be considered for Marker. You
+ * should adapt this value if you use a custom icon.
*/
-L.LayerGroup = L.Layer.extend({
- initialize: function (layers) {
- this._layers = {};
+// @namespace Tooltip
+L.Tooltip = L.DivOverlay.extend({
- var i, len;
+ // @section
+ // @aka Tooltip options
+ options: {
+ // @option pane: String = 'tooltipPane'
+ // `Map pane` where the tooltip will be added.
+ pane: 'tooltipPane',
- if (layers) {
- for (i = 0, len = layers.length; i < len; i++) {
- this.addLayer(layers[i]);
- }
- }
- },
+ // @option offset: Point = Point(0, 0)
+ // Optional offset of the tooltip position.
+ offset: [0, 0],
- // @method addLayer(layer: Layer): this
- // Adds the given layer to the group.
- addLayer: function (layer) {
- var id = this.getLayerId(layer);
+ // @option direction: String = 'auto'
+ // Direction where to open the tooltip. Possible values are: `right`, `left`,
+ // `top`, `bottom`, `center`, `auto`.
+ // `auto` will dynamicaly switch between `right` and `left` according to the tooltip
+ // position on the map.
+ direction: 'auto',
- this._layers[id] = layer;
+ // @option permanent: Boolean = false
+ // Whether to open the tooltip permanently or only on mouseover.
+ permanent: false,
- if (this._map) {
- this._map.addLayer(layer);
- }
+ // @option sticky: Boolean = false
+ // If true, the tooltip will follow the mouse instead of being fixed at the feature center.
+ sticky: false,
- return this;
- },
+ // @option interactive: Boolean = false
+ // If true, the tooltip will listen to the feature events.
+ interactive: false,
- // @method removeLayer(layer: Layer): this
- // Removes the given layer from the group.
- // @alternative
- // @method removeLayer(id: Number): this
- // Removes the layer with the given internal ID from the group.
- removeLayer: function (layer) {
- var id = layer in this._layers ? layer : this.getLayerId(layer);
+ // @option opacity: Number = 0.9
+ // Tooltip container opacity.
+ opacity: 0.9
+ },
- if (this._map && this._layers[id]) {
- this._map.removeLayer(this._layers[id]);
- }
+ onAdd: function (map) {
+ L.DivOverlay.prototype.onAdd.call(this, map);
+ this.setOpacity(this.options.opacity);
- delete this._layers[id];
+ // @namespace Map
+ // @section Tooltip events
+ // @event tooltipopen: TooltipEvent
+ // Fired when a tooltip is opened in the map.
+ map.fire('tooltipopen', {tooltip: this});
- return this;
+ if (this._source) {
+ // @namespace Layer
+ // @section Tooltip events
+ // @event tooltipopen: TooltipEvent
+ // Fired when a tooltip bound to this layer is opened.
+ this._source.fire('tooltipopen', {tooltip: this}, true);
+ }
},
- // @method hasLayer(layer: Layer): Boolean
- // Returns `true` if the given layer is currently added to the group.
- hasLayer: function (layer) {
- return !!layer && (layer in this._layers || this.getLayerId(layer) in this._layers);
- },
+ onRemove: function (map) {
+ L.DivOverlay.prototype.onRemove.call(this, map);
- // @method clearLayers(): this
- // Removes all the layers from the group.
- clearLayers: function () {
- for (var i in this._layers) {
- this.removeLayer(this._layers[i]);
+ // @namespace Map
+ // @section Tooltip events
+ // @event tooltipclose: TooltipEvent
+ // Fired when a tooltip in the map is closed.
+ map.fire('tooltipclose', {tooltip: this});
+
+ if (this._source) {
+ // @namespace Layer
+ // @section Tooltip events
+ // @event tooltipclose: TooltipEvent
+ // Fired when a tooltip bound to this layer is closed.
+ this._source.fire('tooltipclose', {tooltip: this}, true);
}
- return this;
},
- // @method invoke(methodName: String, …): this
- // Calls `methodName` on every layer contained in this group, passing any
- // additional parameters. Has no effect if the layers contained do not
- // implement `methodName`.
- invoke: function (methodName) {
- var args = Array.prototype.slice.call(arguments, 1),
- i, layer;
-
- for (i in this._layers) {
- layer = this._layers[i];
+ getEvents: function () {
+ var events = L.DivOverlay.prototype.getEvents.call(this);
- if (layer[methodName]) {
- layer[methodName].apply(layer, args);
- }
+ if (L.Browser.touch && !this.options.permanent) {
+ events.preclick = this._close;
}
- return this;
+ return events;
},
- onAdd: function (map) {
- for (var i in this._layers) {
- map.addLayer(this._layers[i]);
+ _close: function () {
+ if (this._map) {
+ this._map.closeTooltip(this);
}
},
- onRemove: function (map) {
- for (var i in this._layers) {
- map.removeLayer(this._layers[i]);
- }
+ _initLayout: function () {
+ var prefix = 'leaflet-tooltip',
+ className = prefix + ' ' + (this.options.className || '') + ' leaflet-zoom-' + (this._zoomAnimated ? 'animated' : 'hide');
+
+ this._contentNode = this._container = L.DomUtil.create('div', className);
},
- // @method eachLayer(fn: Function, context?: Object): this
- // Iterates over the layers of the group, optionally specifying context of the iterator function.
- // ```js
- // group.eachLayer(function (layer) {
- // layer.bindPopup('Hello');
- // });
- // ```
- eachLayer: function (method, context) {
- for (var i in this._layers) {
- method.call(context, this._layers[i]);
+ _updateLayout: function () {},
+
+ _adjustPan: function () {},
+
+ _setPosition: function (pos) {
+ var map = this._map,
+ container = this._container,
+ centerPoint = map.latLngToContainerPoint(map.getCenter()),
+ tooltipPoint = map.layerPointToContainerPoint(pos),
+ direction = this.options.direction,
+ tooltipWidth = container.offsetWidth,
+ tooltipHeight = container.offsetHeight,
+ offset = L.point(this.options.offset),
+ anchor = this._getAnchor();
+
+ if (direction === 'top') {
+ pos = pos.add(L.point(-tooltipWidth / 2 + offset.x, -tooltipHeight + offset.y + anchor.y, true));
+ } else if (direction === 'bottom') {
+ pos = pos.subtract(L.point(tooltipWidth / 2 - offset.x, -offset.y, true));
+ } else if (direction === 'center') {
+ pos = pos.subtract(L.point(tooltipWidth / 2 + offset.x, tooltipHeight / 2 - anchor.y + offset.y, true));
+ } else if (direction === 'right' || direction === 'auto' && tooltipPoint.x < centerPoint.x) {
+ direction = 'right';
+ pos = pos.add(L.point(offset.x + anchor.x, anchor.y - tooltipHeight / 2 + offset.y, true));
+ } else {
+ direction = 'left';
+ pos = pos.subtract(L.point(tooltipWidth + anchor.x - offset.x, tooltipHeight / 2 - anchor.y - offset.y, true));
}
- return this;
+
+ L.DomUtil.removeClass(container, 'leaflet-tooltip-right');
+ L.DomUtil.removeClass(container, 'leaflet-tooltip-left');
+ L.DomUtil.removeClass(container, 'leaflet-tooltip-top');
+ L.DomUtil.removeClass(container, 'leaflet-tooltip-bottom');
+ L.DomUtil.addClass(container, 'leaflet-tooltip-' + direction);
+ L.DomUtil.setPosition(container, pos);
},
- // @method getLayer(id: Number): Layer
- // Returns the layer with the given internal ID.
- getLayer: function (id) {
- return this._layers[id];
+ _updatePosition: function () {
+ var pos = this._map.latLngToLayerPoint(this._latlng);
+ this._setPosition(pos);
},
- // @method getLayers(): Layer[]
- // Returns an array of all the layers added to the group.
- getLayers: function () {
- var layers = [];
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
- for (var i in this._layers) {
- layers.push(this._layers[i]);
+ if (this._container) {
+ L.DomUtil.setOpacity(this._container, opacity);
}
- return layers;
},
- // @method setZIndex(zIndex: Number): this
- // Calls `setZIndex` on every layer contained in this group, passing the z-index.
- setZIndex: function (zIndex) {
- return this.invoke('setZIndex', zIndex);
+ _animateZoom: function (e) {
+ var pos = this._map._latLngToNewLayerPoint(this._latlng, e.zoom, e.center);
+ this._setPosition(pos);
},
- // @method getLayerId(layer: Layer): Number
- // Returns the internal ID for a layer
- getLayerId: function (layer) {
- return L.stamp(layer);
+ _getAnchor: function () {
+ // Where should we anchor the tooltip on the source layer?
+ return L.point(this._source && this._source._getTooltipAnchor && !this.options.sticky ? this._source._getTooltipAnchor() : [0, 0]);
}
-});
+});
-// @factory L.layerGroup(layers: Layer[])
-// Create a layer group, optionally given an initial set of layers.
-L.layerGroup = function (layers) {
- return new L.LayerGroup(layers);
+// @namespace Tooltip
+// @factory L.tooltip(options?: Tooltip options, source?: Layer)
+// Instantiates a Tooltip object given an optional `options` object that describes its appearance and location and an optional `source` object that is used to tag the tooltip with a reference to the Layer to which it refers.
+L.tooltip = function (options, source) {
+ return new L.Tooltip(options, source);
};
+// @namespace Map
+// @section Methods for Layers and Controls
+L.Map.include({
+ // @method openTooltip(tooltip: Tooltip): this
+ // Opens the specified tooltip.
+ // @alternative
+ // @method openTooltip(content: String|HTMLElement, latlng: LatLng, options?: Tooltip options): this
+ // Creates a tooltip with the specified content and options and open it.
+ openTooltip: function (tooltip, latlng, options) {
+ if (!(tooltip instanceof L.Tooltip)) {
+ tooltip = new L.Tooltip(options).setContent(tooltip);
+ }
+
+ if (latlng) {
+ tooltip.setLatLng(latlng);
+ }
+
+ if (this.hasLayer(tooltip)) {
+ return this;
+ }
+
+ return this.addLayer(tooltip);
+ },
+
+ // @method closeTooltip(tooltip?: Tooltip): this
+ // Closes the tooltip given as parameter.
+ closeTooltip: function (tooltip) {
+ if (tooltip) {
+ this.removeLayer(tooltip);
+ }
+ return this;
+ }
+
+});
/*
- * @class FeatureGroup
- * @aka L.FeatureGroup
- * @inherits LayerGroup
- *
- * Extended `LayerGroup` that makes it easier to do the same thing to all its member layers:
- * * [`bindPopup`](#layer-bindpopup) binds a popup to all of the layers at once (likewise with [`bindTooltip`](#layer-bindtooltip))
- * * Events are propagated to the `FeatureGroup`, so if the group has an event
- * handler, it will handle events from any of the layers. This includes mouse events
- * and custom events.
- * * Has `layeradd` and `layerremove` events
+ * @namespace Layer
+ * @section Tooltip methods example
*
- * @example
+ * All layers share a set of methods convenient for binding tooltips to it.
*
* ```js
- * L.featureGroup([marker1, marker2, polyline])
- * .bindPopup('Hello world!')
- * .on('click', function() { alert('Clicked on a member of the group!'); })
- * .addTo(map);
+ * var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map);
+ * layer.openTooltip();
+ * layer.closeTooltip();
* ```
*/
-L.FeatureGroup = L.LayerGroup.extend({
-
- addLayer: function (layer) {
- if (this.hasLayer(layer)) {
- return this;
- }
-
- layer.addEventParent(this);
+// @section Tooltip methods
+L.Layer.include({
- L.LayerGroup.prototype.addLayer.call(this, layer);
+ // @method bindTooltip(content: String|HTMLElement|Function|Tooltip, options?: Tooltip options): this
+ // Binds a tooltip to the layer with the passed `content` and sets up the
+ // neccessary event listeners. If a `Function` is passed it will receive
+ // the layer as the first argument and should return a `String` or `HTMLElement`.
+ bindTooltip: function (content, options) {
- // @event layeradd: LayerEvent
- // Fired when a layer is added to this `FeatureGroup`
- return this.fire('layeradd', {layer: layer});
- },
+ if (content instanceof L.Tooltip) {
+ L.setOptions(content, options);
+ this._tooltip = content;
+ content._source = this;
+ } else {
+ if (!this._tooltip || options) {
+ this._tooltip = L.tooltip(options, this);
+ }
+ this._tooltip.setContent(content);
- removeLayer: function (layer) {
- if (!this.hasLayer(layer)) {
- return this;
}
- if (layer in this._layers) {
- layer = this._layers[layer];
- }
-
- layer.removeEventParent(this);
- L.LayerGroup.prototype.removeLayer.call(this, layer);
+ this._initTooltipInteractions();
- // @event layerremove: LayerEvent
- // Fired when a layer is removed from this `FeatureGroup`
- return this.fire('layerremove', {layer: layer});
- },
+ if (this._tooltip.options.permanent && this._map && this._map.hasLayer(this)) {
+ this.openTooltip();
+ }
- // @method setStyle(style: Path options): this
- // Sets the given path options to each layer of the group that has a `setStyle` method.
- setStyle: function (style) {
- return this.invoke('setStyle', style);
+ return this;
},
- // @method bringToFront(): this
- // Brings the layer group to the top of all other layers
- bringToFront: function () {
- return this.invoke('bringToFront');
+ // @method unbindTooltip(): this
+ // Removes the tooltip previously bound with `bindTooltip`.
+ unbindTooltip: function () {
+ if (this._tooltip) {
+ this._initTooltipInteractions(true);
+ this.closeTooltip();
+ this._tooltip = null;
+ }
+ return this;
},
- // @method bringToBack(): this
- // Brings the layer group to the top of all other layers
- bringToBack: function () {
- return this.invoke('bringToBack');
+ _initTooltipInteractions: function (remove) {
+ if (!remove && this._tooltipHandlersAdded) { return; }
+ var onOff = remove ? 'off' : 'on',
+ events = {
+ remove: this.closeTooltip,
+ move: this._moveTooltip
+ };
+ if (!this._tooltip.options.permanent) {
+ events.mouseover = this._openTooltip;
+ events.mouseout = this.closeTooltip;
+ if (this._tooltip.options.sticky) {
+ events.mousemove = this._moveTooltip;
+ }
+ if (L.Browser.touch) {
+ events.click = this._openTooltip;
+ }
+ } else {
+ events.add = this._openTooltip;
+ }
+ this[onOff](events);
+ this._tooltipHandlersAdded = !remove;
},
- // @method getBounds(): LatLngBounds
- // Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children).
- getBounds: function () {
- var bounds = new L.LatLngBounds();
+ // @method openTooltip(latlng?: LatLng): this
+ // Opens the bound tooltip at the specificed `latlng` or at the default tooltip anchor if no `latlng` is passed.
+ openTooltip: function (layer, latlng) {
+ if (!(layer instanceof L.Layer)) {
+ latlng = layer;
+ layer = this;
+ }
- for (var id in this._layers) {
- var layer = this._layers[id];
- bounds.extend(layer.getBounds ? layer.getBounds() : layer.getLatLng());
+ if (layer instanceof L.FeatureGroup) {
+ for (var id in this._layers) {
+ layer = this._layers[id];
+ break;
+ }
}
- return bounds;
- }
-});
-// @factory L.featureGroup(layers: Layer[])
-// Create a feature group, optionally given an initial set of layers.
-L.featureGroup = function (layers) {
- return new L.FeatureGroup(layers);
-};
+ if (!latlng) {
+ latlng = layer.getCenter ? layer.getCenter() : layer.getLatLng();
+ }
+ if (this._tooltip && this._map) {
+ // set tooltip source to this layer
+ this._tooltip._source = layer;
-/*
- * @class Renderer
- * @inherits Layer
- * @aka L.Renderer
- *
- * Base class for vector renderer implementations (`SVG`, `Canvas`). Handles the
- * DOM container of the renderer, its bounds, and its zoom animation.
- *
- * A `Renderer` works as an implicit layer group for all `Path`s - the renderer
- * itself can be added or removed to the map. All paths use a renderer, which can
- * be implicit (the map will decide the type of renderer and use it automatically)
- * or explicit (using the [`renderer`](#path-renderer) option of the path).
- *
- * Do not use this class directly, use `SVG` and `Canvas` instead.
- *
- * @event update: Event
- * Fired when the renderer updates its bounds, center and zoom, for example when
- * its map has moved
- */
+ // update the tooltip (content, layout, ect...)
+ this._tooltip.update();
-L.Renderer = L.Layer.extend({
+ // open the tooltip on the map
+ this._map.openTooltip(this._tooltip, latlng);
- // @section
- // @aka Renderer options
- options: {
- // @option padding: Number = 0.1
- // How much to extend the clip area around the map view (relative to its size)
- // e.g. 0.1 would be 10% of map view in each direction
- padding: 0.1
- },
+ // Tooltip container may not be defined if not permanent and never
+ // opened.
+ if (this._tooltip.options.interactive && this._tooltip._container) {
+ L.DomUtil.addClass(this._tooltip._container, 'leaflet-clickable');
+ this.addInteractiveTarget(this._tooltip._container);
+ }
+ }
- initialize: function (options) {
- L.setOptions(this, options);
- L.stamp(this);
+ return this;
},
- onAdd: function () {
- if (!this._container) {
- this._initContainer(); // defined by renderer implementations
-
- if (this._zoomAnimated) {
- L.DomUtil.addClass(this._container, 'leaflet-zoom-animated');
+ // @method closeTooltip(): this
+ // Closes the tooltip bound to this layer if it is open.
+ closeTooltip: function () {
+ if (this._tooltip) {
+ this._tooltip._close();
+ if (this._tooltip.options.interactive && this._tooltip._container) {
+ L.DomUtil.removeClass(this._tooltip._container, 'leaflet-clickable');
+ this.removeInteractiveTarget(this._tooltip._container);
}
}
-
- this.getPane().appendChild(this._container);
- this._update();
+ return this;
},
- onRemove: function () {
- L.DomUtil.remove(this._container);
+ // @method toggleTooltip(): this
+ // Opens or closes the tooltip bound to this layer depending on its current state.
+ toggleTooltip: function (target) {
+ if (this._tooltip) {
+ if (this._tooltip._map) {
+ this.closeTooltip();
+ } else {
+ this.openTooltip(target);
+ }
+ }
+ return this;
},
- getEvents: function () {
- var events = {
- viewreset: this._reset,
- zoom: this._onZoom,
- moveend: this._update
- };
- if (this._zoomAnimated) {
- events.zoomanim = this._onAnimZoom;
- }
- return events;
- },
-
- _onAnimZoom: function (ev) {
- this._updateTransform(ev.center, ev.zoom);
- },
-
- _onZoom: function () {
- this._updateTransform(this._map.getCenter(), this._map.getZoom());
- },
-
- _updateTransform: function (center, zoom) {
- var scale = this._map.getZoomScale(zoom, this._zoom),
- position = L.DomUtil.getPosition(this._container),
- viewHalf = this._map.getSize().multiplyBy(0.5 + this.options.padding),
- currentCenterPoint = this._map.project(this._center, zoom),
- destCenterPoint = this._map.project(center, zoom),
- centerOffset = destCenterPoint.subtract(currentCenterPoint),
-
- topLeftOffset = viewHalf.multiplyBy(-scale).add(position).add(viewHalf).subtract(centerOffset);
-
- if (L.Browser.any3d) {
- L.DomUtil.setTransform(this._container, topLeftOffset, scale);
- } else {
- L.DomUtil.setPosition(this._container, topLeftOffset);
- }
- },
-
- _reset: function () {
- this._update();
- this._updateTransform(this._center, this._zoom);
- },
-
- _update: function () {
- // Update pixel bounds of renderer container (for positioning/sizing/clipping later)
- // Subclasses are responsible of firing the 'update' event.
- var p = this.options.padding,
- size = this._map.getSize(),
- min = this._map.containerPointToLayerPoint(size.multiplyBy(-p)).round();
-
- this._bounds = new L.Bounds(min, min.add(size.multiplyBy(1 + p * 2)).round());
-
- this._center = this._map.getCenter();
- this._zoom = this._map.getZoom();
- }
-});
-
-
-L.Map.include({
- // @namespace Map; @method getRenderer(layer: Path): Renderer
- // Returns the instance of `Renderer` that should be used to render the given
- // `Path`. It will ensure that the `renderer` options of the map and paths
- // are respected, and that the renderers do exist on the map.
- getRenderer: function (layer) {
- // @namespace Path; @option renderer: Renderer
- // Use this specific instance of `Renderer` for this path. Takes
- // precedence over the map's [default renderer](#map-renderer).
- var renderer = layer.options.renderer || this._getPaneRenderer(layer.options.pane) || this.options.renderer || this._renderer;
-
- if (!renderer) {
- // @namespace Map; @option preferCanvas: Boolean = false
- // Whether `Path`s should be rendered on a `Canvas` renderer.
- // By default, all `Path`s are rendered in a `SVG` renderer.
- renderer = this._renderer = (this.options.preferCanvas && L.canvas()) || L.svg();
- }
-
- if (!this.hasLayer(renderer)) {
- this.addLayer(renderer);
- }
- return renderer;
- },
-
- _getPaneRenderer: function (name) {
- if (name === 'overlayPane' || name === undefined) {
- return false;
- }
-
- var renderer = this._paneRenderers[name];
- if (renderer === undefined) {
- renderer = (L.SVG && L.svg({pane: name})) || (L.Canvas && L.canvas({pane: name}));
- this._paneRenderers[name] = renderer;
- }
- return renderer;
- }
-});
-
-
-
-/*
- * @class Path
- * @aka L.Path
- * @inherits Interactive layer
- *
- * An abstract class that contains options and constants shared between vector
- * overlays (Polygon, Polyline, Circle). Do not use it directly. Extends `Layer`.
- */
-
-L.Path = L.Layer.extend({
-
- // @section
- // @aka Path options
- options: {
- // @option stroke: Boolean = true
- // Whether to draw stroke along the path. Set it to `false` to disable borders on polygons or circles.
- stroke: true,
-
- // @option color: String = '#3388ff'
- // Stroke color
- color: '#3388ff',
-
- // @option weight: Number = 3
- // Stroke width in pixels
- weight: 3,
-
- // @option opacity: Number = 1.0
- // Stroke opacity
- opacity: 1,
-
- // @option lineCap: String= 'round'
- // A string that defines [shape to be used at the end](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap) of the stroke.
- lineCap: 'round',
-
- // @option lineJoin: String = 'round'
- // A string that defines [shape to be used at the corners](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin) of the stroke.
- lineJoin: 'round',
-
- // @option dashArray: String = null
- // A string that defines the stroke [dash pattern](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dasharray). Doesn't work on `Canvas`-powered layers in [some old browsers](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility).
- dashArray: null,
-
- // @option dashOffset: String = null
- // A string that defines the [distance into the dash pattern to start the dash](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset). Doesn't work on `Canvas`-powered layers in [some old browsers](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility).
- dashOffset: null,
-
- // @option fill: Boolean = depends
- // Whether to fill the path with color. Set it to `false` to disable filling on polygons or circles.
- fill: false,
-
- // @option fillColor: String = *
- // Fill color. Defaults to the value of the [`color`](#path-color) option
- fillColor: null,
-
- // @option fillOpacity: Number = 0.2
- // Fill opacity.
- fillOpacity: 0.2,
-
- // @option fillRule: String = 'evenodd'
- // A string that defines [how the inside of a shape](https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule) is determined.
- fillRule: 'evenodd',
-
- // className: '',
-
- // Option inherited from "Interactive layer" abstract class
- interactive: true
- },
-
- beforeAdd: function (map) {
- // Renderer is set here because we need to call renderer.getEvents
- // before this.getEvents.
- this._renderer = map.getRenderer(this);
- },
-
- onAdd: function () {
- this._renderer._initPath(this);
- this._reset();
- this._renderer._addPath(this);
- this._renderer.on('update', this._update, this);
- },
-
- onRemove: function () {
- this._renderer._removePath(this);
- this._renderer.off('update', this._update, this);
- },
-
- getEvents: function () {
- return {
- zoomend: this._project,
- viewreset: this._reset
- };
- },
-
- // @method redraw(): this
- // Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.
- redraw: function () {
- if (this._map) {
- this._renderer._updatePath(this);
- }
- return this;
- },
-
- // @method setStyle(style: Path options): this
- // Changes the appearance of a Path based on the options in the `Path options` object.
- setStyle: function (style) {
- L.setOptions(this, style);
- if (this._renderer) {
- this._renderer._updateStyle(this);
- }
- return this;
- },
-
- // @method bringToFront(): this
- // Brings the layer to the top of all path layers.
- bringToFront: function () {
- if (this._renderer) {
- this._renderer._bringToFront(this);
- }
- return this;
- },
-
- // @method bringToBack(): this
- // Brings the layer to the bottom of all path layers.
- bringToBack: function () {
- if (this._renderer) {
- this._renderer._bringToBack(this);
- }
- return this;
- },
-
- getElement: function () {
- return this._path;
- },
-
- _reset: function () {
- // defined in children classes
- this._project();
- this._update();
- },
-
- _clickTolerance: function () {
- // used when doing hit detection for Canvas layers
- return (this.options.stroke ? this.options.weight / 2 : 0) + (L.Browser.touch ? 10 : 0);
- }
-});
-
-
-
-/*
- * @namespace LineUtil
- *
- * Various utility functions for polyine points processing, used by Leaflet internally to make polylines lightning-fast.
- */
-
-L.LineUtil = {
-
- // Simplify polyline with vertex reduction and Douglas-Peucker simplification.
- // Improves rendering performance dramatically by lessening the number of points to draw.
-
- // @function simplify(points: Point[], tolerance: Number): Point[]
- // Dramatically reduces the number of points in a polyline while retaining
- // its shape and returns a new array of simplified points, using the
- // [Douglas-Peucker algorithm](http://en.wikipedia.org/wiki/Douglas-Peucker_algorithm).
- // Used for a huge performance boost when processing/displaying Leaflet polylines for
- // each zoom level and also reducing visual noise. tolerance affects the amount of
- // simplification (lesser value means higher quality but slower and with more points).
- // Also released as a separated micro-library [Simplify.js](http://mourner.github.com/simplify-js/).
- simplify: function (points, tolerance) {
- if (!tolerance || !points.length) {
- return points.slice();
- }
-
- var sqTolerance = tolerance * tolerance;
-
- // stage 1: vertex reduction
- points = this._reducePoints(points, sqTolerance);
-
- // stage 2: Douglas-Peucker simplification
- points = this._simplifyDP(points, sqTolerance);
-
- return points;
- },
-
- // @function pointToSegmentDistance(p: Point, p1: Point, p2: Point): Number
- // Returns the distance between point `p` and segment `p1` to `p2`.
- pointToSegmentDistance: function (p, p1, p2) {
- return Math.sqrt(this._sqClosestPointOnSegment(p, p1, p2, true));
- },
-
- // @function closestPointOnSegment(p: Point, p1: Point, p2: Point): Number
- // Returns the closest point from a point `p` on a segment `p1` to `p2`.
- closestPointOnSegment: function (p, p1, p2) {
- return this._sqClosestPointOnSegment(p, p1, p2);
- },
-
- // Douglas-Peucker simplification, see http://en.wikipedia.org/wiki/Douglas-Peucker_algorithm
- _simplifyDP: function (points, sqTolerance) {
-
- var len = points.length,
- ArrayConstructor = typeof Uint8Array !== undefined + '' ? Uint8Array : Array,
- markers = new ArrayConstructor(len);
-
- markers[0] = markers[len - 1] = 1;
-
- this._simplifyDPStep(points, markers, sqTolerance, 0, len - 1);
-
- var i,
- newPoints = [];
-
- for (i = 0; i < len; i++) {
- if (markers[i]) {
- newPoints.push(points[i]);
- }
- }
-
- return newPoints;
- },
-
- _simplifyDPStep: function (points, markers, sqTolerance, first, last) {
-
- var maxSqDist = 0,
- index, i, sqDist;
-
- for (i = first + 1; i <= last - 1; i++) {
- sqDist = this._sqClosestPointOnSegment(points[i], points[first], points[last], true);
-
- if (sqDist > maxSqDist) {
- index = i;
- maxSqDist = sqDist;
- }
- }
-
- if (maxSqDist > sqTolerance) {
- markers[index] = 1;
-
- this._simplifyDPStep(points, markers, sqTolerance, first, index);
- this._simplifyDPStep(points, markers, sqTolerance, index, last);
- }
- },
-
- // reduce points that are too close to each other to a single point
- _reducePoints: function (points, sqTolerance) {
- var reducedPoints = [points[0]];
-
- for (var i = 1, prev = 0, len = points.length; i < len; i++) {
- if (this._sqDist(points[i], points[prev]) > sqTolerance) {
- reducedPoints.push(points[i]);
- prev = i;
- }
- }
- if (prev < len - 1) {
- reducedPoints.push(points[len - 1]);
- }
- return reducedPoints;
- },
-
-
- // @function clipSegment(a: Point, b: Point, bounds: Bounds, useLastCode?: Boolean, round?: Boolean): Point[]|Boolean
- // Clips the segment a to b by rectangular bounds with the
- // [Cohen-Sutherland algorithm](https://en.wikipedia.org/wiki/Cohen%E2%80%93Sutherland_algorithm)
- // (modifying the segment points directly!). Used by Leaflet to only show polyline
- // points that are on the screen or near, increasing performance.
- clipSegment: function (a, b, bounds, useLastCode, round) {
- var codeA = useLastCode ? this._lastCode : this._getBitCode(a, bounds),
- codeB = this._getBitCode(b, bounds),
-
- codeOut, p, newCode;
-
- // save 2nd code to avoid calculating it on the next segment
- this._lastCode = codeB;
-
- while (true) {
- // if a,b is inside the clip window (trivial accept)
- if (!(codeA | codeB)) {
- return [a, b];
- }
-
- // if a,b is outside the clip window (trivial reject)
- if (codeA & codeB) {
- return false;
- }
-
- // other cases
- codeOut = codeA || codeB;
- p = this._getEdgeIntersection(a, b, codeOut, bounds, round);
- newCode = this._getBitCode(p, bounds);
-
- if (codeOut === codeA) {
- a = p;
- codeA = newCode;
- } else {
- b = p;
- codeB = newCode;
- }
- }
- },
-
- _getEdgeIntersection: function (a, b, code, bounds, round) {
- var dx = b.x - a.x,
- dy = b.y - a.y,
- min = bounds.min,
- max = bounds.max,
- x, y;
-
- if (code & 8) { // top
- x = a.x + dx * (max.y - a.y) / dy;
- y = max.y;
-
- } else if (code & 4) { // bottom
- x = a.x + dx * (min.y - a.y) / dy;
- y = min.y;
-
- } else if (code & 2) { // right
- x = max.x;
- y = a.y + dy * (max.x - a.x) / dx;
-
- } else if (code & 1) { // left
- x = min.x;
- y = a.y + dy * (min.x - a.x) / dx;
- }
-
- return new L.Point(x, y, round);
- },
-
- _getBitCode: function (p, bounds) {
- var code = 0;
-
- if (p.x < bounds.min.x) { // left
- code |= 1;
- } else if (p.x > bounds.max.x) { // right
- code |= 2;
- }
-
- if (p.y < bounds.min.y) { // bottom
- code |= 4;
- } else if (p.y > bounds.max.y) { // top
- code |= 8;
- }
-
- return code;
- },
-
- // square distance (to avoid unnecessary Math.sqrt calls)
- _sqDist: function (p1, p2) {
- var dx = p2.x - p1.x,
- dy = p2.y - p1.y;
- return dx * dx + dy * dy;
- },
-
- // return closest point on segment or distance to that point
- _sqClosestPointOnSegment: function (p, p1, p2, sqDist) {
- var x = p1.x,
- y = p1.y,
- dx = p2.x - x,
- dy = p2.y - y,
- dot = dx * dx + dy * dy,
- t;
-
- if (dot > 0) {
- t = ((p.x - x) * dx + (p.y - y) * dy) / dot;
-
- if (t > 1) {
- x = p2.x;
- y = p2.y;
- } else if (t > 0) {
- x += dx * t;
- y += dy * t;
- }
- }
-
- dx = p.x - x;
- dy = p.y - y;
-
- return sqDist ? dx * dx + dy * dy : new L.Point(x, y);
- }
-};
-
-
-
-/*
- * @class Polyline
- * @aka L.Polyline
- * @inherits Path
- *
- * A class for drawing polyline overlays on a map. Extends `Path`.
- *
- * @example
- *
- * ```js
- * // create a red polyline from an array of LatLng points
- * var latlngs = [
- * [-122.68, 45.51],
- * [-122.43, 37.77],
- * [-118.2, 34.04]
- * ];
- *
- * var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
- *
- * // zoom the map to the polyline
- * map.fitBounds(polyline.getBounds());
- * ```
- *
- * You can also pass a multi-dimensional array to represent a `MultiPolyline` shape:
- *
- * ```js
- * // create a red polyline from an array of arrays of LatLng points
- * var latlngs = [
- * [[-122.68, 45.51],
- * [-122.43, 37.77],
- * [-118.2, 34.04]],
- * [[-73.91, 40.78],
- * [-87.62, 41.83],
- * [-96.72, 32.76]]
- * ];
- * ```
- */
-
-L.Polyline = L.Path.extend({
-
- // @section
- // @aka Polyline options
- options: {
- // @option smoothFactor: Number = 1.0
- // How much to simplify the polyline on each zoom level. More means
- // better performance and smoother look, and less means more accurate representation.
- smoothFactor: 1.0,
-
- // @option noClip: Boolean = false
- // Disable polyline clipping.
- noClip: false
- },
-
- initialize: function (latlngs, options) {
- L.setOptions(this, options);
- this._setLatLngs(latlngs);
- },
-
- // @method getLatLngs(): LatLng[]
- // Returns an array of the points in the path, or nested arrays of points in case of multi-polyline.
- getLatLngs: function () {
- return this._latlngs;
- },
-
- // @method setLatLngs(latlngs: LatLng[]): this
- // Replaces all the points in the polyline with the given array of geographical points.
- setLatLngs: function (latlngs) {
- this._setLatLngs(latlngs);
- return this.redraw();
- },
-
- // @method isEmpty(): Boolean
- // Returns `true` if the Polyline has no LatLngs.
- isEmpty: function () {
- return !this._latlngs.length;
- },
-
- closestLayerPoint: function (p) {
- var minDistance = Infinity,
- minPoint = null,
- closest = L.LineUtil._sqClosestPointOnSegment,
- p1, p2;
-
- for (var j = 0, jLen = this._parts.length; j < jLen; j++) {
- var points = this._parts[j];
-
- for (var i = 1, len = points.length; i < len; i++) {
- p1 = points[i - 1];
- p2 = points[i];
-
- var sqDist = closest(p, p1, p2, true);
-
- if (sqDist < minDistance) {
- minDistance = sqDist;
- minPoint = closest(p, p1, p2);
- }
- }
- }
- if (minPoint) {
- minPoint.distance = Math.sqrt(minDistance);
- }
- return minPoint;
- },
-
- // @method getCenter(): LatLng
- // Returns the center ([centroid](http://en.wikipedia.org/wiki/Centroid)) of the polyline.
- getCenter: function () {
- // throws error when not yet added to map as this center calculation requires projected coordinates
- if (!this._map) {
- throw new Error('Must add layer to map before using getCenter()');
- }
-
- var i, halfDist, segDist, dist, p1, p2, ratio,
- points = this._rings[0],
- len = points.length;
-
- if (!len) { return null; }
-
- // polyline centroid algorithm; only uses the first ring if there are multiple
-
- for (i = 0, halfDist = 0; i < len - 1; i++) {
- halfDist += points[i].distanceTo(points[i + 1]) / 2;
- }
-
- // The line is so small in the current view that all points are on the same pixel.
- if (halfDist === 0) {
- return this._map.layerPointToLatLng(points[0]);
- }
-
- for (i = 0, dist = 0; i < len - 1; i++) {
- p1 = points[i];
- p2 = points[i + 1];
- segDist = p1.distanceTo(p2);
- dist += segDist;
-
- if (dist > halfDist) {
- ratio = (dist - halfDist) / segDist;
- return this._map.layerPointToLatLng([
- p2.x - ratio * (p2.x - p1.x),
- p2.y - ratio * (p2.y - p1.y)
- ]);
- }
- }
- },
-
- // @method getBounds(): LatLngBounds
- // Returns the `LatLngBounds` of the path.
- getBounds: function () {
- return this._bounds;
- },
-
- // @method addLatLng(latlng: LatLng, latlngs? LatLng[]): this
- // Adds a given point to the polyline. By default, adds to the first ring of
- // the polyline in case of a multi-polyline, but can be overridden by passing
- // a specific ring as a LatLng array (that you can earlier access with [`getLatLngs`](#polyline-getlatlngs)).
- addLatLng: function (latlng, latlngs) {
- latlngs = latlngs || this._defaultShape();
- latlng = L.latLng(latlng);
- latlngs.push(latlng);
- this._bounds.extend(latlng);
- return this.redraw();
- },
-
- _setLatLngs: function (latlngs) {
- this._bounds = new L.LatLngBounds();
- this._latlngs = this._convertLatLngs(latlngs);
- },
-
- _defaultShape: function () {
- return L.Polyline._flat(this._latlngs) ? this._latlngs : this._latlngs[0];
- },
-
- // recursively convert latlngs input into actual LatLng instances; calculate bounds along the way
- _convertLatLngs: function (latlngs) {
- var result = [],
- flat = L.Polyline._flat(latlngs);
-
- for (var i = 0, len = latlngs.length; i < len; i++) {
- if (flat) {
- result[i] = L.latLng(latlngs[i]);
- this._bounds.extend(result[i]);
- } else {
- result[i] = this._convertLatLngs(latlngs[i]);
- }
- }
-
- return result;
- },
-
- _project: function () {
- var pxBounds = new L.Bounds();
- this._rings = [];
- this._projectLatlngs(this._latlngs, this._rings, pxBounds);
-
- var w = this._clickTolerance(),
- p = new L.Point(w, w);
-
- if (this._bounds.isValid() && pxBounds.isValid()) {
- pxBounds.min._subtract(p);
- pxBounds.max._add(p);
- this._pxBounds = pxBounds;
- }
- },
-
- // recursively turns latlngs into a set of rings with projected coordinates
- _projectLatlngs: function (latlngs, result, projectedBounds) {
- var flat = latlngs[0] instanceof L.LatLng,
- len = latlngs.length,
- i, ring;
-
- if (flat) {
- ring = [];
- for (i = 0; i < len; i++) {
- ring[i] = this._map.latLngToLayerPoint(latlngs[i]);
- projectedBounds.extend(ring[i]);
- }
- result.push(ring);
- } else {
- for (i = 0; i < len; i++) {
- this._projectLatlngs(latlngs[i], result, projectedBounds);
- }
- }
- },
-
- // clip polyline by renderer bounds so that we have less to render for performance
- _clipPoints: function () {
- var bounds = this._renderer._bounds;
-
- this._parts = [];
- if (!this._pxBounds || !this._pxBounds.intersects(bounds)) {
- return;
- }
-
- if (this.options.noClip) {
- this._parts = this._rings;
- return;
- }
-
- var parts = this._parts,
- i, j, k, len, len2, segment, points;
-
- for (i = 0, k = 0, len = this._rings.length; i < len; i++) {
- points = this._rings[i];
-
- for (j = 0, len2 = points.length; j < len2 - 1; j++) {
- segment = L.LineUtil.clipSegment(points[j], points[j + 1], bounds, j, true);
-
- if (!segment) { continue; }
-
- parts[k] = parts[k] || [];
- parts[k].push(segment[0]);
-
- // if segment goes out of screen, or it's the last one, it's the end of the line part
- if ((segment[1] !== points[j + 1]) || (j === len2 - 2)) {
- parts[k].push(segment[1]);
- k++;
- }
- }
- }
- },
-
- // simplify each clipped part of the polyline for performance
- _simplifyPoints: function () {
- var parts = this._parts,
- tolerance = this.options.smoothFactor;
-
- for (var i = 0, len = parts.length; i < len; i++) {
- parts[i] = L.LineUtil.simplify(parts[i], tolerance);
- }
- },
-
- _update: function () {
- if (!this._map) { return; }
-
- this._clipPoints();
- this._simplifyPoints();
- this._updatePath();
- },
-
- _updatePath: function () {
- this._renderer._updatePoly(this);
- }
-});
-
-// @factory L.polyline(latlngs: LatLng[], options?: Polyline options)
-// Instantiates a polyline object given an array of geographical points and
-// optionally an options object. You can create a `Polyline` object with
-// multiple separate lines (`MultiPolyline`) by passing an array of arrays
-// of geographic points.
-L.polyline = function (latlngs, options) {
- return new L.Polyline(latlngs, options);
-};
-
-L.Polyline._flat = function (latlngs) {
- // true if it's a flat array of latlngs; false if nested
- return !L.Util.isArray(latlngs[0]) || (typeof latlngs[0][0] !== 'object' && typeof latlngs[0][0] !== 'undefined');
-};
-
-
-
-/*
- * @namespace PolyUtil
- * Various utility functions for polygon geometries.
- */
-
-L.PolyUtil = {};
-
-/* @function clipPolygon(points: Point[], bounds: Bounds, round?: Boolean): Point[]
- * Clips the polygon geometry defined by the given `points` by the given bounds (using the [Sutherland-Hodgeman algorithm](https://en.wikipedia.org/wiki/Sutherland%E2%80%93Hodgman_algorithm)).
- * Used by Leaflet to only show polygon points that are on the screen or near, increasing
- * performance. Note that polygon points needs different algorithm for clipping
- * than polyline, so there's a seperate method for it.
- */
-L.PolyUtil.clipPolygon = function (points, bounds, round) {
- var clippedPoints,
- edges = [1, 4, 2, 8],
- i, j, k,
- a, b,
- len, edge, p,
- lu = L.LineUtil;
-
- for (i = 0, len = points.length; i < len; i++) {
- points[i]._code = lu._getBitCode(points[i], bounds);
- }
-
- // for each edge (left, bottom, right, top)
- for (k = 0; k < 4; k++) {
- edge = edges[k];
- clippedPoints = [];
-
- for (i = 0, len = points.length, j = len - 1; i < len; j = i++) {
- a = points[i];
- b = points[j];
-
- // if a is inside the clip window
- if (!(a._code & edge)) {
- // if b is outside the clip window (a->b goes out of screen)
- if (b._code & edge) {
- p = lu._getEdgeIntersection(b, a, edge, bounds, round);
- p._code = lu._getBitCode(p, bounds);
- clippedPoints.push(p);
- }
- clippedPoints.push(a);
-
- // else if b is inside the clip window (a->b enters the screen)
- } else if (!(b._code & edge)) {
- p = lu._getEdgeIntersection(b, a, edge, bounds, round);
- p._code = lu._getBitCode(p, bounds);
- clippedPoints.push(p);
- }
- }
- points = clippedPoints;
- }
-
- return points;
-};
-
-
-
-/*
- * @class Polygon
- * @aka L.Polygon
- * @inherits Polyline
- *
- * A class for drawing polygon overlays on a map. Extends `Polyline`.
- *
- * Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points.
- *
- *
- * @example
- *
- * ```js
- * // create a red polygon from an array of LatLng points
- * var latlngs = [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]];
- *
- * var polygon = L.polygon(latlngs, {color: 'red'}).addTo(map);
- *
- * // zoom the map to the polygon
- * map.fitBounds(polygon.getBounds());
- * ```
- *
- * You can also pass an array of arrays of latlngs, with the first array representing the outer shape and the other arrays representing holes in the outer shape:
- *
- * ```js
- * var latlngs = [
- * [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]], // outer ring
- * [[-108.58,37.29],[-108.58,40.71],[-102.50,40.71],[-102.50,37.29]] // hole
- * ];
- * ```
- *
- * Additionally, you can pass a multi-dimensional array to represent a MultiPolygon shape.
- *
- * ```js
- * var latlngs = [
- * [ // first polygon
- * [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]], // outer ring
- * [[-108.58,37.29],[-108.58,40.71],[-102.50,40.71],[-102.50,37.29]] // hole
- * ],
- * [ // second polygon
- * [[-109.05, 37],[-109.03, 41],[-102.05, 41],[-102.04, 37],[-109.05, 38]]
- * ]
- * ];
- * ```
- */
+ // @method isTooltipOpen(): boolean
+ // Returns `true` if the tooltip bound to this layer is currently open.
+ isTooltipOpen: function () {
+ return this._tooltip.isOpen();
+ },
-L.Polygon = L.Polyline.extend({
+ // @method setTooltipContent(content: String|HTMLElement|Tooltip): this
+ // Sets the content of the tooltip bound to this layer.
+ setTooltipContent: function (content) {
+ if (this._tooltip) {
+ this._tooltip.setContent(content);
+ }
+ return this;
+ },
- options: {
- fill: true
+ // @method getTooltip(): Tooltip
+ // Returns the tooltip bound to this layer.
+ getTooltip: function () {
+ return this._tooltip;
},
- isEmpty: function () {
- return !this._latlngs.length || !this._latlngs[0].length;
+ _openTooltip: function (e) {
+ var layer = e.layer || e.target;
+
+ if (!this._tooltip || !this._map) {
+ return;
+ }
+ this.openTooltip(layer, this._tooltip.options.sticky ? e.latlng : undefined);
},
- getCenter: function () {
- // throws error when not yet added to map as this center calculation requires projected coordinates
- if (!this._map) {
- throw new Error('Must add layer to map before using getCenter()');
+ _moveTooltip: function (e) {
+ var latlng = e.latlng, containerPoint, layerPoint;
+ if (this._tooltip.options.sticky && e.originalEvent) {
+ containerPoint = this._map.mouseEventToContainerPoint(e.originalEvent);
+ layerPoint = this._map.containerPointToLayerPoint(containerPoint);
+ latlng = this._map.layerPointToLatLng(layerPoint);
}
+ this._tooltip.setLatLng(latlng);
+ }
+});
- var i, j, p1, p2, f, area, x, y, center,
- points = this._rings[0],
- len = points.length;
- if (!len) { return null; }
- // polygon centroid algorithm; only uses the first ring if there are multiple
+/*
+ * @class LayerGroup
+ * @aka L.LayerGroup
+ * @inherits Layer
+ *
+ * Used to group several layers and handle them as one. If you add it to the map,
+ * any layers added or removed from the group will be added/removed on the map as
+ * well. Extends `Layer`.
+ *
+ * @example
+ *
+ * ```js
+ * L.layerGroup([marker1, marker2])
+ * .addLayer(polyline)
+ * .addTo(map);
+ * ```
+ */
- area = x = y = 0;
+L.LayerGroup = L.Layer.extend({
- for (i = 0, j = len - 1; i < len; j = i++) {
- p1 = points[i];
- p2 = points[j];
+ initialize: function (layers) {
+ this._layers = {};
- f = p1.y * p2.x - p2.y * p1.x;
- x += (p1.x + p2.x) * f;
- y += (p1.y + p2.y) * f;
- area += f * 3;
- }
+ var i, len;
- if (area === 0) {
- // Polygon is so small that all points are on same pixel.
- center = points[0];
- } else {
- center = [x / area, y / area];
+ if (layers) {
+ for (i = 0, len = layers.length; i < len; i++) {
+ this.addLayer(layers[i]);
+ }
}
- return this._map.layerPointToLatLng(center);
},
- _convertLatLngs: function (latlngs) {
- var result = L.Polyline.prototype._convertLatLngs.call(this, latlngs),
- len = result.length;
+ // @method addLayer(layer: Layer): this
+ // Adds the given layer to the group.
+ addLayer: function (layer) {
+ var id = this.getLayerId(layer);
- // remove last point if it equals first one
- if (len >= 2 && result[0] instanceof L.LatLng && result[0].equals(result[len - 1])) {
- result.pop();
- }
- return result;
- },
+ this._layers[id] = layer;
- _setLatLngs: function (latlngs) {
- L.Polyline.prototype._setLatLngs.call(this, latlngs);
- if (L.Polyline._flat(this._latlngs)) {
- this._latlngs = [this._latlngs];
+ if (this._map) {
+ this._map.addLayer(layer);
}
- },
- _defaultShape: function () {
- return L.Polyline._flat(this._latlngs[0]) ? this._latlngs[0] : this._latlngs[0][0];
+ return this;
},
- _clipPoints: function () {
- // polygons need a different clipping algorithm so we redefine that
+ // @method removeLayer(layer: Layer): this
+ // Removes the given layer from the group.
+ // @alternative
+ // @method removeLayer(id: Number): this
+ // Removes the layer with the given internal ID from the group.
+ removeLayer: function (layer) {
+ var id = layer in this._layers ? layer : this.getLayerId(layer);
- var bounds = this._renderer._bounds,
- w = this.options.weight,
- p = new L.Point(w, w);
+ if (this._map && this._layers[id]) {
+ this._map.removeLayer(this._layers[id]);
+ }
- // increase clip padding by stroke width to avoid stroke on clip edges
- bounds = new L.Bounds(bounds.min.subtract(p), bounds.max.add(p));
+ delete this._layers[id];
- this._parts = [];
- if (!this._pxBounds || !this._pxBounds.intersects(bounds)) {
- return;
- }
+ return this;
+ },
- if (this.options.noClip) {
- this._parts = this._rings;
- return;
- }
+ // @method hasLayer(layer: Layer): Boolean
+ // Returns `true` if the given layer is currently added to the group.
+ hasLayer: function (layer) {
+ return !!layer && (layer in this._layers || this.getLayerId(layer) in this._layers);
+ },
- for (var i = 0, len = this._rings.length, clipped; i < len; i++) {
- clipped = L.PolyUtil.clipPolygon(this._rings[i], bounds, true);
- if (clipped.length) {
- this._parts.push(clipped);
- }
+ // @method clearLayers(): this
+ // Removes all the layers from the group.
+ clearLayers: function () {
+ for (var i in this._layers) {
+ this.removeLayer(this._layers[i]);
}
+ return this;
},
- _updatePath: function () {
- this._renderer._updatePoly(this, true);
- }
-});
-
+ // @method invoke(methodName: String, …): this
+ // Calls `methodName` on every layer contained in this group, passing any
+ // additional parameters. Has no effect if the layers contained do not
+ // implement `methodName`.
+ invoke: function (methodName) {
+ var args = Array.prototype.slice.call(arguments, 1),
+ i, layer;
-// @factory L.polygon(latlngs: LatLng[], options?: Polyline options)
-L.polygon = function (latlngs, options) {
- return new L.Polygon(latlngs, options);
-};
+ for (i in this._layers) {
+ layer = this._layers[i];
+ if (layer[methodName]) {
+ layer[methodName].apply(layer, args);
+ }
+ }
+ return this;
+ },
-/*
- * L.Rectangle extends Polygon and creates a rectangle when passed a LatLngBounds object.
- */
+ onAdd: function (map) {
+ for (var i in this._layers) {
+ map.addLayer(this._layers[i]);
+ }
+ },
-/*
- * @class Rectangle
- * @aka L.Retangle
- * @inherits Polygon
- *
- * A class for drawing rectangle overlays on a map. Extends `Polygon`.
- *
- * @example
- *
- * ```js
- * // define rectangle geographical bounds
- * var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
- *
- * // create an orange rectangle
- * L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
- *
- * // zoom the map to the rectangle bounds
- * map.fitBounds(bounds);
- * ```
- *
- */
+ onRemove: function (map) {
+ for (var i in this._layers) {
+ map.removeLayer(this._layers[i]);
+ }
+ },
+ // @method eachLayer(fn: Function, context?: Object): this
+ // Iterates over the layers of the group, optionally specifying context of the iterator function.
+ // ```js
+ // group.eachLayer(function (layer) {
+ // layer.bindPopup('Hello');
+ // });
+ // ```
+ eachLayer: function (method, context) {
+ for (var i in this._layers) {
+ method.call(context, this._layers[i]);
+ }
+ return this;
+ },
-L.Rectangle = L.Polygon.extend({
- initialize: function (latLngBounds, options) {
- L.Polygon.prototype.initialize.call(this, this._boundsToLatLngs(latLngBounds), options);
+ // @method getLayer(id: Number): Layer
+ // Returns the layer with the given internal ID.
+ getLayer: function (id) {
+ return this._layers[id];
},
- // @method setBounds(latLngBounds: LatLngBounds): this
- // Redraws the rectangle with the passed bounds.
- setBounds: function (latLngBounds) {
- return this.setLatLngs(this._boundsToLatLngs(latLngBounds));
+ // @method getLayers(): Layer[]
+ // Returns an array of all the layers added to the group.
+ getLayers: function () {
+ var layers = [];
+
+ for (var i in this._layers) {
+ layers.push(this._layers[i]);
+ }
+ return layers;
},
- _boundsToLatLngs: function (latLngBounds) {
- latLngBounds = L.latLngBounds(latLngBounds);
- return [
- latLngBounds.getSouthWest(),
- latLngBounds.getNorthWest(),
- latLngBounds.getNorthEast(),
- latLngBounds.getSouthEast()
- ];
+ // @method setZIndex(zIndex: Number): this
+ // Calls `setZIndex` on every layer contained in this group, passing the z-index.
+ setZIndex: function (zIndex) {
+ return this.invoke('setZIndex', zIndex);
+ },
+
+ // @method getLayerId(layer: Layer): Number
+ // Returns the internal ID for a layer
+ getLayerId: function (layer) {
+ return L.stamp(layer);
}
});
-// @factory L.rectangle(latLngBounds: LatLngBounds, options?: Polyline options)
-L.rectangle = function (latLngBounds, options) {
- return new L.Rectangle(latLngBounds, options);
+// @factory L.layerGroup(layers: Layer[])
+// Create a layer group, optionally given an initial set of layers.
+L.layerGroup = function (layers) {
+ return new L.LayerGroup(layers);
};
/*
- * @class CircleMarker
- * @aka L.CircleMarker
- * @inherits Path
+ * @class FeatureGroup
+ * @aka L.FeatureGroup
+ * @inherits LayerGroup
*
- * A circle of a fixed size with radius specified in pixels. Extends `Path`.
+ * Extended `LayerGroup` that makes it easier to do the same thing to all its member layers:
+ * * [`bindPopup`](#layer-bindpopup) binds a popup to all of the layers at once (likewise with [`bindTooltip`](#layer-bindtooltip))
+ * * Events are propagated to the `FeatureGroup`, so if the group has an event
+ * handler, it will handle events from any of the layers. This includes mouse events
+ * and custom events.
+ * * Has `layeradd` and `layerremove` events
+ *
+ * @example
+ *
+ * ```js
+ * L.featureGroup([marker1, marker2, polyline])
+ * .bindPopup('Hello world!')
+ * .on('click', function() { alert('Clicked on a member of the group!'); })
+ * .addTo(map);
+ * ```
*/
-L.CircleMarker = L.Path.extend({
+L.FeatureGroup = L.LayerGroup.extend({
- // @section
- // @aka CircleMarker options
- options: {
- fill: true,
+ addLayer: function (layer) {
+ if (this.hasLayer(layer)) {
+ return this;
+ }
- // @option radius: Number = 10
- // Radius of the circle marker, in pixels
- radius: 10
- },
+ layer.addEventParent(this);
- initialize: function (latlng, options) {
- L.setOptions(this, options);
- this._latlng = L.latLng(latlng);
- this._radius = this.options.radius;
- },
+ L.LayerGroup.prototype.addLayer.call(this, layer);
- // @method setLatLng(latLng: LatLng): this
- // Sets the position of a circle marker to a new location.
- setLatLng: function (latlng) {
- this._latlng = L.latLng(latlng);
- this.redraw();
- return this.fire('move', {latlng: this._latlng});
+ // @event layeradd: LayerEvent
+ // Fired when a layer is added to this `FeatureGroup`
+ return this.fire('layeradd', {layer: layer});
},
- // @method getLatLng(): LatLng
- // Returns the current geographical position of the circle marker
- getLatLng: function () {
- return this._latlng;
- },
+ removeLayer: function (layer) {
+ if (!this.hasLayer(layer)) {
+ return this;
+ }
+ if (layer in this._layers) {
+ layer = this._layers[layer];
+ }
- // @method setRadius(radius: Number): this
- // Sets the radius of a circle marker. Units are in pixels.
- setRadius: function (radius) {
- this.options.radius = this._radius = radius;
- return this.redraw();
- },
+ layer.removeEventParent(this);
- // @method getRadius(): Number
- // Returns the current radius of the circle
- getRadius: function () {
- return this._radius;
- },
+ L.LayerGroup.prototype.removeLayer.call(this, layer);
- setStyle : function (options) {
- var radius = options && options.radius || this._radius;
- L.Path.prototype.setStyle.call(this, options);
- this.setRadius(radius);
- return this;
+ // @event layerremove: LayerEvent
+ // Fired when a layer is removed from this `FeatureGroup`
+ return this.fire('layerremove', {layer: layer});
},
- _project: function () {
- this._point = this._map.latLngToLayerPoint(this._latlng);
- this._updateBounds();
+ // @method setStyle(style: Path options): this
+ // Sets the given path options to each layer of the group that has a `setStyle` method.
+ setStyle: function (style) {
+ return this.invoke('setStyle', style);
},
- _updateBounds: function () {
- var r = this._radius,
- r2 = this._radiusY || r,
- w = this._clickTolerance(),
- p = [r + w, r2 + w];
- this._pxBounds = new L.Bounds(this._point.subtract(p), this._point.add(p));
+ // @method bringToFront(): this
+ // Brings the layer group to the top of all other layers
+ bringToFront: function () {
+ return this.invoke('bringToFront');
},
- _update: function () {
- if (this._map) {
- this._updatePath();
- }
+ // @method bringToBack(): this
+ // Brings the layer group to the top of all other layers
+ bringToBack: function () {
+ return this.invoke('bringToBack');
},
- _updatePath: function () {
- this._renderer._updateCircle(this);
- },
+ // @method getBounds(): LatLngBounds
+ // Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children).
+ getBounds: function () {
+ var bounds = new L.LatLngBounds();
- _empty: function () {
- return this._radius && !this._renderer._bounds.intersects(this._pxBounds);
+ for (var id in this._layers) {
+ var layer = this._layers[id];
+ bounds.extend(layer.getBounds ? layer.getBounds() : layer.getLatLng());
+ }
+ return bounds;
}
});
-
-// @factory L.circleMarker(latlng: LatLng, options?: CircleMarker options)
-// Instantiates a circle marker object given a geographical point, and an optional options object.
-L.circleMarker = function (latlng, options) {
- return new L.CircleMarker(latlng, options);
+// @factory L.featureGroup(layers: Layer[])
+// Create a feature group, optionally given an initial set of layers.
+L.featureGroup = function (layers) {
+ return new L.FeatureGroup(layers);
};
/*
- * @class Circle
- * @aka L.Circle
- * @inherits CircleMarker
+ * @class Renderer
+ * @inherits Layer
+ * @aka L.Renderer
*
- * A class for drawing circle overlays on a map. Extends `CircleMarker`.
+ * Base class for vector renderer implementations (`SVG`, `Canvas`). Handles the
+ * DOM container of the renderer, its bounds, and its zoom animation.
*
- * It's an approximation and starts to diverge from a real circle closer to poles (due to projection distortion).
+ * A `Renderer` works as an implicit layer group for all `Path`s - the renderer
+ * itself can be added or removed to the map. All paths use a renderer, which can
+ * be implicit (the map will decide the type of renderer and use it automatically)
+ * or explicit (using the [`renderer`](#path-renderer) option of the path).
*
- * @example
+ * Do not use this class directly, use `SVG` and `Canvas` instead.
*
- * ```js
- * L.circle([50.5, 30.5], {radius: 200}).addTo(map);
- * ```
+ * @event update: Event
+ * Fired when the renderer updates its bounds, center and zoom, for example when
+ * its map has moved
*/
-L.Circle = L.CircleMarker.extend({
+L.Renderer = L.Layer.extend({
- initialize: function (latlng, options, legacyOptions) {
- if (typeof options === 'number') {
- // Backwards compatibility with 0.7.x factory (latlng, radius, options?)
- options = L.extend({}, legacyOptions, {radius: options});
- }
+ // @section
+ // @aka Renderer options
+ options: {
+ // @option padding: Number = 0.1
+ // How much to extend the clip area around the map view (relative to its size)
+ // e.g. 0.1 would be 10% of map view in each direction
+ padding: 0.1
+ },
+
+ initialize: function (options) {
L.setOptions(this, options);
- this._latlng = L.latLng(latlng);
+ L.stamp(this);
+ this._layers = this._layers || {};
+ },
- if (isNaN(this.options.radius)) { throw new Error('Circle radius cannot be NaN'); }
+ onAdd: function () {
+ if (!this._container) {
+ this._initContainer(); // defined by renderer implementations
- // @section
- // @aka Circle options
- // @option radius: Number; Radius of the circle, in meters.
- this._mRadius = this.options.radius;
+ if (this._zoomAnimated) {
+ L.DomUtil.addClass(this._container, 'leaflet-zoom-animated');
+ }
+ }
+
+ this.getPane().appendChild(this._container);
+ this._update();
+ this.on('update', this._updatePaths, this);
},
- // @method setRadius(radius: Number): this
- // Sets the radius of a circle. Units are in meters.
- setRadius: function (radius) {
- this._mRadius = radius;
- return this.redraw();
+ onRemove: function () {
+ L.DomUtil.remove(this._container);
+ this.off('update', this._updatePaths, this);
},
- // @method getRadius(): Number
- // Returns the current radius of a circle. Units are in meters.
- getRadius: function () {
- return this._mRadius;
+ getEvents: function () {
+ var events = {
+ viewreset: this._reset,
+ zoom: this._onZoom,
+ moveend: this._update,
+ zoomend: this._onZoomEnd
+ };
+ if (this._zoomAnimated) {
+ events.zoomanim = this._onAnimZoom;
+ }
+ return events;
+ },
+
+ _onAnimZoom: function (ev) {
+ this._updateTransform(ev.center, ev.zoom);
+ },
+
+ _onZoom: function () {
+ this._updateTransform(this._map.getCenter(), this._map.getZoom());
+ },
+
+ _updateTransform: function (center, zoom) {
+ var scale = this._map.getZoomScale(zoom, this._zoom),
+ position = L.DomUtil.getPosition(this._container),
+ viewHalf = this._map.getSize().multiplyBy(0.5 + this.options.padding),
+ currentCenterPoint = this._map.project(this._center, zoom),
+ destCenterPoint = this._map.project(center, zoom),
+ centerOffset = destCenterPoint.subtract(currentCenterPoint),
+
+ topLeftOffset = viewHalf.multiplyBy(-scale).add(position).add(viewHalf).subtract(centerOffset);
+
+ if (L.Browser.any3d) {
+ L.DomUtil.setTransform(this._container, topLeftOffset, scale);
+ } else {
+ L.DomUtil.setPosition(this._container, topLeftOffset);
+ }
+ },
+
+ _reset: function () {
+ this._update();
+ this._updateTransform(this._center, this._zoom);
+
+ for (var id in this._layers) {
+ this._layers[id]._reset();
+ }
},
- // @method getBounds(): LatLngBounds
- // Returns the `LatLngBounds` of the path.
- getBounds: function () {
- var half = [this._radius, this._radiusY || this._radius];
+ _onZoomEnd: function () {
+ for (var id in this._layers) {
+ this._layers[id]._project();
+ }
+ },
- return new L.LatLngBounds(
- this._map.layerPointToLatLng(this._point.subtract(half)),
- this._map.layerPointToLatLng(this._point.add(half)));
+ _updatePaths: function () {
+ for (var id in this._layers) {
+ this._layers[id]._update();
+ }
},
- setStyle: L.Path.prototype.setStyle,
+ _update: function () {
+ // Update pixel bounds of renderer container (for positioning/sizing/clipping later)
+ // Subclasses are responsible of firing the 'update' event.
+ var p = this.options.padding,
+ size = this._map.getSize(),
+ min = this._map.containerPointToLayerPoint(size.multiplyBy(-p)).round();
- _project: function () {
+ this._bounds = new L.Bounds(min, min.add(size.multiplyBy(1 + p * 2)).round());
- var lng = this._latlng.lng,
- lat = this._latlng.lat,
- map = this._map,
- crs = map.options.crs;
+ this._center = this._map.getCenter();
+ this._zoom = this._map.getZoom();
+ }
+});
- if (crs.distance === L.CRS.Earth.distance) {
- var d = Math.PI / 180,
- latR = (this._mRadius / L.CRS.Earth.R) / d,
- top = map.project([lat + latR, lng]),
- bottom = map.project([lat - latR, lng]),
- p = top.add(bottom).divideBy(2),
- lat2 = map.unproject(p).lat,
- lngR = Math.acos((Math.cos(latR * d) - Math.sin(lat * d) * Math.sin(lat2 * d)) /
- (Math.cos(lat * d) * Math.cos(lat2 * d))) / d;
- if (isNaN(lngR) || lngR === 0) {
- lngR = latR / Math.cos(Math.PI / 180 * lat); // Fallback for edge case, #2425
- }
+L.Map.include({
+ // @namespace Map; @method getRenderer(layer: Path): Renderer
+ // Returns the instance of `Renderer` that should be used to render the given
+ // `Path`. It will ensure that the `renderer` options of the map and paths
+ // are respected, and that the renderers do exist on the map.
+ getRenderer: function (layer) {
+ // @namespace Path; @option renderer: Renderer
+ // Use this specific instance of `Renderer` for this path. Takes
+ // precedence over the map's [default renderer](#map-renderer).
+ var renderer = layer.options.renderer || this._getPaneRenderer(layer.options.pane) || this.options.renderer || this._renderer;
- this._point = p.subtract(map.getPixelOrigin());
- this._radius = isNaN(lngR) ? 0 : Math.max(Math.round(p.x - map.project([lat2, lng - lngR]).x), 1);
- this._radiusY = Math.max(Math.round(p.y - top.y), 1);
+ if (!renderer) {
+ // @namespace Map; @option preferCanvas: Boolean = false
+ // Whether `Path`s should be rendered on a `Canvas` renderer.
+ // By default, all `Path`s are rendered in a `SVG` renderer.
+ renderer = this._renderer = (this.options.preferCanvas && L.canvas()) || L.svg();
+ }
- } else {
- var latlng2 = crs.unproject(crs.project(this._latlng).subtract([this._mRadius, 0]));
+ if (!this.hasLayer(renderer)) {
+ this.addLayer(renderer);
+ }
+ return renderer;
+ },
- this._point = map.latLngToLayerPoint(this._latlng);
- this._radius = this._point.x - map.latLngToLayerPoint(latlng2).x;
+ _getPaneRenderer: function (name) {
+ if (name === 'overlayPane' || name === undefined) {
+ return false;
}
- this._updateBounds();
+ var renderer = this._paneRenderers[name];
+ if (renderer === undefined) {
+ renderer = (L.SVG && L.svg({pane: name})) || (L.Canvas && L.canvas({pane: name}));
+ this._paneRenderers[name] = renderer;
+ }
+ return renderer;
}
});
-// @factory L.circle(latlng: LatLng, options?: Circle options)
-// Instantiates a circle object given a geographical point, and an options object
-// which contains the circle radius.
-// @alternative
-// @factory L.circle(latlng: LatLng, radius: Number, options?: Circle options)
-// Obsolete way of instantiating a circle, for compatibility with 0.7.x code.
-// Do not use in new applications or plugins.
-L.circle = function (latlng, options, legacyOptions) {
- return new L.Circle(latlng, options, legacyOptions);
-};
-
/*
- * @class SVG
- * @inherits Renderer
- * @aka L.SVG
- *
- * Allows vector layers to be displayed with [SVG](https://developer.mozilla.org/docs/Web/SVG).
- * Inherits `Renderer`.
- *
- * Due to [technical limitations](http://caniuse.com/#search=svg), SVG is not
- * available in all web browsers, notably Android 2.x and 3.x.
- *
- * Although SVG is not available on IE7 and IE8, these browsers support
- * [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language)
- * (a now deprecated technology), and the SVG renderer will fall back to VML in
- * this case.
- *
- * @example
- *
- * Use SVG by default for all paths in the map:
- *
- * ```js
- * var map = L.map('map', {
- * renderer: L.svg()
- * });
- * ```
- *
- * Use a SVG renderer with extra padding for specific vector geometries:
+ * @class Path
+ * @aka L.Path
+ * @inherits Interactive layer
*
- * ```js
- * var map = L.map('map');
- * var myRenderer = L.svg({ padding: 0.5 });
- * var line = L.polyline( coordinates, { renderer: myRenderer } );
- * var circle = L.circle( center, { renderer: myRenderer } );
- * ```
+ * An abstract class that contains options and constants shared between vector
+ * overlays (Polygon, Polyline, Circle). Do not use it directly. Extends `Layer`.
*/
-L.SVG = L.Renderer.extend({
+L.Path = L.Layer.extend({
- getEvents: function () {
- var events = L.Renderer.prototype.getEvents.call(this);
- events.zoomstart = this._onZoomStart;
- return events;
- },
+ // @section
+ // @aka Path options
+ options: {
+ // @option stroke: Boolean = true
+ // Whether to draw stroke along the path. Set it to `false` to disable borders on polygons or circles.
+ stroke: true,
- _initContainer: function () {
- this._container = L.SVG.create('svg');
+ // @option color: String = '#3388ff'
+ // Stroke color
+ color: '#3388ff',
- // makes it possible to click through svg root; we'll reset it back in individual paths
- this._container.setAttribute('pointer-events', 'none');
+ // @option weight: Number = 3
+ // Stroke width in pixels
+ weight: 3,
- this._rootGroup = L.SVG.create('g');
- this._container.appendChild(this._rootGroup);
- },
+ // @option opacity: Number = 1.0
+ // Stroke opacity
+ opacity: 1,
- _onZoomStart: function () {
- // Drag-then-pinch interactions might mess up the center and zoom.
- // In this case, the easiest way to prevent this is re-do the renderer
- // bounds and padding when the zooming starts.
- this._update();
- },
+ // @option lineCap: String= 'round'
+ // A string that defines [shape to be used at the end](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap) of the stroke.
+ lineCap: 'round',
- _update: function () {
- if (this._map._animatingZoom && this._bounds) { return; }
+ // @option lineJoin: String = 'round'
+ // A string that defines [shape to be used at the corners](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin) of the stroke.
+ lineJoin: 'round',
- L.Renderer.prototype._update.call(this);
+ // @option dashArray: String = null
+ // A string that defines the stroke [dash pattern](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dasharray). Doesn't work on `Canvas`-powered layers in [some old browsers](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility).
+ dashArray: null,
- var b = this._bounds,
- size = b.getSize(),
- container = this._container;
+ // @option dashOffset: String = null
+ // A string that defines the [distance into the dash pattern to start the dash](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset). Doesn't work on `Canvas`-powered layers in [some old browsers](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility).
+ dashOffset: null,
- // set size of svg-container if changed
- if (!this._svgSize || !this._svgSize.equals(size)) {
- this._svgSize = size;
- container.setAttribute('width', size.x);
- container.setAttribute('height', size.y);
- }
+ // @option fill: Boolean = depends
+ // Whether to fill the path with color. Set it to `false` to disable filling on polygons or circles.
+ fill: false,
- // movement: update container viewBox so that we don't have to change coordinates of individual layers
- L.DomUtil.setPosition(container, b.min);
- container.setAttribute('viewBox', [b.min.x, b.min.y, size.x, size.y].join(' '));
+ // @option fillColor: String = *
+ // Fill color. Defaults to the value of the [`color`](#path-color) option
+ fillColor: null,
- this.fire('update');
+ // @option fillOpacity: Number = 0.2
+ // Fill opacity.
+ fillOpacity: 0.2,
+
+ // @option fillRule: String = 'evenodd'
+ // A string that defines [how the inside of a shape](https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule) is determined.
+ fillRule: 'evenodd',
+
+ // className: '',
+
+ // Option inherited from "Interactive layer" abstract class
+ interactive: true
},
- // methods below are called by vector layers implementations
+ beforeAdd: function (map) {
+ // Renderer is set here because we need to call renderer.getEvents
+ // before this.getEvents.
+ this._renderer = map.getRenderer(this);
+ },
- _initPath: function (layer) {
- var path = layer._path = L.SVG.create('path');
+ onAdd: function () {
+ this._renderer._initPath(this);
+ this._reset();
+ this._renderer._addPath(this);
+ },
- // @namespace Path
- // @option className: String = null
- // Custom class name set on an element. Only for SVG renderer.
- if (layer.options.className) {
- L.DomUtil.addClass(path, layer.options.className);
+ onRemove: function () {
+ this._renderer._removePath(this);
+ },
+
+ // @method redraw(): this
+ // Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.
+ redraw: function () {
+ if (this._map) {
+ this._renderer._updatePath(this);
+ }
+ return this;
+ },
+
+ // @method setStyle(style: Path options): this
+ // Changes the appearance of a Path based on the options in the `Path options` object.
+ setStyle: function (style) {
+ L.setOptions(this, style);
+ if (this._renderer) {
+ this._renderer._updateStyle(this);
+ }
+ return this;
+ },
+
+ // @method bringToFront(): this
+ // Brings the layer to the top of all path layers.
+ bringToFront: function () {
+ if (this._renderer) {
+ this._renderer._bringToFront(this);
}
+ return this;
+ },
- if (layer.options.interactive) {
- L.DomUtil.addClass(path, 'leaflet-interactive');
+ // @method bringToBack(): this
+ // Brings the layer to the bottom of all path layers.
+ bringToBack: function () {
+ if (this._renderer) {
+ this._renderer._bringToBack(this);
}
-
- this._updateStyle(layer);
+ return this;
},
- _addPath: function (layer) {
- this._rootGroup.appendChild(layer._path);
- layer.addInteractiveTarget(layer._path);
+ getElement: function () {
+ return this._path;
},
- _removePath: function (layer) {
- L.DomUtil.remove(layer._path);
- layer.removeInteractiveTarget(layer._path);
+ _reset: function () {
+ // defined in children classes
+ this._project();
+ this._update();
},
- _updatePath: function (layer) {
- layer._project();
- layer._update();
- },
+ _clickTolerance: function () {
+ // used when doing hit detection for Canvas layers
+ return (this.options.stroke ? this.options.weight / 2 : 0) + (L.Browser.touch ? 10 : 0);
+ }
+});
- _updateStyle: function (layer) {
- var path = layer._path,
- options = layer.options;
- if (!path) { return; }
- if (options.stroke) {
- path.setAttribute('stroke', options.color);
- path.setAttribute('stroke-opacity', options.opacity);
- path.setAttribute('stroke-width', options.weight);
- path.setAttribute('stroke-linecap', options.lineCap);
- path.setAttribute('stroke-linejoin', options.lineJoin);
+/*
+ * @namespace LineUtil
+ *
+ * Various utility functions for polyine points processing, used by Leaflet internally to make polylines lightning-fast.
+ */
- if (options.dashArray) {
- path.setAttribute('stroke-dasharray', options.dashArray);
- } else {
- path.removeAttribute('stroke-dasharray');
- }
+L.LineUtil = {
- if (options.dashOffset) {
- path.setAttribute('stroke-dashoffset', options.dashOffset);
- } else {
- path.removeAttribute('stroke-dashoffset');
- }
- } else {
- path.setAttribute('stroke', 'none');
- }
+ // Simplify polyline with vertex reduction and Douglas-Peucker simplification.
+ // Improves rendering performance dramatically by lessening the number of points to draw.
- if (options.fill) {
- path.setAttribute('fill', options.fillColor || options.color);
- path.setAttribute('fill-opacity', options.fillOpacity);
- path.setAttribute('fill-rule', options.fillRule || 'evenodd');
- } else {
- path.setAttribute('fill', 'none');
+ // @function simplify(points: Point[], tolerance: Number): Point[]
+ // Dramatically reduces the number of points in a polyline while retaining
+ // its shape and returns a new array of simplified points, using the
+ // [Douglas-Peucker algorithm](http://en.wikipedia.org/wiki/Douglas-Peucker_algorithm).
+ // Used for a huge performance boost when processing/displaying Leaflet polylines for
+ // each zoom level and also reducing visual noise. tolerance affects the amount of
+ // simplification (lesser value means higher quality but slower and with more points).
+ // Also released as a separated micro-library [Simplify.js](http://mourner.github.com/simplify-js/).
+ simplify: function (points, tolerance) {
+ if (!tolerance || !points.length) {
+ return points.slice();
}
- },
- _updatePoly: function (layer, closed) {
- this._setPath(layer, L.SVG.pointsToPath(layer._parts, closed));
- },
+ var sqTolerance = tolerance * tolerance;
- _updateCircle: function (layer) {
- var p = layer._point,
- r = layer._radius,
- r2 = layer._radiusY || r,
- arc = 'a' + r + ',' + r2 + ' 0 1,0 ';
+ // stage 1: vertex reduction
+ points = this._reducePoints(points, sqTolerance);
- // drawing a circle with two half-arcs
- var d = layer._empty() ? 'M0 0' :
- 'M' + (p.x - r) + ',' + p.y +
- arc + (r * 2) + ',0 ' +
- arc + (-r * 2) + ',0 ';
+ // stage 2: Douglas-Peucker simplification
+ points = this._simplifyDP(points, sqTolerance);
- this._setPath(layer, d);
+ return points;
},
- _setPath: function (layer, path) {
- layer._path.setAttribute('d', path);
+ // @function pointToSegmentDistance(p: Point, p1: Point, p2: Point): Number
+ // Returns the distance between point `p` and segment `p1` to `p2`.
+ pointToSegmentDistance: function (p, p1, p2) {
+ return Math.sqrt(this._sqClosestPointOnSegment(p, p1, p2, true));
},
- // SVG does not have the concept of zIndex so we resort to changing the DOM order of elements
- _bringToFront: function (layer) {
- L.DomUtil.toFront(layer._path);
+ // @function closestPointOnSegment(p: Point, p1: Point, p2: Point): Number
+ // Returns the closest point from a point `p` on a segment `p1` to `p2`.
+ closestPointOnSegment: function (p, p1, p2) {
+ return this._sqClosestPointOnSegment(p, p1, p2);
},
- _bringToBack: function (layer) {
- L.DomUtil.toBack(layer._path);
- }
-});
+ // Douglas-Peucker simplification, see http://en.wikipedia.org/wiki/Douglas-Peucker_algorithm
+ _simplifyDP: function (points, sqTolerance) {
+ var len = points.length,
+ ArrayConstructor = typeof Uint8Array !== undefined + '' ? Uint8Array : Array,
+ markers = new ArrayConstructor(len);
-// @namespace SVG; @section
-// There are several static functions which can be called without instantiating L.SVG:
-L.extend(L.SVG, {
- // @function create(name: String): SVGElement
- // Returns a instance of [SVGElement](https://developer.mozilla.org/docs/Web/API/SVGElement),
- // corresponding to the class name passed. For example, using 'line' will return
- // an instance of [SVGLineElement](https://developer.mozilla.org/docs/Web/API/SVGLineElement).
- create: function (name) {
- return document.createElementNS('http://www.w3.org/2000/svg', name);
- },
+ markers[0] = markers[len - 1] = 1;
- // @function pointsToPath(rings: Point[], closed: Boolean): String
- // Generates a SVG path string for multiple rings, with each ring turning
- // into "M..L..L.." instructions
- pointsToPath: function (rings, closed) {
- var str = '',
- i, j, len, len2, points, p;
+ this._simplifyDPStep(points, markers, sqTolerance, 0, len - 1);
- for (i = 0, len = rings.length; i < len; i++) {
- points = rings[i];
+ var i,
+ newPoints = [];
- for (j = 0, len2 = points.length; j < len2; j++) {
- p = points[j];
- str += (j ? 'L' : 'M') + p.x + ' ' + p.y;
+ for (i = 0; i < len; i++) {
+ if (markers[i]) {
+ newPoints.push(points[i]);
}
-
- // closes the ring for polygons; "x" is VML syntax
- str += closed ? (L.Browser.svg ? 'z' : 'x') : '';
}
- // SVG complains about empty path strings
- return str || 'M0 0';
- }
-});
-
-// @namespace Browser; @property svg: Boolean
-// `true` when the browser supports [SVG](https://developer.mozilla.org/docs/Web/SVG).
-L.Browser.svg = !!(document.createElementNS && L.SVG.create('svg').createSVGRect);
-
-
-// @namespace SVG
-// @factory L.svg(options?: Renderer options)
-// Creates a SVG renderer with the given options.
-L.svg = function (options) {
- return L.Browser.svg || L.Browser.vml ? new L.SVG(options) : null;
-};
-
-
+ return newPoints;
+ },
-/*
- * Thanks to Dmitry Baranovsky and his Raphael library for inspiration!
- */
+ _simplifyDPStep: function (points, markers, sqTolerance, first, last) {
-/*
- * @class SVG
- *
- * Although SVG is not available on IE7 and IE8, these browsers support [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language), and the SVG renderer will fall back to VML in this case.
- *
- * VML was deprecated in 2012, which means VML functionality exists only for backwards compatibility
- * with old versions of Internet Explorer.
- */
+ var maxSqDist = 0,
+ index, i, sqDist;
-// @namespace Browser; @property vml: Boolean
-// `true` if the browser supports [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language).
-L.Browser.vml = !L.Browser.svg && (function () {
- try {
- var div = document.createElement('div');
- div.innerHTML = '<v:shape adj="1"/>';
+ for (i = first + 1; i <= last - 1; i++) {
+ sqDist = this._sqClosestPointOnSegment(points[i], points[first], points[last], true);
- var shape = div.firstChild;
- shape.style.behavior = 'url(#default#VML)';
+ if (sqDist > maxSqDist) {
+ index = i;
+ maxSqDist = sqDist;
+ }
+ }
- return shape && (typeof shape.adj === 'object');
+ if (maxSqDist > sqTolerance) {
+ markers[index] = 1;
- } catch (e) {
- return false;
- }
-}());
+ this._simplifyDPStep(points, markers, sqTolerance, first, index);
+ this._simplifyDPStep(points, markers, sqTolerance, index, last);
+ }
+ },
-// redefine some SVG methods to handle VML syntax which is similar but with some differences
-L.SVG.include(!L.Browser.vml ? {} : {
+ // reduce points that are too close to each other to a single point
+ _reducePoints: function (points, sqTolerance) {
+ var reducedPoints = [points[0]];
- _initContainer: function () {
- this._container = L.DomUtil.create('div', 'leaflet-vml-container');
+ for (var i = 1, prev = 0, len = points.length; i < len; i++) {
+ if (this._sqDist(points[i], points[prev]) > sqTolerance) {
+ reducedPoints.push(points[i]);
+ prev = i;
+ }
+ }
+ if (prev < len - 1) {
+ reducedPoints.push(points[len - 1]);
+ }
+ return reducedPoints;
},
- _update: function () {
- if (this._map._animatingZoom) { return; }
- L.Renderer.prototype._update.call(this);
- this.fire('update');
- },
- _initPath: function (layer) {
- var container = layer._container = L.SVG.create('shape');
+ // @function clipSegment(a: Point, b: Point, bounds: Bounds, useLastCode?: Boolean, round?: Boolean): Point[]|Boolean
+ // Clips the segment a to b by rectangular bounds with the
+ // [Cohen-Sutherland algorithm](https://en.wikipedia.org/wiki/Cohen%E2%80%93Sutherland_algorithm)
+ // (modifying the segment points directly!). Used by Leaflet to only show polyline
+ // points that are on the screen or near, increasing performance.
+ clipSegment: function (a, b, bounds, useLastCode, round) {
+ var codeA = useLastCode ? this._lastCode : this._getBitCode(a, bounds),
+ codeB = this._getBitCode(b, bounds),
- L.DomUtil.addClass(container, 'leaflet-vml-shape ' + (this.options.className || ''));
+ codeOut, p, newCode;
- container.coordsize = '1 1';
+ // save 2nd code to avoid calculating it on the next segment
+ this._lastCode = codeB;
- layer._path = L.SVG.create('path');
- container.appendChild(layer._path);
+ while (true) {
+ // if a,b is inside the clip window (trivial accept)
+ if (!(codeA | codeB)) {
+ return [a, b];
+ }
- this._updateStyle(layer);
- },
+ // if a,b is outside the clip window (trivial reject)
+ if (codeA & codeB) {
+ return false;
+ }
- _addPath: function (layer) {
- var container = layer._container;
- this._container.appendChild(container);
+ // other cases
+ codeOut = codeA || codeB;
+ p = this._getEdgeIntersection(a, b, codeOut, bounds, round);
+ newCode = this._getBitCode(p, bounds);
- if (layer.options.interactive) {
- layer.addInteractiveTarget(container);
+ if (codeOut === codeA) {
+ a = p;
+ codeA = newCode;
+ } else {
+ b = p;
+ codeB = newCode;
+ }
}
},
- _removePath: function (layer) {
- var container = layer._container;
- L.DomUtil.remove(container);
- layer.removeInteractiveTarget(container);
- },
-
- _updateStyle: function (layer) {
- var stroke = layer._stroke,
- fill = layer._fill,
- options = layer.options,
- container = layer._container;
+ _getEdgeIntersection: function (a, b, code, bounds, round) {
+ var dx = b.x - a.x,
+ dy = b.y - a.y,
+ min = bounds.min,
+ max = bounds.max,
+ x, y;
- container.stroked = !!options.stroke;
- container.filled = !!options.fill;
+ if (code & 8) { // top
+ x = a.x + dx * (max.y - a.y) / dy;
+ y = max.y;
- if (options.stroke) {
- if (!stroke) {
- stroke = layer._stroke = L.SVG.create('stroke');
- }
- container.appendChild(stroke);
- stroke.weight = options.weight + 'px';
- stroke.color = options.color;
- stroke.opacity = options.opacity;
+ } else if (code & 4) { // bottom
+ x = a.x + dx * (min.y - a.y) / dy;
+ y = min.y;
- if (options.dashArray) {
- stroke.dashStyle = L.Util.isArray(options.dashArray) ?
- options.dashArray.join(' ') :
- options.dashArray.replace(/( *, *)/g, ' ');
- } else {
- stroke.dashStyle = '';
- }
- stroke.endcap = options.lineCap.replace('butt', 'flat');
- stroke.joinstyle = options.lineJoin;
+ } else if (code & 2) { // right
+ x = max.x;
+ y = a.y + dy * (max.x - a.x) / dx;
- } else if (stroke) {
- container.removeChild(stroke);
- layer._stroke = null;
+ } else if (code & 1) { // left
+ x = min.x;
+ y = a.y + dy * (min.x - a.x) / dx;
}
- if (options.fill) {
- if (!fill) {
- fill = layer._fill = L.SVG.create('fill');
- }
- container.appendChild(fill);
- fill.color = options.fillColor || options.color;
- fill.opacity = options.fillOpacity;
+ return new L.Point(x, y, round);
+ },
- } else if (fill) {
- container.removeChild(fill);
- layer._fill = null;
+ _getBitCode: function (p, bounds) {
+ var code = 0;
+
+ if (p.x < bounds.min.x) { // left
+ code |= 1;
+ } else if (p.x > bounds.max.x) { // right
+ code |= 2;
}
- },
- _updateCircle: function (layer) {
- var p = layer._point.round(),
- r = Math.round(layer._radius),
- r2 = Math.round(layer._radiusY || r);
+ if (p.y < bounds.min.y) { // bottom
+ code |= 4;
+ } else if (p.y > bounds.max.y) { // top
+ code |= 8;
+ }
- this._setPath(layer, layer._empty() ? 'M0 0' :
- 'AL ' + p.x + ',' + p.y + ' ' + r + ',' + r2 + ' 0,' + (65535 * 360));
+ return code;
},
- _setPath: function (layer, path) {
- layer._path.v = path;
+ // square distance (to avoid unnecessary Math.sqrt calls)
+ _sqDist: function (p1, p2) {
+ var dx = p2.x - p1.x,
+ dy = p2.y - p1.y;
+ return dx * dx + dy * dy;
},
- _bringToFront: function (layer) {
- L.DomUtil.toFront(layer._container);
- },
+ // return closest point on segment or distance to that point
+ _sqClosestPointOnSegment: function (p, p1, p2, sqDist) {
+ var x = p1.x,
+ y = p1.y,
+ dx = p2.x - x,
+ dy = p2.y - y,
+ dot = dx * dx + dy * dy,
+ t;
- _bringToBack: function (layer) {
- L.DomUtil.toBack(layer._container);
- }
-});
+ if (dot > 0) {
+ t = ((p.x - x) * dx + (p.y - y) * dy) / dot;
-if (L.Browser.vml) {
- L.SVG.create = (function () {
- try {
- document.namespaces.add('lvml', 'urn:schemas-microsoft-com:vml');
- return function (name) {
- return document.createElement('<lvml:' + name + ' class="lvml">');
- };
- } catch (e) {
- return function (name) {
- return document.createElement('<' + name + ' xmlns="urn:schemas-microsoft.com:vml" class="lvml">');
- };
+ if (t > 1) {
+ x = p2.x;
+ y = p2.y;
+ } else if (t > 0) {
+ x += dx * t;
+ y += dy * t;
+ }
}
- })();
-}
+
+ dx = p.x - x;
+ dy = p.y - y;
+
+ return sqDist ? dx * dx + dy * dy : new L.Point(x, y);
+ }
+};
/*
- * @class Canvas
- * @inherits Renderer
- * @aka L.Canvas
- *
- * Allows vector layers to be displayed with [`<canvas>`](https://developer.mozilla.org/docs/Web/API/Canvas_API).
- * Inherits `Renderer`.
+ * @class Polyline
+ * @aka L.Polyline
+ * @inherits Path
*
- * Due to [technical limitations](http://caniuse.com/#search=canvas), Canvas is not
- * available in all web browsers, notably IE8, and overlapping geometries might
- * not display properly in some edge cases.
+ * A class for drawing polyline overlays on a map. Extends `Path`.
*
* @example
*
- * Use Canvas by default for all paths in the map:
- *
* ```js
- * var map = L.map('map', {
- * renderer: L.canvas()
- * });
+ * // create a red polyline from an array of LatLng points
+ * var latlngs = [
+ * [-122.68, 45.51],
+ * [-122.43, 37.77],
+ * [-118.2, 34.04]
+ * ];
+ *
+ * var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
+ *
+ * // zoom the map to the polyline
+ * map.fitBounds(polyline.getBounds());
* ```
*
- * Use a Canvas renderer with extra padding for specific vector geometries:
+ * You can also pass a multi-dimensional array to represent a `MultiPolyline` shape:
*
* ```js
- * var map = L.map('map');
- * var myRenderer = L.canvas({ padding: 0.5 });
- * var line = L.polyline( coordinates, { renderer: myRenderer } );
- * var circle = L.circle( center, { renderer: myRenderer } );
+ * // create a red polyline from an array of arrays of LatLng points
+ * var latlngs = [
+ * [[-122.68, 45.51],
+ * [-122.43, 37.77],
+ * [-118.2, 34.04]],
+ * [[-73.91, 40.78],
+ * [-87.62, 41.83],
+ * [-96.72, 32.76]]
+ * ];
* ```
*/
-L.Canvas = L.Renderer.extend({
+L.Polyline = L.Path.extend({
- onAdd: function () {
- L.Renderer.prototype.onAdd.call(this);
+ // @section
+ // @aka Polyline options
+ options: {
+ // @option smoothFactor: Number = 1.0
+ // How much to simplify the polyline on each zoom level. More means
+ // better performance and smoother look, and less means more accurate representation.
+ smoothFactor: 1.0,
- this._layers = this._layers || {};
+ // @option noClip: Boolean = false
+ // Disable polyline clipping.
+ noClip: false
+ },
- // Redraw vectors since canvas is cleared upon removal,
- // in case of removing the renderer itself from the map.
- this._draw();
+ initialize: function (latlngs, options) {
+ L.setOptions(this, options);
+ this._setLatLngs(latlngs);
},
- _initContainer: function () {
- var container = this._container = document.createElement('canvas');
+ // @method getLatLngs(): LatLng[]
+ // Returns an array of the points in the path, or nested arrays of points in case of multi-polyline.
+ getLatLngs: function () {
+ return this._latlngs;
+ },
+
+ // @method setLatLngs(latlngs: LatLng[]): this
+ // Replaces all the points in the polyline with the given array of geographical points.
+ setLatLngs: function (latlngs) {
+ this._setLatLngs(latlngs);
+ return this.redraw();
+ },
+
+ // @method isEmpty(): Boolean
+ // Returns `true` if the Polyline has no LatLngs.
+ isEmpty: function () {
+ return !this._latlngs.length;
+ },
+
+ closestLayerPoint: function (p) {
+ var minDistance = Infinity,
+ minPoint = null,
+ closest = L.LineUtil._sqClosestPointOnSegment,
+ p1, p2;
+
+ for (var j = 0, jLen = this._parts.length; j < jLen; j++) {
+ var points = this._parts[j];
+
+ for (var i = 1, len = points.length; i < len; i++) {
+ p1 = points[i - 1];
+ p2 = points[i];
- L.DomEvent
- .on(container, 'mousemove', L.Util.throttle(this._onMouseMove, 32, this), this)
- .on(container, 'click dblclick mousedown mouseup contextmenu', this._onClick, this)
- .on(container, 'mouseout', this._handleMouseOut, this);
+ var sqDist = closest(p, p1, p2, true);
- this._ctx = container.getContext('2d');
+ if (sqDist < minDistance) {
+ minDistance = sqDist;
+ minPoint = closest(p, p1, p2);
+ }
+ }
+ }
+ if (minPoint) {
+ minPoint.distance = Math.sqrt(minDistance);
+ }
+ return minPoint;
},
- _update: function () {
- if (this._map._animatingZoom && this._bounds) { return; }
-
- this._drawnLayers = {};
+ // @method getCenter(): LatLng
+ // Returns the center ([centroid](http://en.wikipedia.org/wiki/Centroid)) of the polyline.
+ getCenter: function () {
+ // throws error when not yet added to map as this center calculation requires projected coordinates
+ if (!this._map) {
+ throw new Error('Must add layer to map before using getCenter()');
+ }
- L.Renderer.prototype._update.call(this);
+ var i, halfDist, segDist, dist, p1, p2, ratio,
+ points = this._rings[0],
+ len = points.length;
- var b = this._bounds,
- container = this._container,
- size = b.getSize(),
- m = L.Browser.retina ? 2 : 1;
+ if (!len) { return null; }
- L.DomUtil.setPosition(container, b.min);
+ // polyline centroid algorithm; only uses the first ring if there are multiple
- // set canvas size (also clearing it); use double size on retina
- container.width = m * size.x;
- container.height = m * size.y;
- container.style.width = size.x + 'px';
- container.style.height = size.y + 'px';
+ for (i = 0, halfDist = 0; i < len - 1; i++) {
+ halfDist += points[i].distanceTo(points[i + 1]) / 2;
+ }
- if (L.Browser.retina) {
- this._ctx.scale(2, 2);
+ // The line is so small in the current view that all points are on the same pixel.
+ if (halfDist === 0) {
+ return this._map.layerPointToLatLng(points[0]);
}
- // translate so we use the same path coordinates after canvas element moves
- this._ctx.translate(-b.min.x, -b.min.y);
+ for (i = 0, dist = 0; i < len - 1; i++) {
+ p1 = points[i];
+ p2 = points[i + 1];
+ segDist = p1.distanceTo(p2);
+ dist += segDist;
- // Tell paths to redraw themselves
- this.fire('update');
+ if (dist > halfDist) {
+ ratio = (dist - halfDist) / segDist;
+ return this._map.layerPointToLatLng([
+ p2.x - ratio * (p2.x - p1.x),
+ p2.y - ratio * (p2.y - p1.y)
+ ]);
+ }
+ }
},
- _initPath: function (layer) {
- this._updateDashArray(layer);
- this._layers[L.stamp(layer)] = layer;
+ // @method getBounds(): LatLngBounds
+ // Returns the `LatLngBounds` of the path.
+ getBounds: function () {
+ return this._bounds;
},
- _addPath: L.Util.falseFn,
-
- _removePath: function (layer) {
- layer._removed = true;
- this._requestRedraw(layer);
+ // @method addLatLng(latlng: LatLng, latlngs? LatLng[]): this
+ // Adds a given point to the polyline. By default, adds to the first ring of
+ // the polyline in case of a multi-polyline, but can be overridden by passing
+ // a specific ring as a LatLng array (that you can earlier access with [`getLatLngs`](#polyline-getlatlngs)).
+ addLatLng: function (latlng, latlngs) {
+ latlngs = latlngs || this._defaultShape();
+ latlng = L.latLng(latlng);
+ latlngs.push(latlng);
+ this._bounds.extend(latlng);
+ return this.redraw();
},
- _updatePath: function (layer) {
- this._redrawBounds = layer._pxBounds;
- this._draw(true);
- layer._project();
- layer._update();
- this._draw();
- this._redrawBounds = null;
+ _setLatLngs: function (latlngs) {
+ this._bounds = new L.LatLngBounds();
+ this._latlngs = this._convertLatLngs(latlngs);
},
- _updateStyle: function (layer) {
- this._updateDashArray(layer);
- this._requestRedraw(layer);
+ _defaultShape: function () {
+ return L.Polyline._flat(this._latlngs) ? this._latlngs : this._latlngs[0];
},
- _updateDashArray: function (layer) {
- if (layer.options.dashArray) {
- var parts = layer.options.dashArray.split(','),
- dashArray = [],
- i;
- for (i = 0; i < parts.length; i++) {
- dashArray.push(Number(parts[i]));
+ // recursively convert latlngs input into actual LatLng instances; calculate bounds along the way
+ _convertLatLngs: function (latlngs) {
+ var result = [],
+ flat = L.Polyline._flat(latlngs);
+
+ for (var i = 0, len = latlngs.length; i < len; i++) {
+ if (flat) {
+ result[i] = L.latLng(latlngs[i]);
+ this._bounds.extend(result[i]);
+ } else {
+ result[i] = this._convertLatLngs(latlngs[i]);
}
- layer.options._dashArray = dashArray;
}
- },
-
- _requestRedraw: function (layer) {
- if (!this._map) { return; }
-
- var padding = (layer.options.weight || 0) + 1;
- this._redrawBounds = this._redrawBounds || new L.Bounds();
- this._redrawBounds.extend(layer._pxBounds.min.subtract([padding, padding]));
- this._redrawBounds.extend(layer._pxBounds.max.add([padding, padding]));
- this._redrawRequest = this._redrawRequest || L.Util.requestAnimFrame(this._redraw, this);
+ return result;
},
- _redraw: function () {
- this._redrawRequest = null;
+ _project: function () {
+ var pxBounds = new L.Bounds();
+ this._rings = [];
+ this._projectLatlngs(this._latlngs, this._rings, pxBounds);
- this._draw(true); // clear layers in redraw bounds
- this._draw(); // draw layers
+ var w = this._clickTolerance(),
+ p = new L.Point(w, w);
- this._redrawBounds = null;
+ if (this._bounds.isValid() && pxBounds.isValid()) {
+ pxBounds.min._subtract(p);
+ pxBounds.max._add(p);
+ this._pxBounds = pxBounds;
+ }
},
- _draw: function (clear) {
- this._clear = clear;
- var layer, bounds = this._redrawBounds;
- this._ctx.save();
- if (bounds) {
- this._ctx.beginPath();
- this._ctx.rect(bounds.min.x, bounds.min.y, bounds.max.x - bounds.min.x, bounds.max.y - bounds.min.y);
- this._ctx.clip();
- }
+ // recursively turns latlngs into a set of rings with projected coordinates
+ _projectLatlngs: function (latlngs, result, projectedBounds) {
+ var flat = latlngs[0] instanceof L.LatLng,
+ len = latlngs.length,
+ i, ring;
- for (var id in this._layers) {
- layer = this._layers[id];
- if (!bounds || (layer._pxBounds && layer._pxBounds.intersects(bounds))) {
- layer._updatePath();
+ if (flat) {
+ ring = [];
+ for (i = 0; i < len; i++) {
+ ring[i] = this._map.latLngToLayerPoint(latlngs[i]);
+ projectedBounds.extend(ring[i]);
}
- if (clear && layer._removed) {
- delete layer._removed;
- delete this._layers[id];
+ result.push(ring);
+ } else {
+ for (i = 0; i < len; i++) {
+ this._projectLatlngs(latlngs[i], result, projectedBounds);
}
}
- this._ctx.restore(); // Restore state before clipping.
},
- _updatePoly: function (layer, closed) {
+ // clip polyline by renderer bounds so that we have less to render for performance
+ _clipPoints: function () {
+ var bounds = this._renderer._bounds;
- var i, j, len2, p,
- parts = layer._parts,
- len = parts.length,
- ctx = this._ctx;
+ this._parts = [];
+ if (!this._pxBounds || !this._pxBounds.intersects(bounds)) {
+ return;
+ }
- if (!len) { return; }
+ if (this.options.noClip) {
+ this._parts = this._rings;
+ return;
+ }
- this._drawnLayers[layer._leaflet_id] = layer;
+ var parts = this._parts,
+ i, j, k, len, len2, segment, points;
- ctx.beginPath();
+ for (i = 0, k = 0, len = this._rings.length; i < len; i++) {
+ points = this._rings[i];
- if (ctx.setLineDash) {
- ctx.setLineDash(layer.options && layer.options._dashArray || []);
- }
+ for (j = 0, len2 = points.length; j < len2 - 1; j++) {
+ segment = L.LineUtil.clipSegment(points[j], points[j + 1], bounds, j, true);
- for (i = 0; i < len; i++) {
- for (j = 0, len2 = parts[i].length; j < len2; j++) {
- p = parts[i][j];
- ctx[j ? 'lineTo' : 'moveTo'](p.x, p.y);
- }
- if (closed) {
- ctx.closePath();
+ if (!segment) { continue; }
+
+ parts[k] = parts[k] || [];
+ parts[k].push(segment[0]);
+
+ // if segment goes out of screen, or it's the last one, it's the end of the line part
+ if ((segment[1] !== points[j + 1]) || (j === len2 - 2)) {
+ parts[k].push(segment[1]);
+ k++;
+ }
}
}
+ },
+
+ // simplify each clipped part of the polyline for performance
+ _simplifyPoints: function () {
+ var parts = this._parts,
+ tolerance = this.options.smoothFactor;
+
+ for (var i = 0, len = parts.length; i < len; i++) {
+ parts[i] = L.LineUtil.simplify(parts[i], tolerance);
+ }
+ },
+
+ _update: function () {
+ if (!this._map) { return; }
+
+ this._clipPoints();
+ this._simplifyPoints();
+ this._updatePath();
+ },
+
+ _updatePath: function () {
+ this._renderer._updatePoly(this);
+ }
+});
+
+// @factory L.polyline(latlngs: LatLng[], options?: Polyline options)
+// Instantiates a polyline object given an array of geographical points and
+// optionally an options object. You can create a `Polyline` object with
+// multiple separate lines (`MultiPolyline`) by passing an array of arrays
+// of geographic points.
+L.polyline = function (latlngs, options) {
+ return new L.Polyline(latlngs, options);
+};
+
+L.Polyline._flat = function (latlngs) {
+ // true if it's a flat array of latlngs; false if nested
+ return !L.Util.isArray(latlngs[0]) || (typeof latlngs[0][0] !== 'object' && typeof latlngs[0][0] !== 'undefined');
+};
- this._fillStroke(ctx, layer);
- // TODO optimization: 1 fill/stroke for all features with equal style instead of 1 for each feature
- },
- _updateCircle: function (layer) {
+/*
+ * @namespace PolyUtil
+ * Various utility functions for polygon geometries.
+ */
- if (layer._empty()) { return; }
+L.PolyUtil = {};
- var p = layer._point,
- ctx = this._ctx,
- r = layer._radius,
- s = (layer._radiusY || r) / r;
+/* @function clipPolygon(points: Point[], bounds: Bounds, round?: Boolean): Point[]
+ * Clips the polygon geometry defined by the given `points` by the given bounds (using the [Sutherland-Hodgeman algorithm](https://en.wikipedia.org/wiki/Sutherland%E2%80%93Hodgman_algorithm)).
+ * Used by Leaflet to only show polygon points that are on the screen or near, increasing
+ * performance. Note that polygon points needs different algorithm for clipping
+ * than polyline, so there's a seperate method for it.
+ */
+L.PolyUtil.clipPolygon = function (points, bounds, round) {
+ var clippedPoints,
+ edges = [1, 4, 2, 8],
+ i, j, k,
+ a, b,
+ len, edge, p,
+ lu = L.LineUtil;
- this._drawnLayers[layer._leaflet_id] = layer;
+ for (i = 0, len = points.length; i < len; i++) {
+ points[i]._code = lu._getBitCode(points[i], bounds);
+ }
- if (s !== 1) {
- ctx.save();
- ctx.scale(1, s);
- }
+ // for each edge (left, bottom, right, top)
+ for (k = 0; k < 4; k++) {
+ edge = edges[k];
+ clippedPoints = [];
- ctx.beginPath();
- ctx.arc(p.x, p.y / s, r, 0, Math.PI * 2, false);
+ for (i = 0, len = points.length, j = len - 1; i < len; j = i++) {
+ a = points[i];
+ b = points[j];
- if (s !== 1) {
- ctx.restore();
+ // if a is inside the clip window
+ if (!(a._code & edge)) {
+ // if b is outside the clip window (a->b goes out of screen)
+ if (b._code & edge) {
+ p = lu._getEdgeIntersection(b, a, edge, bounds, round);
+ p._code = lu._getBitCode(p, bounds);
+ clippedPoints.push(p);
+ }
+ clippedPoints.push(a);
+
+ // else if b is inside the clip window (a->b enters the screen)
+ } else if (!(b._code & edge)) {
+ p = lu._getEdgeIntersection(b, a, edge, bounds, round);
+ p._code = lu._getBitCode(p, bounds);
+ clippedPoints.push(p);
+ }
}
+ points = clippedPoints;
+ }
- this._fillStroke(ctx, layer);
- },
+ return points;
+};
- _fillStroke: function (ctx, layer) {
- var clear = this._clear,
- options = layer.options;
- ctx.globalCompositeOperation = clear ? 'destination-out' : 'source-over';
- if (options.fill) {
- ctx.globalAlpha = clear ? 1 : options.fillOpacity;
- ctx.fillStyle = options.fillColor || options.color;
- ctx.fill(options.fillRule || 'evenodd');
- }
+/*
+ * @class Polygon
+ * @aka L.Polygon
+ * @inherits Polyline
+ *
+ * A class for drawing polygon overlays on a map. Extends `Polyline`.
+ *
+ * Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points.
+ *
+ *
+ * @example
+ *
+ * ```js
+ * // create a red polygon from an array of LatLng points
+ * var latlngs = [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]];
+ *
+ * var polygon = L.polygon(latlngs, {color: 'red'}).addTo(map);
+ *
+ * // zoom the map to the polygon
+ * map.fitBounds(polygon.getBounds());
+ * ```
+ *
+ * You can also pass an array of arrays of latlngs, with the first array representing the outer shape and the other arrays representing holes in the outer shape:
+ *
+ * ```js
+ * var latlngs = [
+ * [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]], // outer ring
+ * [[-108.58,37.29],[-108.58,40.71],[-102.50,40.71],[-102.50,37.29]] // hole
+ * ];
+ * ```
+ *
+ * Additionally, you can pass a multi-dimensional array to represent a MultiPolygon shape.
+ *
+ * ```js
+ * var latlngs = [
+ * [ // first polygon
+ * [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]], // outer ring
+ * [[-108.58,37.29],[-108.58,40.71],[-102.50,40.71],[-102.50,37.29]] // hole
+ * ],
+ * [ // second polygon
+ * [[-109.05, 37],[-109.03, 41],[-102.05, 41],[-102.04, 37],[-109.05, 38]]
+ * ]
+ * ];
+ * ```
+ */
- if (options.stroke && options.weight !== 0) {
- ctx.globalAlpha = clear ? 1 : options.opacity;
+L.Polygon = L.Polyline.extend({
- // if clearing shape, do it with the previously drawn line width
- layer._prevWeight = ctx.lineWidth = clear ? layer._prevWeight + 1 : options.weight;
+ options: {
+ fill: true
+ },
- ctx.strokeStyle = options.color;
- ctx.lineCap = options.lineCap;
- ctx.lineJoin = options.lineJoin;
- ctx.stroke();
- }
+ isEmpty: function () {
+ return !this._latlngs.length || !this._latlngs[0].length;
},
- // Canvas obviously doesn't have mouse events for individual drawn objects,
- // so we emulate that by calculating what's under the mouse on mousemove/click manually
+ getCenter: function () {
+ // throws error when not yet added to map as this center calculation requires projected coordinates
+ if (!this._map) {
+ throw new Error('Must add layer to map before using getCenter()');
+ }
- _onClick: function (e) {
- var point = this._map.mouseEventToLayerPoint(e), layers = [], layer;
+ var i, j, p1, p2, f, area, x, y, center,
+ points = this._rings[0],
+ len = points.length;
- for (var id in this._layers) {
- layer = this._layers[id];
- if (layer.options.interactive && layer._containsPoint(point) && !this._map._draggableMoved(layer)) {
- L.DomEvent._fakeStop(e);
- layers.push(layer);
- }
- }
- if (layers.length) {
- this._fireEvent(layers, e);
- }
- },
+ if (!len) { return null; }
- _onMouseMove: function (e) {
- if (!this._map || this._map.dragging.moving() || this._map._animatingZoom) { return; }
+ // polygon centroid algorithm; only uses the first ring if there are multiple
- var point = this._map.mouseEventToLayerPoint(e);
- this._handleMouseOut(e, point);
- this._handleMouseHover(e, point);
- },
+ area = x = y = 0;
+
+ for (i = 0, j = len - 1; i < len; j = i++) {
+ p1 = points[i];
+ p2 = points[j];
+ f = p1.y * p2.x - p2.y * p1.x;
+ x += (p1.x + p2.x) * f;
+ y += (p1.y + p2.y) * f;
+ area += f * 3;
+ }
- _handleMouseOut: function (e, point) {
- var layer = this._hoveredLayer;
- if (layer && (e.type === 'mouseout' || !layer._containsPoint(point))) {
- // if we're leaving the layer, fire mouseout
- L.DomUtil.removeClass(this._container, 'leaflet-interactive');
- this._fireEvent([layer], e, 'mouseout');
- this._hoveredLayer = null;
+ if (area === 0) {
+ // Polygon is so small that all points are on same pixel.
+ center = points[0];
+ } else {
+ center = [x / area, y / area];
}
+ return this._map.layerPointToLatLng(center);
},
- _handleMouseHover: function (e, point) {
- var id, layer;
+ _convertLatLngs: function (latlngs) {
+ var result = L.Polyline.prototype._convertLatLngs.call(this, latlngs),
+ len = result.length;
- for (id in this._drawnLayers) {
- layer = this._drawnLayers[id];
- if (layer.options.interactive && layer._containsPoint(point)) {
- L.DomUtil.addClass(this._container, 'leaflet-interactive'); // change cursor
- this._fireEvent([layer], e, 'mouseover');
- this._hoveredLayer = layer;
- }
+ // remove last point if it equals first one
+ if (len >= 2 && result[0] instanceof L.LatLng && result[0].equals(result[len - 1])) {
+ result.pop();
}
+ return result;
+ },
- if (this._hoveredLayer) {
- this._fireEvent([this._hoveredLayer], e);
+ _setLatLngs: function (latlngs) {
+ L.Polyline.prototype._setLatLngs.call(this, latlngs);
+ if (L.Polyline._flat(this._latlngs)) {
+ this._latlngs = [this._latlngs];
}
},
- _fireEvent: function (layers, e, type) {
- this._map._fireDOMEvent(e, type || e.type, layers);
+ _defaultShape: function () {
+ return L.Polyline._flat(this._latlngs[0]) ? this._latlngs[0] : this._latlngs[0][0];
},
- // TODO _bringToFront & _bringToBack, pretty tricky
-
- _bringToFront: L.Util.falseFn,
- _bringToBack: L.Util.falseFn
-});
-
-// @namespace Browser; @property canvas: Boolean
-// `true` when the browser supports [`<canvas>`](https://developer.mozilla.org/docs/Web/API/Canvas_API).
-L.Browser.canvas = (function () {
- return !!document.createElement('canvas').getContext;
-}());
-
-// @namespace Canvas
-// @factory L.canvas(options?: Renderer options)
-// Creates a Canvas renderer with the given options.
-L.canvas = function (options) {
- return L.Browser.canvas ? new L.Canvas(options) : null;
-};
-
-L.Polyline.prototype._containsPoint = function (p, closed) {
- var i, j, k, len, len2, part,
- w = this._clickTolerance();
-
- if (!this._pxBounds.contains(p)) { return false; }
-
- // hit detection for polylines
- for (i = 0, len = this._parts.length; i < len; i++) {
- part = this._parts[i];
-
- for (j = 0, len2 = part.length, k = len2 - 1; j < len2; k = j++) {
- if (!closed && (j === 0)) { continue; }
-
- if (L.LineUtil.pointToSegmentDistance(p, part[k], part[j]) <= w) {
- return true;
- }
- }
- }
- return false;
-};
-
-L.Polygon.prototype._containsPoint = function (p) {
- var inside = false,
- part, p1, p2, i, j, k, len, len2;
+ _clipPoints: function () {
+ // polygons need a different clipping algorithm so we redefine that
- if (!this._pxBounds.contains(p)) { return false; }
+ var bounds = this._renderer._bounds,
+ w = this.options.weight,
+ p = new L.Point(w, w);
- // ray casting algorithm for detecting if point is in polygon
- for (i = 0, len = this._parts.length; i < len; i++) {
- part = this._parts[i];
+ // increase clip padding by stroke width to avoid stroke on clip edges
+ bounds = new L.Bounds(bounds.min.subtract(p), bounds.max.add(p));
- for (j = 0, len2 = part.length, k = len2 - 1; j < len2; k = j++) {
- p1 = part[j];
- p2 = part[k];
+ this._parts = [];
+ if (!this._pxBounds || !this._pxBounds.intersects(bounds)) {
+ return;
+ }
- if (((p1.y > p.y) !== (p2.y > p.y)) && (p.x < (p2.x - p1.x) * (p.y - p1.y) / (p2.y - p1.y) + p1.x)) {
- inside = !inside;
+ if (this.options.noClip) {
+ this._parts = this._rings;
+ return;
+ }
+
+ for (var i = 0, len = this._rings.length, clipped; i < len; i++) {
+ clipped = L.PolyUtil.clipPolygon(this._rings[i], bounds, true);
+ if (clipped.length) {
+ this._parts.push(clipped);
}
}
+ },
+
+ _updatePath: function () {
+ this._renderer._updatePoly(this, true);
}
+});
- // also check if it's on polygon stroke
- return inside || L.Polyline.prototype._containsPoint.call(this, p, true);
-};
-L.CircleMarker.prototype._containsPoint = function (p) {
- return p.distanceTo(this._point) <= this._radius + this._clickTolerance();
+// @factory L.polygon(latlngs: LatLng[], options?: Polyline options)
+L.polygon = function (latlngs, options) {
+ return new L.Polygon(latlngs, options);
};
/*
- * @class GeoJSON
- * @aka L.GeoJSON
- * @inherits FeatureGroup
+ * L.Rectangle extends Polygon and creates a rectangle when passed a LatLngBounds object.
+ */
+
+/*
+ * @class Rectangle
+ * @aka L.Retangle
+ * @inherits Polygon
*
- * Represents a GeoJSON object or an array of GeoJSON objects. Allows you to parse
- * GeoJSON data and display it on the map. Extends `FeatureGroup`.
+ * A class for drawing rectangle overlays on a map. Extends `Polygon`.
*
* @example
*
* ```js
- * L.geoJSON(data, {
- * style: function (feature) {
- * return {color: feature.properties.color};
- * }
- * }).bindPopup(function (layer) {
- * return layer.feature.properties.description;
- * }).addTo(map);
+ * // define rectangle geographical bounds
+ * var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
+ *
+ * // create an orange rectangle
+ * L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
+ *
+ * // zoom the map to the rectangle bounds
+ * map.fitBounds(bounds);
* ```
+ *
*/
-L.GeoJSON = L.FeatureGroup.extend({
- /* @section
- * @aka GeoJSON options
- *
- * @option pointToLayer: Function = *
- * A `Function` defining how GeoJSON points spawn Leaflet layers. It is internally
- * called when data is added, passing the GeoJSON point feature and its `LatLng`.
- * The default is to spawn a default `Marker`:
- * ```js
- * function(geoJsonPoint, latlng) {
- * return L.marker(latlng);
- * }
- * ```
- *
- * @option style: Function = *
- * A `Function` defining the `Path options` for styling GeoJSON lines and polygons,
- * called internally when data is added.
- * The default value is to not override any defaults:
- * ```js
- * function (geoJsonFeature) {
- * return {}
- * }
- * ```
- *
- * @option onEachFeature: Function = *
- * A `Function` that will be called once for each created `Feature`, after it has
- * been created and styled. Useful for attaching events and popups to features.
- * The default is to do nothing with the newly created layers:
- * ```js
- * function (feature, layer) {}
- * ```
- *
- * @option filter: Function = *
- * A `Function` that will be used to decide whether to include a feature or not.
- * The default is to include all features:
- * ```js
- * function (geoJsonFeature) {
- * return true;
- * }
- * ```
- * Note: dynamically changing the `filter` option will have effect only on newly
- * added data. It will _not_ re-evaluate already included features.
- *
- * @option coordsToLatLng: Function = *
- * A `Function` that will be used for converting GeoJSON coordinates to `LatLng`s.
- * The default is the `coordsToLatLng` static method.
- */
+L.Rectangle = L.Polygon.extend({
+ initialize: function (latLngBounds, options) {
+ L.Polygon.prototype.initialize.call(this, this._boundsToLatLngs(latLngBounds), options);
+ },
- initialize: function (geojson, options) {
- L.setOptions(this, options);
+ // @method setBounds(latLngBounds: LatLngBounds): this
+ // Redraws the rectangle with the passed bounds.
+ setBounds: function (latLngBounds) {
+ return this.setLatLngs(this._boundsToLatLngs(latLngBounds));
+ },
- this._layers = {};
+ _boundsToLatLngs: function (latLngBounds) {
+ latLngBounds = L.latLngBounds(latLngBounds);
+ return [
+ latLngBounds.getSouthWest(),
+ latLngBounds.getNorthWest(),
+ latLngBounds.getNorthEast(),
+ latLngBounds.getSouthEast()
+ ];
+ }
+});
- if (geojson) {
- this.addData(geojson);
- }
- },
- // @method addData( <GeoJSON> data ): Layer
- // Adds a GeoJSON object to the layer.
- addData: function (geojson) {
- var features = L.Util.isArray(geojson) ? geojson : geojson.features,
- i, len, feature;
+// @factory L.rectangle(latLngBounds: LatLngBounds, options?: Polyline options)
+L.rectangle = function (latLngBounds, options) {
+ return new L.Rectangle(latLngBounds, options);
+};
- if (features) {
- for (i = 0, len = features.length; i < len; i++) {
- // only add this if geometry or geometries are set and not null
- feature = features[i];
- if (feature.geometries || feature.geometry || feature.features || feature.coordinates) {
- this.addData(feature);
- }
- }
- return this;
- }
- var options = this.options;
- if (options.filter && !options.filter(geojson)) { return this; }
+/*
+ * @class CircleMarker
+ * @aka L.CircleMarker
+ * @inherits Path
+ *
+ * A circle of a fixed size with radius specified in pixels. Extends `Path`.
+ */
- var layer = L.GeoJSON.geometryToLayer(geojson, options);
- if (!layer) {
- return this;
- }
- layer.feature = L.GeoJSON.asFeature(geojson);
+L.CircleMarker = L.Path.extend({
- layer.defaultOptions = layer.options;
- this.resetStyle(layer);
+ // @section
+ // @aka CircleMarker options
+ options: {
+ fill: true,
- if (options.onEachFeature) {
- options.onEachFeature(geojson, layer);
- }
+ // @option radius: Number = 10
+ // Radius of the circle marker, in pixels
+ radius: 10
+ },
- return this.addLayer(layer);
+ initialize: function (latlng, options) {
+ L.setOptions(this, options);
+ this._latlng = L.latLng(latlng);
+ this._radius = this.options.radius;
},
- // @method resetStyle( <Path> layer ): Layer
- // Resets the given vector layer's style to the original GeoJSON style, useful for resetting style after hover events.
- resetStyle: function (layer) {
- // reset any custom styles
- layer.options = L.Util.extend({}, layer.defaultOptions);
- this._setLayerStyle(layer, this.options.style);
- return this;
+ // @method setLatLng(latLng: LatLng): this
+ // Sets the position of a circle marker to a new location.
+ setLatLng: function (latlng) {
+ this._latlng = L.latLng(latlng);
+ this.redraw();
+ return this.fire('move', {latlng: this._latlng});
},
- // @method setStyle( <Function> style ): Layer
- // Changes styles of GeoJSON vector layers with the given style function.
- setStyle: function (style) {
- return this.eachLayer(function (layer) {
- this._setLayerStyle(layer, style);
- }, this);
+ // @method getLatLng(): LatLng
+ // Returns the current geographical position of the circle marker
+ getLatLng: function () {
+ return this._latlng;
},
- _setLayerStyle: function (layer, style) {
- if (typeof style === 'function') {
- style = style(layer.feature);
- }
- if (layer.setStyle) {
- layer.setStyle(style);
- }
- }
-});
+ // @method setRadius(radius: Number): this
+ // Sets the radius of a circle marker. Units are in pixels.
+ setRadius: function (radius) {
+ this.options.radius = this._radius = radius;
+ return this.redraw();
+ },
-// @section
-// There are several static functions which can be called without instantiating L.GeoJSON:
-L.extend(L.GeoJSON, {
- // @function geometryToLayer(featureData: Object, options?: GeoJSON options): Layer
- // Creates a `Layer` from a given GeoJSON feature. Can use a custom
- // [`pointToLayer`](#geojson-pointtolayer) and/or [`coordsToLatLng`](#geojson-coordstolatlng)
- // functions if provided as options.
- geometryToLayer: function (geojson, options) {
+ // @method getRadius(): Number
+ // Returns the current radius of the circle
+ getRadius: function () {
+ return this._radius;
+ },
- var geometry = geojson.type === 'Feature' ? geojson.geometry : geojson,
- coords = geometry ? geometry.coordinates : null,
- layers = [],
- pointToLayer = options && options.pointToLayer,
- coordsToLatLng = options && options.coordsToLatLng || this.coordsToLatLng,
- latlng, latlngs, i, len;
+ setStyle : function (options) {
+ var radius = options && options.radius || this._radius;
+ L.Path.prototype.setStyle.call(this, options);
+ this.setRadius(radius);
+ return this;
+ },
- if (!coords && !geometry) {
- return null;
+ _project: function () {
+ this._point = this._map.latLngToLayerPoint(this._latlng);
+ this._updateBounds();
+ },
+
+ _updateBounds: function () {
+ var r = this._radius,
+ r2 = this._radiusY || r,
+ w = this._clickTolerance(),
+ p = [r + w, r2 + w];
+ this._pxBounds = new L.Bounds(this._point.subtract(p), this._point.add(p));
+ },
+
+ _update: function () {
+ if (this._map) {
+ this._updatePath();
}
+ },
- switch (geometry.type) {
- case 'Point':
- latlng = coordsToLatLng(coords);
- return pointToLayer ? pointToLayer(geojson, latlng) : new L.Marker(latlng);
+ _updatePath: function () {
+ this._renderer._updateCircle(this);
+ },
- case 'MultiPoint':
- for (i = 0, len = coords.length; i < len; i++) {
- latlng = coordsToLatLng(coords[i]);
- layers.push(pointToLayer ? pointToLayer(geojson, latlng) : new L.Marker(latlng));
- }
- return new L.FeatureGroup(layers);
+ _empty: function () {
+ return this._radius && !this._renderer._bounds.intersects(this._pxBounds);
+ }
+});
- case 'LineString':
- case 'MultiLineString':
- latlngs = this.coordsToLatLngs(coords, geometry.type === 'LineString' ? 0 : 1, coordsToLatLng);
- return new L.Polyline(latlngs, options);
- case 'Polygon':
- case 'MultiPolygon':
- latlngs = this.coordsToLatLngs(coords, geometry.type === 'Polygon' ? 1 : 2, coordsToLatLng);
- return new L.Polygon(latlngs, options);
+// @factory L.circleMarker(latlng: LatLng, options?: CircleMarker options)
+// Instantiates a circle marker object given a geographical point, and an optional options object.
+L.circleMarker = function (latlng, options) {
+ return new L.CircleMarker(latlng, options);
+};
- case 'GeometryCollection':
- for (i = 0, len = geometry.geometries.length; i < len; i++) {
- var layer = this.geometryToLayer({
- geometry: geometry.geometries[i],
- type: 'Feature',
- properties: geojson.properties
- }, options);
- if (layer) {
- layers.push(layer);
- }
- }
- return new L.FeatureGroup(layers);
- default:
- throw new Error('Invalid GeoJSON object.');
+/*
+ * @class Circle
+ * @aka L.Circle
+ * @inherits CircleMarker
+ *
+ * A class for drawing circle overlays on a map. Extends `CircleMarker`.
+ *
+ * It's an approximation and starts to diverge from a real circle closer to poles (due to projection distortion).
+ *
+ * @example
+ *
+ * ```js
+ * L.circle([50.5, 30.5], {radius: 200}).addTo(map);
+ * ```
+ */
+
+L.Circle = L.CircleMarker.extend({
+
+ initialize: function (latlng, options, legacyOptions) {
+ if (typeof options === 'number') {
+ // Backwards compatibility with 0.7.x factory (latlng, radius, options?)
+ options = L.extend({}, legacyOptions, {radius: options});
}
- },
+ L.setOptions(this, options);
+ this._latlng = L.latLng(latlng);
- // @function coordsToLatLng(coords: Array): LatLng
- // Creates a `LatLng` object from an array of 2 numbers (longitude, latitude)
- // or 3 numbers (longitude, latitude, altitude) used in GeoJSON for points.
- coordsToLatLng: function (coords) {
- return new L.LatLng(coords[1], coords[0], coords[2]);
+ if (isNaN(this.options.radius)) { throw new Error('Circle radius cannot be NaN'); }
+
+ // @section
+ // @aka Circle options
+ // @option radius: Number; Radius of the circle, in meters.
+ this._mRadius = this.options.radius;
},
- // @function coordsToLatLngs(coords: Array, levelsDeep?: Number, coordsToLatLng?: Function): Array
- // Creates a multidimensional array of `LatLng`s from a GeoJSON coordinates array.
- // `levelsDeep` specifies the nesting level (0 is for an array of points, 1 for an array of arrays of points, etc., 0 by default).
- // Can use a custom [`coordsToLatLng`](#geojson-coordstolatlng) function.
- coordsToLatLngs: function (coords, levelsDeep, coordsToLatLng) {
- var latlngs = [];
+ // @method setRadius(radius: Number): this
+ // Sets the radius of a circle. Units are in meters.
+ setRadius: function (radius) {
+ this._mRadius = radius;
+ return this.redraw();
+ },
- for (var i = 0, len = coords.length, latlng; i < len; i++) {
- latlng = levelsDeep ?
- this.coordsToLatLngs(coords[i], levelsDeep - 1, coordsToLatLng) :
- (coordsToLatLng || this.coordsToLatLng)(coords[i]);
+ // @method getRadius(): Number
+ // Returns the current radius of a circle. Units are in meters.
+ getRadius: function () {
+ return this._mRadius;
+ },
- latlngs.push(latlng);
- }
+ // @method getBounds(): LatLngBounds
+ // Returns the `LatLngBounds` of the path.
+ getBounds: function () {
+ var half = [this._radius, this._radiusY || this._radius];
- return latlngs;
+ return new L.LatLngBounds(
+ this._map.layerPointToLatLng(this._point.subtract(half)),
+ this._map.layerPointToLatLng(this._point.add(half)));
},
- // @function latLngToCoords(latlng: LatLng): Array
- // Reverse of [`coordsToLatLng`](#geojson-coordstolatlng)
- latLngToCoords: function (latlng) {
- return latlng.alt !== undefined ?
- [latlng.lng, latlng.lat, latlng.alt] :
- [latlng.lng, latlng.lat];
- },
+ setStyle: L.Path.prototype.setStyle,
- // @function latLngsToCoords(latlngs: Array, levelsDeep?: Number, closed?: Boolean): Array
- // Reverse of [`coordsToLatLngs`](#geojson-coordstolatlngs)
- // `closed` determines whether the first point should be appended to the end of the array to close the feature, only used when `levelsDeep` is 0. False by default.
- latLngsToCoords: function (latlngs, levelsDeep, closed) {
- var coords = [];
+ _project: function () {
- for (var i = 0, len = latlngs.length; i < len; i++) {
- coords.push(levelsDeep ?
- L.GeoJSON.latLngsToCoords(latlngs[i], levelsDeep - 1, closed) :
- L.GeoJSON.latLngToCoords(latlngs[i]));
- }
+ var lng = this._latlng.lng,
+ lat = this._latlng.lat,
+ map = this._map,
+ crs = map.options.crs;
- if (!levelsDeep && closed) {
- coords.push(coords[0]);
- }
+ if (crs.distance === L.CRS.Earth.distance) {
+ var d = Math.PI / 180,
+ latR = (this._mRadius / L.CRS.Earth.R) / d,
+ top = map.project([lat + latR, lng]),
+ bottom = map.project([lat - latR, lng]),
+ p = top.add(bottom).divideBy(2),
+ lat2 = map.unproject(p).lat,
+ lngR = Math.acos((Math.cos(latR * d) - Math.sin(lat * d) * Math.sin(lat2 * d)) /
+ (Math.cos(lat * d) * Math.cos(lat2 * d))) / d;
- return coords;
- },
+ if (isNaN(lngR) || lngR === 0) {
+ lngR = latR / Math.cos(Math.PI / 180 * lat); // Fallback for edge case, #2425
+ }
- getFeature: function (layer, newGeometry) {
- return layer.feature ?
- L.extend({}, layer.feature, {geometry: newGeometry}) :
- L.GeoJSON.asFeature(newGeometry);
- },
+ this._point = p.subtract(map.getPixelOrigin());
+ this._radius = isNaN(lngR) ? 0 : Math.max(Math.round(p.x - map.project([lat2, lng - lngR]).x), 1);
+ this._radiusY = Math.max(Math.round(p.y - top.y), 1);
- // @function asFeature(geojson: Object): Object
- // Normalize GeoJSON geometries/features into GeoJSON features.
- asFeature: function (geojson) {
- if (geojson.type === 'Feature') {
- return geojson;
+ } else {
+ var latlng2 = crs.unproject(crs.project(this._latlng).subtract([this._mRadius, 0]));
+
+ this._point = map.latLngToLayerPoint(this._latlng);
+ this._radius = this._point.x - map.latLngToLayerPoint(latlng2).x;
}
- return {
- type: 'Feature',
- properties: {},
- geometry: geojson
- };
+ this._updateBounds();
}
});
-var PointToGeoJSON = {
- toGeoJSON: function () {
- return L.GeoJSON.getFeature(this, {
- type: 'Point',
- coordinates: L.GeoJSON.latLngToCoords(this.getLatLng())
- });
- }
+// @factory L.circle(latlng: LatLng, options?: Circle options)
+// Instantiates a circle object given a geographical point, and an options object
+// which contains the circle radius.
+// @alternative
+// @factory L.circle(latlng: LatLng, radius: Number, options?: Circle options)
+// Obsolete way of instantiating a circle, for compatibility with 0.7.x code.
+// Do not use in new applications or plugins.
+L.circle = function (latlng, options, legacyOptions) {
+ return new L.Circle(latlng, options, legacyOptions);
};
-L.Marker.include(PointToGeoJSON);
-// @namespace CircleMarker
-// @method toGeoJSON(): Object
-// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the circle marker (as a GeoJSON `Point` Feature).
-L.Circle.include(PointToGeoJSON);
-L.CircleMarker.include(PointToGeoJSON);
+/*
+ * @class SVG
+ * @inherits Renderer
+ * @aka L.SVG
+ *
+ * Allows vector layers to be displayed with [SVG](https://developer.mozilla.org/docs/Web/SVG).
+ * Inherits `Renderer`.
+ *
+ * Due to [technical limitations](http://caniuse.com/#search=svg), SVG is not
+ * available in all web browsers, notably Android 2.x and 3.x.
+ *
+ * Although SVG is not available on IE7 and IE8, these browsers support
+ * [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language)
+ * (a now deprecated technology), and the SVG renderer will fall back to VML in
+ * this case.
+ *
+ * @example
+ *
+ * Use SVG by default for all paths in the map:
+ *
+ * ```js
+ * var map = L.map('map', {
+ * renderer: L.svg()
+ * });
+ * ```
+ *
+ * Use a SVG renderer with extra padding for specific vector geometries:
+ *
+ * ```js
+ * var map = L.map('map');
+ * var myRenderer = L.svg({ padding: 0.5 });
+ * var line = L.polyline( coordinates, { renderer: myRenderer } );
+ * var circle = L.circle( center, { renderer: myRenderer } );
+ * ```
+ */
+
+L.SVG = L.Renderer.extend({
+
+ getEvents: function () {
+ var events = L.Renderer.prototype.getEvents.call(this);
+ events.zoomstart = this._onZoomStart;
+ return events;
+ },
+
+ _initContainer: function () {
+ this._container = L.SVG.create('svg');
+
+ // makes it possible to click through svg root; we'll reset it back in individual paths
+ this._container.setAttribute('pointer-events', 'none');
+
+ this._rootGroup = L.SVG.create('g');
+ this._container.appendChild(this._rootGroup);
+ },
+
+ _onZoomStart: function () {
+ // Drag-then-pinch interactions might mess up the center and zoom.
+ // In this case, the easiest way to prevent this is re-do the renderer
+ // bounds and padding when the zooming starts.
+ this._update();
+ },
+
+ _update: function () {
+ if (this._map._animatingZoom && this._bounds) { return; }
-// @namespace Polyline
-// @method toGeoJSON(): Object
-// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the polyline (as a GeoJSON `LineString` or `MultiLineString` Feature).
-L.Polyline.prototype.toGeoJSON = function () {
- var multi = !L.Polyline._flat(this._latlngs);
+ L.Renderer.prototype._update.call(this);
- var coords = L.GeoJSON.latLngsToCoords(this._latlngs, multi ? 1 : 0);
+ var b = this._bounds,
+ size = b.getSize(),
+ container = this._container;
- return L.GeoJSON.getFeature(this, {
- type: (multi ? 'Multi' : '') + 'LineString',
- coordinates: coords
- });
-};
+ // set size of svg-container if changed
+ if (!this._svgSize || !this._svgSize.equals(size)) {
+ this._svgSize = size;
+ container.setAttribute('width', size.x);
+ container.setAttribute('height', size.y);
+ }
-// @namespace Polygon
-// @method toGeoJSON(): Object
-// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the polygon (as a GeoJSON `Polygon` or `MultiPolygon` Feature).
-L.Polygon.prototype.toGeoJSON = function () {
- var holes = !L.Polyline._flat(this._latlngs),
- multi = holes && !L.Polyline._flat(this._latlngs[0]);
+ // movement: update container viewBox so that we don't have to change coordinates of individual layers
+ L.DomUtil.setPosition(container, b.min);
+ container.setAttribute('viewBox', [b.min.x, b.min.y, size.x, size.y].join(' '));
- var coords = L.GeoJSON.latLngsToCoords(this._latlngs, multi ? 2 : holes ? 1 : 0, true);
+ this.fire('update');
+ },
- if (!holes) {
- coords = [coords];
- }
+ // methods below are called by vector layers implementations
- return L.GeoJSON.getFeature(this, {
- type: (multi ? 'Multi' : '') + 'Polygon',
- coordinates: coords
- });
-};
+ _initPath: function (layer) {
+ var path = layer._path = L.SVG.create('path');
+ // @namespace Path
+ // @option className: String = null
+ // Custom class name set on an element. Only for SVG renderer.
+ if (layer.options.className) {
+ L.DomUtil.addClass(path, layer.options.className);
+ }
-// @namespace LayerGroup
-L.LayerGroup.include({
- toMultiPoint: function () {
- var coords = [];
+ if (layer.options.interactive) {
+ L.DomUtil.addClass(path, 'leaflet-interactive');
+ }
- this.eachLayer(function (layer) {
- coords.push(layer.toGeoJSON().geometry.coordinates);
- });
+ this._updateStyle(layer);
+ this._layers[L.stamp(layer)] = layer;
+ },
- return L.GeoJSON.getFeature(this, {
- type: 'MultiPoint',
- coordinates: coords
- });
+ _addPath: function (layer) {
+ this._rootGroup.appendChild(layer._path);
+ layer.addInteractiveTarget(layer._path);
},
- // @method toGeoJSON(): Object
- // Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the layer group (as a GeoJSON `GeometryCollection`).
- toGeoJSON: function () {
+ _removePath: function (layer) {
+ L.DomUtil.remove(layer._path);
+ layer.removeInteractiveTarget(layer._path);
+ delete this._layers[L.stamp(layer)];
+ },
- var type = this.feature && this.feature.geometry && this.feature.geometry.type;
+ _updatePath: function (layer) {
+ layer._project();
+ layer._update();
+ },
- if (type === 'MultiPoint') {
- return this.toMultiPoint();
- }
+ _updateStyle: function (layer) {
+ var path = layer._path,
+ options = layer.options;
- var isGeometryCollection = type === 'GeometryCollection',
- jsons = [];
+ if (!path) { return; }
- this.eachLayer(function (layer) {
- if (layer.toGeoJSON) {
- var json = layer.toGeoJSON();
- jsons.push(isGeometryCollection ? json.geometry : L.GeoJSON.asFeature(json));
+ if (options.stroke) {
+ path.setAttribute('stroke', options.color);
+ path.setAttribute('stroke-opacity', options.opacity);
+ path.setAttribute('stroke-width', options.weight);
+ path.setAttribute('stroke-linecap', options.lineCap);
+ path.setAttribute('stroke-linejoin', options.lineJoin);
+
+ if (options.dashArray) {
+ path.setAttribute('stroke-dasharray', options.dashArray);
+ } else {
+ path.removeAttribute('stroke-dasharray');
}
- });
- if (isGeometryCollection) {
- return L.GeoJSON.getFeature(this, {
- geometries: jsons,
- type: 'GeometryCollection'
- });
+ if (options.dashOffset) {
+ path.setAttribute('stroke-dashoffset', options.dashOffset);
+ } else {
+ path.removeAttribute('stroke-dashoffset');
+ }
+ } else {
+ path.setAttribute('stroke', 'none');
}
- return {
- type: 'FeatureCollection',
- features: jsons
- };
- }
-});
+ if (options.fill) {
+ path.setAttribute('fill', options.fillColor || options.color);
+ path.setAttribute('fill-opacity', options.fillOpacity);
+ path.setAttribute('fill-rule', options.fillRule || 'evenodd');
+ } else {
+ path.setAttribute('fill', 'none');
+ }
+ },
-// @namespace GeoJSON
-// @factory L.geoJSON(geojson?: Object, options?: GeoJSON options)
-// Creates a GeoJSON layer. Optionally accepts an object in
-// [GeoJSON format](http://geojson.org/geojson-spec.html) to display on the map
-// (you can alternatively add it later with `addData` method) and an `options` object.
-L.geoJSON = function (geojson, options) {
- return new L.GeoJSON(geojson, options);
-};
-// Backward compatibility.
-L.geoJson = L.geoJSON;
+ _updatePoly: function (layer, closed) {
+ this._setPath(layer, L.SVG.pointsToPath(layer._parts, closed));
+ },
+ _updateCircle: function (layer) {
+ var p = layer._point,
+ r = layer._radius,
+ r2 = layer._radiusY || r,
+ arc = 'a' + r + ',' + r2 + ' 0 1,0 ';
+ // drawing a circle with two half-arcs
+ var d = layer._empty() ? 'M0 0' :
+ 'M' + (p.x - r) + ',' + p.y +
+ arc + (r * 2) + ',0 ' +
+ arc + (-r * 2) + ',0 ';
-/*
- * @namespace DomEvent
- * Utility functions to work with the [DOM events](https://developer.mozilla.org/docs/Web/API/Event), used by Leaflet internally.
- */
+ this._setPath(layer, d);
+ },
-// Inspired by John Resig, Dean Edwards and YUI addEvent implementations.
+ _setPath: function (layer, path) {
+ layer._path.setAttribute('d', path);
+ },
+ // SVG does not have the concept of zIndex so we resort to changing the DOM order of elements
+ _bringToFront: function (layer) {
+ L.DomUtil.toFront(layer._path);
+ },
+ _bringToBack: function (layer) {
+ L.DomUtil.toBack(layer._path);
+ }
+});
-var eventsKey = '_leaflet_events';
-L.DomEvent = {
+// @namespace SVG; @section
+// There are several static functions which can be called without instantiating L.SVG:
+L.extend(L.SVG, {
+ // @function create(name: String): SVGElement
+ // Returns a instance of [SVGElement](https://developer.mozilla.org/docs/Web/API/SVGElement),
+ // corresponding to the class name passed. For example, using 'line' will return
+ // an instance of [SVGLineElement](https://developer.mozilla.org/docs/Web/API/SVGLineElement).
+ create: function (name) {
+ return document.createElementNS('http://www.w3.org/2000/svg', name);
+ },
- // @function on(el: HTMLElement, types: String, fn: Function, context?: Object): this
- // Adds a listener function (`fn`) to a particular DOM event type of the
- // element `el`. You can optionally specify the context of the listener
- // (object the `this` keyword will point to). You can also pass several
- // space-separated types (e.g. `'click dblclick'`).
+ // @function pointsToPath(rings: Point[], closed: Boolean): String
+ // Generates a SVG path string for multiple rings, with each ring turning
+ // into "M..L..L.." instructions
+ pointsToPath: function (rings, closed) {
+ var str = '',
+ i, j, len, len2, points, p;
- // @alternative
- // @function on(el: HTMLElement, eventMap: Object, context?: Object): this
- // Adds a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}`
- on: function (obj, types, fn, context) {
+ for (i = 0, len = rings.length; i < len; i++) {
+ points = rings[i];
- if (typeof types === 'object') {
- for (var type in types) {
- this._on(obj, type, types[type], fn);
+ for (j = 0, len2 = points.length; j < len2; j++) {
+ p = points[j];
+ str += (j ? 'L' : 'M') + p.x + ' ' + p.y;
}
- } else {
- types = L.Util.splitWords(types);
- for (var i = 0, len = types.length; i < len; i++) {
- this._on(obj, types[i], fn, context);
- }
+ // closes the ring for polygons; "x" is VML syntax
+ str += closed ? (L.Browser.svg ? 'z' : 'x') : '';
}
- return this;
- },
+ // SVG complains about empty path strings
+ return str || 'M0 0';
+ }
+});
- // @function off(el: HTMLElement, types: String, fn: Function, context?: Object): this
- // Removes a previously added listener function. If no function is specified,
- // it will remove all the listeners of that particular DOM event from the element.
- // Note that if you passed a custom context to on, you must pass the same
- // context to `off` in order to remove the listener.
+// @namespace Browser; @property svg: Boolean
+// `true` when the browser supports [SVG](https://developer.mozilla.org/docs/Web/SVG).
+L.Browser.svg = !!(document.createElementNS && L.SVG.create('svg').createSVGRect);
- // @alternative
- // @function off(el: HTMLElement, eventMap: Object, context?: Object): this
- // Removes a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}`
- off: function (obj, types, fn, context) {
- if (typeof types === 'object') {
- for (var type in types) {
- this._off(obj, type, types[type], fn);
- }
- } else {
- types = L.Util.splitWords(types);
+// @namespace SVG
+// @factory L.svg(options?: Renderer options)
+// Creates a SVG renderer with the given options.
+L.svg = function (options) {
+ return L.Browser.svg || L.Browser.vml ? new L.SVG(options) : null;
+};
+
- for (var i = 0, len = types.length; i < len; i++) {
- this._off(obj, types[i], fn, context);
- }
- }
- return this;
- },
+/*
+ * Thanks to Dmitry Baranovsky and his Raphael library for inspiration!
+ */
- _on: function (obj, type, fn, context) {
- var id = type + L.stamp(fn) + (context ? '_' + L.stamp(context) : '');
+/*
+ * @class SVG
+ *
+ * Although SVG is not available on IE7 and IE8, these browsers support [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language), and the SVG renderer will fall back to VML in this case.
+ *
+ * VML was deprecated in 2012, which means VML functionality exists only for backwards compatibility
+ * with old versions of Internet Explorer.
+ */
- if (obj[eventsKey] && obj[eventsKey][id]) { return this; }
+// @namespace Browser; @property vml: Boolean
+// `true` if the browser supports [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language).
+L.Browser.vml = !L.Browser.svg && (function () {
+ try {
+ var div = document.createElement('div');
+ div.innerHTML = '<v:shape adj="1"/>';
- var handler = function (e) {
- return fn.call(context || obj, e || window.event);
- };
+ var shape = div.firstChild;
+ shape.style.behavior = 'url(#default#VML)';
- var originalHandler = handler;
+ return shape && (typeof shape.adj === 'object');
- if (L.Browser.pointer && type.indexOf('touch') === 0) {
- this.addPointerListener(obj, type, handler, id);
+ } catch (e) {
+ return false;
+ }
+}());
- } else if (L.Browser.touch && (type === 'dblclick') && this.addDoubleTapListener) {
- this.addDoubleTapListener(obj, handler, id);
+// redefine some SVG methods to handle VML syntax which is similar but with some differences
+L.SVG.include(!L.Browser.vml ? {} : {
- } else if ('addEventListener' in obj) {
+ _initContainer: function () {
+ this._container = L.DomUtil.create('div', 'leaflet-vml-container');
+ },
- if (type === 'mousewheel') {
- obj.addEventListener('onwheel' in obj ? 'wheel' : 'mousewheel', handler, false);
+ _update: function () {
+ if (this._map._animatingZoom) { return; }
+ L.Renderer.prototype._update.call(this);
+ this.fire('update');
+ },
- } else if ((type === 'mouseenter') || (type === 'mouseleave')) {
- handler = function (e) {
- e = e || window.event;
- if (L.DomEvent._isExternalTarget(obj, e)) {
- originalHandler(e);
- }
- };
- obj.addEventListener(type === 'mouseenter' ? 'mouseover' : 'mouseout', handler, false);
+ _initPath: function (layer) {
+ var container = layer._container = L.SVG.create('shape');
- } else {
- if (type === 'click' && L.Browser.android) {
- handler = function (e) {
- return L.DomEvent._filterClick(e, originalHandler);
- };
- }
- obj.addEventListener(type, handler, false);
- }
+ L.DomUtil.addClass(container, 'leaflet-vml-shape ' + (this.options.className || ''));
- } else if ('attachEvent' in obj) {
- obj.attachEvent('on' + type, handler);
- }
+ container.coordsize = '1 1';
- obj[eventsKey] = obj[eventsKey] || {};
- obj[eventsKey][id] = handler;
+ layer._path = L.SVG.create('path');
+ container.appendChild(layer._path);
- return this;
+ this._updateStyle(layer);
},
- _off: function (obj, type, fn, context) {
-
- var id = type + L.stamp(fn) + (context ? '_' + L.stamp(context) : ''),
- handler = obj[eventsKey] && obj[eventsKey][id];
+ _addPath: function (layer) {
+ var container = layer._container;
+ this._container.appendChild(container);
- if (!handler) { return this; }
+ if (layer.options.interactive) {
+ layer.addInteractiveTarget(container);
+ }
+ },
- if (L.Browser.pointer && type.indexOf('touch') === 0) {
- this.removePointerListener(obj, type, id);
+ _removePath: function (layer) {
+ var container = layer._container;
+ L.DomUtil.remove(container);
+ layer.removeInteractiveTarget(container);
+ },
- } else if (L.Browser.touch && (type === 'dblclick') && this.removeDoubleTapListener) {
- this.removeDoubleTapListener(obj, id);
+ _updateStyle: function (layer) {
+ var stroke = layer._stroke,
+ fill = layer._fill,
+ options = layer.options,
+ container = layer._container;
- } else if ('removeEventListener' in obj) {
+ container.stroked = !!options.stroke;
+ container.filled = !!options.fill;
- if (type === 'mousewheel') {
- obj.removeEventListener('onwheel' in obj ? 'wheel' : 'mousewheel', handler, false);
+ if (options.stroke) {
+ if (!stroke) {
+ stroke = layer._stroke = L.SVG.create('stroke');
+ }
+ container.appendChild(stroke);
+ stroke.weight = options.weight + 'px';
+ stroke.color = options.color;
+ stroke.opacity = options.opacity;
+ if (options.dashArray) {
+ stroke.dashStyle = L.Util.isArray(options.dashArray) ?
+ options.dashArray.join(' ') :
+ options.dashArray.replace(/( *, *)/g, ' ');
} else {
- obj.removeEventListener(
- type === 'mouseenter' ? 'mouseover' :
- type === 'mouseleave' ? 'mouseout' : type, handler, false);
+ stroke.dashStyle = '';
}
+ stroke.endcap = options.lineCap.replace('butt', 'flat');
+ stroke.joinstyle = options.lineJoin;
- } else if ('detachEvent' in obj) {
- obj.detachEvent('on' + type, handler);
+ } else if (stroke) {
+ container.removeChild(stroke);
+ layer._stroke = null;
}
- obj[eventsKey][id] = null;
+ if (options.fill) {
+ if (!fill) {
+ fill = layer._fill = L.SVG.create('fill');
+ }
+ container.appendChild(fill);
+ fill.color = options.fillColor || options.color;
+ fill.opacity = options.fillOpacity;
- return this;
+ } else if (fill) {
+ container.removeChild(fill);
+ layer._fill = null;
+ }
},
- // @function stopPropagation(ev: DOMEvent): this
- // Stop the given event from propagation to parent elements. Used inside the listener functions:
- // ```js
- // L.DomEvent.on(div, 'click', function (ev) {
- // L.DomEvent.stopPropagation(ev);
- // });
- // ```
- stopPropagation: function (e) {
+ _updateCircle: function (layer) {
+ var p = layer._point.round(),
+ r = Math.round(layer._radius),
+ r2 = Math.round(layer._radiusY || r);
- if (e.stopPropagation) {
- e.stopPropagation();
- } else if (e.originalEvent) { // In case of Leaflet event.
- e.originalEvent._stopped = true;
- } else {
- e.cancelBubble = true;
- }
- L.DomEvent._skipped(e);
+ this._setPath(layer, layer._empty() ? 'M0 0' :
+ 'AL ' + p.x + ',' + p.y + ' ' + r + ',' + r2 + ' 0,' + (65535 * 360));
+ },
- return this;
+ _setPath: function (layer, path) {
+ layer._path.v = path;
},
- // @function disableScrollPropagation(el: HTMLElement): this
- // Adds `stopPropagation` to the element's `'mousewheel'` events (plus browser variants).
- disableScrollPropagation: function (el) {
- return L.DomEvent.on(el, 'mousewheel', L.DomEvent.stopPropagation);
+ _bringToFront: function (layer) {
+ L.DomUtil.toFront(layer._container);
},
- // @function disableClickPropagation(el: HTMLElement): this
- // Adds `stopPropagation` to the element's `'click'`, `'doubleclick'`,
- // `'mousedown'` and `'touchstart'` events (plus browser variants).
- disableClickPropagation: function (el) {
- var stop = L.DomEvent.stopPropagation;
+ _bringToBack: function (layer) {
+ L.DomUtil.toBack(layer._container);
+ }
+});
- L.DomEvent.on(el, L.Draggable.START.join(' '), stop);
+if (L.Browser.vml) {
+ L.SVG.create = (function () {
+ try {
+ document.namespaces.add('lvml', 'urn:schemas-microsoft-com:vml');
+ return function (name) {
+ return document.createElement('<lvml:' + name + ' class="lvml">');
+ };
+ } catch (e) {
+ return function (name) {
+ return document.createElement('<' + name + ' xmlns="urn:schemas-microsoft.com:vml" class="lvml">');
+ };
+ }
+ })();
+}
- return L.DomEvent.on(el, {
- click: L.DomEvent._fakeStop,
- dblclick: stop
- });
- },
- // @function preventDefault(ev: DOMEvent): this
- // Prevents the default action of the DOM Event `ev` from happening (such as
- // following a link in the href of the a element, or doing a POST request
- // with page reload when a `<form>` is submitted).
- // Use it inside listener functions.
- preventDefault: function (e) {
- if (e.preventDefault) {
- e.preventDefault();
- } else {
- e.returnValue = false;
- }
- return this;
- },
+/*
+ * @class Canvas
+ * @inherits Renderer
+ * @aka L.Canvas
+ *
+ * Allows vector layers to be displayed with [`<canvas>`](https://developer.mozilla.org/docs/Web/API/Canvas_API).
+ * Inherits `Renderer`.
+ *
+ * Due to [technical limitations](http://caniuse.com/#search=canvas), Canvas is not
+ * available in all web browsers, notably IE8, and overlapping geometries might
+ * not display properly in some edge cases.
+ *
+ * @example
+ *
+ * Use Canvas by default for all paths in the map:
+ *
+ * ```js
+ * var map = L.map('map', {
+ * renderer: L.canvas()
+ * });
+ * ```
+ *
+ * Use a Canvas renderer with extra padding for specific vector geometries:
+ *
+ * ```js
+ * var map = L.map('map');
+ * var myRenderer = L.canvas({ padding: 0.5 });
+ * var line = L.polyline( coordinates, { renderer: myRenderer } );
+ * var circle = L.circle( center, { renderer: myRenderer } );
+ * ```
+ */
+
+L.Canvas = L.Renderer.extend({
+
+ onAdd: function () {
+ L.Renderer.prototype.onAdd.call(this);
- // @function stop(ev): this
- // Does `stopPropagation` and `preventDefault` at the same time.
- stop: function (e) {
- return L.DomEvent
- .preventDefault(e)
- .stopPropagation(e);
+ // Redraw vectors since canvas is cleared upon removal,
+ // in case of removing the renderer itself from the map.
+ this._draw();
},
- // @function getMousePosition(ev: DOMEvent, container?: HTMLElement): Point
- // Gets normalized mouse position from a DOM event relative to the
- // `container` or to the whole page if not specified.
- getMousePosition: function (e, container) {
- if (!container) {
- return new L.Point(e.clientX, e.clientY);
- }
+ _initContainer: function () {
+ var container = this._container = document.createElement('canvas');
- var rect = container.getBoundingClientRect();
+ L.DomEvent
+ .on(container, 'mousemove', L.Util.throttle(this._onMouseMove, 32, this), this)
+ .on(container, 'click dblclick mousedown mouseup contextmenu', this._onClick, this)
+ .on(container, 'mouseout', this._handleMouseOut, this);
- return new L.Point(
- e.clientX - rect.left - container.clientLeft,
- e.clientY - rect.top - container.clientTop);
+ this._ctx = container.getContext('2d');
},
- // Chrome on Win scrolls double the pixels as in other platforms (see #4538),
- // and Firefox scrolls device pixels, not CSS pixels
- _wheelPxFactor: (L.Browser.win && L.Browser.chrome) ? 2 :
- L.Browser.gecko ? window.devicePixelRatio :
- 1,
-
- // @function getWheelDelta(ev: DOMEvent): Number
- // Gets normalized wheel delta from a mousewheel DOM event, in vertical
- // pixels scrolled (negative if scrolling down).
- // Events from pointing devices without precise scrolling are mapped to
- // a best guess of 60 pixels.
- getWheelDelta: function (e) {
- return (L.Browser.edge) ? e.wheelDeltaY / 2 : // Don't trust window-geometry-based delta
- (e.deltaY && e.deltaMode === 0) ? -e.deltaY / L.DomEvent._wheelPxFactor : // Pixels
- (e.deltaY && e.deltaMode === 1) ? -e.deltaY * 20 : // Lines
- (e.deltaY && e.deltaMode === 2) ? -e.deltaY * 60 : // Pages
- (e.deltaX || e.deltaZ) ? 0 : // Skip horizontal/depth wheel events
- e.wheelDelta ? (e.wheelDeltaY || e.wheelDelta) / 2 : // Legacy IE pixels
- (e.detail && Math.abs(e.detail) < 32765) ? -e.detail * 20 : // Legacy Moz lines
- e.detail ? e.detail / -32765 * 60 : // Legacy Moz pages
- 0;
+ _updatePaths: function () {
+ var layer;
+ this._redrawBounds = null;
+ for (var id in this._layers) {
+ layer = this._layers[id];
+ layer._update();
+ }
+ this._redraw();
},
- _skipEvents: {},
+ _update: function () {
+ if (this._map._animatingZoom && this._bounds) { return; }
- _fakeStop: function (e) {
- // fakes stopPropagation by setting a special event flag, checked/reset with L.DomEvent._skipped(e)
- L.DomEvent._skipEvents[e.type] = true;
- },
+ this._drawnLayers = {};
- _skipped: function (e) {
- var skipped = this._skipEvents[e.type];
- // reset when checking, as it's only used in map container and propagates outside of the map
- this._skipEvents[e.type] = false;
- return skipped;
- },
+ L.Renderer.prototype._update.call(this);
- // check if element really left/entered the event target (for mouseenter/mouseleave)
- _isExternalTarget: function (el, e) {
+ var b = this._bounds,
+ container = this._container,
+ size = b.getSize(),
+ m = L.Browser.retina ? 2 : 1;
- var related = e.relatedTarget;
+ L.DomUtil.setPosition(container, b.min);
- if (!related) { return true; }
+ // set canvas size (also clearing it); use double size on retina
+ container.width = m * size.x;
+ container.height = m * size.y;
+ container.style.width = size.x + 'px';
+ container.style.height = size.y + 'px';
- try {
- while (related && (related !== el)) {
- related = related.parentNode;
- }
- } catch (err) {
- return false;
+ if (L.Browser.retina) {
+ this._ctx.scale(2, 2);
}
- return (related !== el);
- },
- // this is a horrible workaround for a bug in Android where a single touch triggers two click events
- _filterClick: function (e, handler) {
- var timeStamp = (e.timeStamp || (e.originalEvent && e.originalEvent.timeStamp)),
- elapsed = L.DomEvent._lastClick && (timeStamp - L.DomEvent._lastClick);
+ // translate so we use the same path coordinates after canvas element moves
+ this._ctx.translate(-b.min.x, -b.min.y);
- // are they closer together than 500ms yet more than 100ms?
- // Android typically triggers them ~300ms apart while multiple listeners
- // on the same event should be triggered far faster;
- // or check if click is simulated on the element, and if it is, reject any non-simulated events
+ // Tell paths to redraw themselves
+ this.fire('update');
+ },
- if ((elapsed && elapsed > 100 && elapsed < 500) || (e.target._simulatedClick && !e._simulated)) {
- L.DomEvent.stop(e);
- return;
- }
- L.DomEvent._lastClick = timeStamp;
+ _initPath: function (layer) {
+ this._updateDashArray(layer);
+ this._layers[L.stamp(layer)] = layer;
- handler(e);
- }
-};
+ var order = layer._order = {
+ layer: layer,
+ prev: this._drawLast,
+ next: null
+ };
+ if (this._drawLast) { this._drawLast.next = order; }
+ this._drawLast = order;
+ this._drawFirst = this._drawFirst || this._drawLast;
+ },
-// @function addListener(…): this
-// Alias to [`L.DomEvent.on`](#domevent-on)
-L.DomEvent.addListener = L.DomEvent.on;
+ _addPath: function (layer) {
+ this._requestRedraw(layer);
+ },
-// @function removeListener(…): this
-// Alias to [`L.DomEvent.off`](#domevent-off)
-L.DomEvent.removeListener = L.DomEvent.off;
+ _removePath: function (layer) {
+ var order = layer._order;
+ var next = order.next;
+ var prev = order.prev;
+ if (next) {
+ next.prev = prev;
+ } else {
+ this._drawLast = prev;
+ }
+ if (prev) {
+ prev.next = next;
+ } else {
+ this._drawFirst = next;
+ }
+ delete layer._order;
-/*
- * @class Draggable
- * @aka L.Draggable
- * @inherits Evented
- *
- * A class for making DOM elements draggable (including touch support).
- * Used internally for map and marker dragging. Only works for elements
- * that were positioned with [`L.DomUtil.setPosition`](#domutil-setposition).
- *
- * @example
- * ```js
- * var draggable = new L.Draggable(elementToDrag);
- * draggable.enable();
- * ```
- */
+ delete this._layers[L.stamp(layer)];
-L.Draggable = L.Evented.extend({
+ this._requestRedraw(layer);
+ },
- options: {
- // @option clickTolerance: Number = 3
- // The max number of pixels a user can shift the mouse pointer during a click
- // for it to be considered a valid click (as opposed to a mouse drag).
- clickTolerance: 3
+ _updatePath: function (layer) {
+ // Redraw the union of the layer's old pixel
+ // bounds and the new pixel bounds.
+ this._extendRedrawBounds(layer);
+ layer._project();
+ layer._update();
+ // The redraw will extend the redraw bounds
+ // with the new pixel bounds.
+ this._requestRedraw(layer);
},
- statics: {
- START: L.Browser.touch ? ['touchstart', 'mousedown'] : ['mousedown'],
- END: {
- mousedown: 'mouseup',
- touchstart: 'touchend',
- pointerdown: 'touchend',
- MSPointerDown: 'touchend'
- },
- MOVE: {
- mousedown: 'mousemove',
- touchstart: 'touchmove',
- pointerdown: 'touchmove',
- MSPointerDown: 'touchmove'
- }
+ _updateStyle: function (layer) {
+ this._updateDashArray(layer);
+ this._requestRedraw(layer);
},
- // @constructor L.Draggable(el: HTMLElement, dragHandle?: HTMLElement, preventOutline: Boolean)
- // Creates a `Draggable` object for moving `el` when you start dragging the `dragHandle` element (equals `el` itself by default).
- initialize: function (element, dragStartTarget, preventOutline) {
- this._element = element;
- this._dragStartTarget = dragStartTarget || element;
- this._preventOutline = preventOutline;
+ _updateDashArray: function (layer) {
+ if (layer.options.dashArray) {
+ var parts = layer.options.dashArray.split(','),
+ dashArray = [],
+ i;
+ for (i = 0; i < parts.length; i++) {
+ dashArray.push(Number(parts[i]));
+ }
+ layer.options._dashArray = dashArray;
+ }
},
- // @method enable()
- // Enables the dragging ability
- enable: function () {
- if (this._enabled) { return; }
+ _requestRedraw: function (layer) {
+ if (!this._map) { return; }
- L.DomEvent.on(this._dragStartTarget, L.Draggable.START.join(' '), this._onDown, this);
+ this._extendRedrawBounds(layer);
+ this._redrawRequest = this._redrawRequest || L.Util.requestAnimFrame(this._redraw, this);
+ },
- this._enabled = true;
+ _extendRedrawBounds: function (layer) {
+ var padding = (layer.options.weight || 0) + 1;
+ this._redrawBounds = this._redrawBounds || new L.Bounds();
+ this._redrawBounds.extend(layer._pxBounds.min.subtract([padding, padding]));
+ this._redrawBounds.extend(layer._pxBounds.max.add([padding, padding]));
},
- // @method disable()
- // Disables the dragging ability
- disable: function () {
- if (!this._enabled) { return; }
+ _redraw: function () {
+ this._redrawRequest = null;
- L.DomEvent.off(this._dragStartTarget, L.Draggable.START.join(' '), this._onDown, this);
+ this._clear(); // clear layers in redraw bounds
+ this._draw(); // draw layers
- this._enabled = false;
- this._moved = false;
+ this._redrawBounds = null;
},
- _onDown: function (e) {
- // Ignore simulated events, since we handle both touch and
- // mouse explicitly; otherwise we risk getting duplicates of
- // touch events, see #4315.
- // Also ignore the event if disabled; this happens in IE11
- // under some circumstances, see #3666.
- if (e._simulated || !this._enabled) { return; }
-
- this._moved = false;
+ _clear: function () {
+ var bounds = this._redrawBounds;
+ if (bounds) {
+ var size = bounds.getSize();
+ this._ctx.clearRect(bounds.min.x, bounds.min.y, size.x, size.y);
+ } else {
+ this._ctx.clearRect(0, 0, this._container.width, this._container.height);
+ }
+ },
- if (L.DomUtil.hasClass(this._element, 'leaflet-zoom-anim')) { return; }
+ _draw: function () {
+ var layer, bounds = this._redrawBounds;
+ this._ctx.save();
+ if (bounds) {
+ var size = bounds.getSize();
+ this._ctx.beginPath();
+ this._ctx.rect(bounds.min.x, bounds.min.y, size.x, size.y);
+ this._ctx.clip();
+ }
- if (L.Draggable._dragging || e.shiftKey || ((e.which !== 1) && (e.button !== 1) && !e.touches) || !this._enabled) { return; }
- L.Draggable._dragging = true; // Prevent dragging multiple objects at once.
+ this._drawing = true;
- if (this._preventOutline) {
- L.DomUtil.preventOutline(this._element);
+ for (var order = this._drawFirst; order; order = order.next) {
+ layer = order.layer;
+ if (!bounds || (layer._pxBounds && layer._pxBounds.intersects(bounds))) {
+ layer._updatePath();
+ }
}
- L.DomUtil.disableImageDrag();
- L.DomUtil.disableTextSelection();
+ this._drawing = false;
- if (this._moving) { return; }
+ this._ctx.restore(); // Restore state before clipping.
+ },
- // @event down: Event
- // Fired when a drag is about to start.
- this.fire('down');
+ _updatePoly: function (layer, closed) {
+ if (!this._drawing) { return; }
+
+ var i, j, len2, p,
+ parts = layer._parts,
+ len = parts.length,
+ ctx = this._ctx;
- var first = e.touches ? e.touches[0] : e;
+ if (!len) { return; }
- this._startPoint = new L.Point(first.clientX, first.clientY);
+ this._drawnLayers[layer._leaflet_id] = layer;
- L.DomEvent
- .on(document, L.Draggable.MOVE[e.type], this._onMove, this)
- .on(document, L.Draggable.END[e.type], this._onUp, this);
- },
+ ctx.beginPath();
- _onMove: function (e) {
- // Ignore simulated events, since we handle both touch and
- // mouse explicitly; otherwise we risk getting duplicates of
- // touch events, see #4315.
- // Also ignore the event if disabled; this happens in IE11
- // under some circumstances, see #3666.
- if (e._simulated || !this._enabled) { return; }
+ if (ctx.setLineDash) {
+ ctx.setLineDash(layer.options && layer.options._dashArray || []);
+ }
- if (e.touches && e.touches.length > 1) {
- this._moved = true;
- return;
+ for (i = 0; i < len; i++) {
+ for (j = 0, len2 = parts[i].length; j < len2; j++) {
+ p = parts[i][j];
+ ctx[j ? 'lineTo' : 'moveTo'](p.x, p.y);
+ }
+ if (closed) {
+ ctx.closePath();
+ }
}
- var first = (e.touches && e.touches.length === 1 ? e.touches[0] : e),
- newPoint = new L.Point(first.clientX, first.clientY),
- offset = newPoint.subtract(this._startPoint);
+ this._fillStroke(ctx, layer);
- if (!offset.x && !offset.y) { return; }
- if (Math.abs(offset.x) + Math.abs(offset.y) < this.options.clickTolerance) { return; }
+ // TODO optimization: 1 fill/stroke for all features with equal style instead of 1 for each feature
+ },
- L.DomEvent.preventDefault(e);
+ _updateCircle: function (layer) {
- if (!this._moved) {
- // @event dragstart: Event
- // Fired when a drag starts
- this.fire('dragstart');
+ if (!this._drawing || layer._empty()) { return; }
- this._moved = true;
- this._startPos = L.DomUtil.getPosition(this._element).subtract(offset);
+ var p = layer._point,
+ ctx = this._ctx,
+ r = layer._radius,
+ s = (layer._radiusY || r) / r;
- L.DomUtil.addClass(document.body, 'leaflet-dragging');
+ this._drawnLayers[layer._leaflet_id] = layer;
- this._lastTarget = e.target || e.srcElement;
- // IE and Edge do not give the <use> element, so fetch it
- // if necessary
- if ((window.SVGElementInstance) && (this._lastTarget instanceof SVGElementInstance)) {
- this._lastTarget = this._lastTarget.correspondingUseElement;
- }
- L.DomUtil.addClass(this._lastTarget, 'leaflet-drag-target');
+ if (s !== 1) {
+ ctx.save();
+ ctx.scale(1, s);
}
- this._newPos = this._startPos.add(offset);
- this._moving = true;
+ ctx.beginPath();
+ ctx.arc(p.x, p.y / s, r, 0, Math.PI * 2, false);
- L.Util.cancelAnimFrame(this._animRequest);
- this._lastEvent = e;
- this._animRequest = L.Util.requestAnimFrame(this._updatePosition, this, true);
+ if (s !== 1) {
+ ctx.restore();
+ }
+
+ this._fillStroke(ctx, layer);
},
- _updatePosition: function () {
- var e = {originalEvent: this._lastEvent};
+ _fillStroke: function (ctx, layer) {
+ var options = layer.options;
- // @event predrag: Event
- // Fired continuously during dragging *before* each corresponding
- // update of the element's position.
- this.fire('predrag', e);
- L.DomUtil.setPosition(this._element, this._newPos);
+ if (options.fill) {
+ ctx.globalAlpha = options.fillOpacity;
+ ctx.fillStyle = options.fillColor || options.color;
+ ctx.fill(options.fillRule || 'evenodd');
+ }
- // @event drag: Event
- // Fired continuously during dragging.
- this.fire('drag', e);
+ if (options.stroke && options.weight !== 0) {
+ ctx.globalAlpha = options.opacity;
+ ctx.lineWidth = options.weight;
+ ctx.strokeStyle = options.color;
+ ctx.lineCap = options.lineCap;
+ ctx.lineJoin = options.lineJoin;
+ ctx.stroke();
+ }
},
- _onUp: function (e) {
- // Ignore simulated events, since we handle both touch and
- // mouse explicitly; otherwise we risk getting duplicates of
- // touch events, see #4315.
- // Also ignore the event if disabled; this happens in IE11
- // under some circumstances, see #3666.
- if (e._simulated || !this._enabled) { return; }
+ // Canvas obviously doesn't have mouse events for individual drawn objects,
+ // so we emulate that by calculating what's under the mouse on mousemove/click manually
- L.DomUtil.removeClass(document.body, 'leaflet-dragging');
+ _onClick: function (e) {
+ var point = this._map.mouseEventToLayerPoint(e), layer, clickedLayer;
- if (this._lastTarget) {
- L.DomUtil.removeClass(this._lastTarget, 'leaflet-drag-target');
- this._lastTarget = null;
+ for (var order = this._drawFirst; order; order = order.next) {
+ layer = order.layer;
+ if (layer.options.interactive && layer._containsPoint(point) && !this._map._draggableMoved(layer)) {
+ clickedLayer = layer;
+ }
}
-
- for (var i in L.Draggable.MOVE) {
- L.DomEvent
- .off(document, L.Draggable.MOVE[i], this._onMove, this)
- .off(document, L.Draggable.END[i], this._onUp, this);
+ if (clickedLayer) {
+ L.DomEvent._fakeStop(e);
+ this._fireEvent([clickedLayer], e);
}
+ },
- L.DomUtil.enableImageDrag();
- L.DomUtil.enableTextSelection();
+ _onMouseMove: function (e) {
+ if (!this._map || this._map.dragging.moving() || this._map._animatingZoom) { return; }
- if (this._moved && this._moving) {
- // ensure drag is not fired after dragend
- L.Util.cancelAnimFrame(this._animRequest);
+ var point = this._map.mouseEventToLayerPoint(e);
+ this._handleMouseHover(e, point);
+ },
- // @event dragend: DragEndEvent
- // Fired when the drag ends.
- this.fire('dragend', {
- distance: this._newPos.distanceTo(this._startPos)
- });
+
+ _handleMouseOut: function (e) {
+ var layer = this._hoveredLayer;
+ if (layer) {
+ // if we're leaving the layer, fire mouseout
+ L.DomUtil.removeClass(this._container, 'leaflet-interactive');
+ this._fireEvent([layer], e, 'mouseout');
+ this._hoveredLayer = null;
}
+ },
- this._moving = false;
- L.Draggable._dragging = false;
- }
-});
+ _handleMouseHover: function (e, point) {
+ var layer, candidateHoveredLayer;
+ for (var order = this._drawFirst; order; order = order.next) {
+ layer = order.layer;
+ if (layer.options.interactive && layer._containsPoint(point)) {
+ candidateHoveredLayer = layer;
+ }
+ }
+ if (candidateHoveredLayer !== this._hoveredLayer) {
+ this._handleMouseOut(e);
-/*
- L.Handler is a base class for handler classes that are used internally to inject
- interaction features like dragging to classes like Map and Marker.
-*/
+ if (candidateHoveredLayer) {
+ L.DomUtil.addClass(this._container, 'leaflet-interactive'); // change cursor
+ this._fireEvent([candidateHoveredLayer], e, 'mouseover');
+ this._hoveredLayer = candidateHoveredLayer;
+ }
+ }
-// @class Handler
-// @aka L.Handler
-// Abstract class for map interaction handlers
+ if (this._hoveredLayer) {
+ this._fireEvent([this._hoveredLayer], e);
+ }
+ },
-L.Handler = L.Class.extend({
- initialize: function (map) {
- this._map = map;
+ _fireEvent: function (layers, e, type) {
+ this._map._fireDOMEvent(e, type || e.type, layers);
},
- // @method enable(): this
- // Enables the handler
- enable: function () {
- if (this._enabled) { return this; }
+ _bringToFront: function (layer) {
+ var order = layer._order;
+ var next = order.next;
+ var prev = order.prev;
- this._enabled = true;
- this.addHooks();
- return this;
- },
+ if (next) {
+ next.prev = prev;
+ } else {
+ // Already last
+ return;
+ }
+ if (prev) {
+ prev.next = next;
+ } else if (next) {
+ // Update first entry unless this is the
+ // signle entry
+ this._drawFirst = next;
+ }
- // @method disable(): this
- // Disables the handler
- disable: function () {
- if (!this._enabled) { return this; }
+ order.prev = this._drawLast;
+ this._drawLast.next = order;
- this._enabled = false;
- this.removeHooks();
- return this;
- },
+ order.next = null;
+ this._drawLast = order;
- // @method enabled(): Boolean
- // Returns `true` if the handler is enabled
- enabled: function () {
- return !!this._enabled;
- }
+ this._requestRedraw(layer);
+ },
- // @section Extension methods
- // Classes inheriting from `Handler` must implement the two following methods:
- // @method addHooks()
- // Called when the handler is enabled, should add event hooks.
- // @method removeHooks()
- // Called when the handler is disabled, should remove the event hooks added previously.
-});
+ _bringToBack: function (layer) {
+ var order = layer._order;
+ var next = order.next;
+ var prev = order.prev;
+ if (prev) {
+ prev.next = next;
+ } else {
+ // Already first
+ return;
+ }
+ if (next) {
+ next.prev = prev;
+ } else if (prev) {
+ // Update last entry unless this is the
+ // signle entry
+ this._drawLast = prev;
+ }
+ order.prev = null;
-/*
- * L.Handler.MapDrag is used to make the map draggable (with panning inertia), enabled by default.
- */
+ order.next = this._drawFirst;
+ this._drawFirst.prev = order;
+ this._drawFirst = order;
-// @namespace Map
-// @section Interaction Options
-L.Map.mergeOptions({
- // @option dragging: Boolean = true
- // Whether the map be draggable with mouse/touch or not.
- dragging: true,
+ this._requestRedraw(layer);
+ }
+});
- // @section Panning Inertia Options
- // @option inertia: Boolean = *
- // If enabled, panning of the map will have an inertia effect where
- // the map builds momentum while dragging and continues moving in
- // the same direction for some time. Feels especially nice on touch
- // devices. Enabled by default unless running on old Android devices.
- inertia: !L.Browser.android23,
+// @namespace Browser; @property canvas: Boolean
+// `true` when the browser supports [`<canvas>`](https://developer.mozilla.org/docs/Web/API/Canvas_API).
+L.Browser.canvas = (function () {
+ return !!document.createElement('canvas').getContext;
+}());
- // @option inertiaDeceleration: Number = 3000
- // The rate with which the inertial movement slows down, in pixels/second².
- inertiaDeceleration: 3400, // px/s^2
+// @namespace Canvas
+// @factory L.canvas(options?: Renderer options)
+// Creates a Canvas renderer with the given options.
+L.canvas = function (options) {
+ return L.Browser.canvas ? new L.Canvas(options) : null;
+};
- // @option inertiaMaxSpeed: Number = Infinity
- // Max speed of the inertial movement, in pixels/second.
- inertiaMaxSpeed: Infinity, // px/s
+L.Polyline.prototype._containsPoint = function (p, closed) {
+ var i, j, k, len, len2, part,
+ w = this._clickTolerance();
- // @option easeLinearity: Number = 0.2
- easeLinearity: 0.2,
+ if (!this._pxBounds.contains(p)) { return false; }
- // TODO refactor, move to CRS
- // @option worldCopyJump: Boolean = false
- // With this option enabled, the map tracks when you pan to another "copy"
- // of the world and seamlessly jumps to the original one so that all overlays
- // like markers and vector layers are still visible.
- worldCopyJump: false,
+ // hit detection for polylines
+ for (i = 0, len = this._parts.length; i < len; i++) {
+ part = this._parts[i];
- // @option maxBoundsViscosity: Number = 0.0
- // If `maxBounds` is set, this option will control how solid the bounds
- // are when dragging the map around. The default value of `0.0` allows the
- // user to drag outside the bounds at normal speed, higher values will
- // slow down map dragging outside bounds, and `1.0` makes the bounds fully
- // solid, preventing the user from dragging outside the bounds.
- maxBoundsViscosity: 0.0
-});
+ for (j = 0, len2 = part.length, k = len2 - 1; j < len2; k = j++) {
+ if (!closed && (j === 0)) { continue; }
-L.Map.Drag = L.Handler.extend({
- addHooks: function () {
- if (!this._draggable) {
- var map = this._map;
+ if (L.LineUtil.pointToSegmentDistance(p, part[k], part[j]) <= w) {
+ return true;
+ }
+ }
+ }
+ return false;
+};
- this._draggable = new L.Draggable(map._mapPane, map._container);
+L.Polygon.prototype._containsPoint = function (p) {
+ var inside = false,
+ part, p1, p2, i, j, k, len, len2;
- this._draggable.on({
- down: this._onDown,
- dragstart: this._onDragStart,
- drag: this._onDrag,
- dragend: this._onDragEnd
- }, this);
+ if (!this._pxBounds.contains(p)) { return false; }
- this._draggable.on('predrag', this._onPreDragLimit, this);
- if (map.options.worldCopyJump) {
- this._draggable.on('predrag', this._onPreDragWrap, this);
- map.on('zoomend', this._onZoomEnd, this);
+ // ray casting algorithm for detecting if point is in polygon
+ for (i = 0, len = this._parts.length; i < len; i++) {
+ part = this._parts[i];
- map.whenReady(this._onZoomEnd, this);
+ for (j = 0, len2 = part.length, k = len2 - 1; j < len2; k = j++) {
+ p1 = part[j];
+ p2 = part[k];
+
+ if (((p1.y > p.y) !== (p2.y > p.y)) && (p.x < (p2.x - p1.x) * (p.y - p1.y) / (p2.y - p1.y) + p1.x)) {
+ inside = !inside;
}
}
- L.DomUtil.addClass(this._map._container, 'leaflet-grab leaflet-touch-drag');
- this._draggable.enable();
- this._positions = [];
- this._times = [];
- },
+ }
- removeHooks: function () {
- L.DomUtil.removeClass(this._map._container, 'leaflet-grab');
- L.DomUtil.removeClass(this._map._container, 'leaflet-touch-drag');
- this._draggable.disable();
- },
+ // also check if it's on polygon stroke
+ return inside || L.Polyline.prototype._containsPoint.call(this, p, true);
+};
- moved: function () {
- return this._draggable && this._draggable._moved;
- },
+L.CircleMarker.prototype._containsPoint = function (p) {
+ return p.distanceTo(this._point) <= this._radius + this._clickTolerance();
+};
- moving: function () {
- return this._draggable && this._draggable._moving;
- },
- _onDown: function () {
- this._map._stop();
- },
- _onDragStart: function () {
- var map = this._map;
+/*
+ * @class GeoJSON
+ * @aka L.GeoJSON
+ * @inherits FeatureGroup
+ *
+ * Represents a GeoJSON object or an array of GeoJSON objects. Allows you to parse
+ * GeoJSON data and display it on the map. Extends `FeatureGroup`.
+ *
+ * @example
+ *
+ * ```js
+ * L.geoJSON(data, {
+ * style: function (feature) {
+ * return {color: feature.properties.color};
+ * }
+ * }).bindPopup(function (layer) {
+ * return layer.feature.properties.description;
+ * }).addTo(map);
+ * ```
+ */
- if (this._map.options.maxBounds && this._map.options.maxBoundsViscosity) {
- var bounds = L.latLngBounds(this._map.options.maxBounds);
+L.GeoJSON = L.FeatureGroup.extend({
- this._offsetLimit = L.bounds(
- this._map.latLngToContainerPoint(bounds.getNorthWest()).multiplyBy(-1),
- this._map.latLngToContainerPoint(bounds.getSouthEast()).multiplyBy(-1)
- .add(this._map.getSize()));
+ /* @section
+ * @aka GeoJSON options
+ *
+ * @option pointToLayer: Function = *
+ * A `Function` defining how GeoJSON points spawn Leaflet layers. It is internally
+ * called when data is added, passing the GeoJSON point feature and its `LatLng`.
+ * The default is to spawn a default `Marker`:
+ * ```js
+ * function(geoJsonPoint, latlng) {
+ * return L.marker(latlng);
+ * }
+ * ```
+ *
+ * @option style: Function = *
+ * A `Function` defining the `Path options` for styling GeoJSON lines and polygons,
+ * called internally when data is added.
+ * The default value is to not override any defaults:
+ * ```js
+ * function (geoJsonFeature) {
+ * return {}
+ * }
+ * ```
+ *
+ * @option onEachFeature: Function = *
+ * A `Function` that will be called once for each created `Feature`, after it has
+ * been created and styled. Useful for attaching events and popups to features.
+ * The default is to do nothing with the newly created layers:
+ * ```js
+ * function (feature, layer) {}
+ * ```
+ *
+ * @option filter: Function = *
+ * A `Function` that will be used to decide whether to include a feature or not.
+ * The default is to include all features:
+ * ```js
+ * function (geoJsonFeature) {
+ * return true;
+ * }
+ * ```
+ * Note: dynamically changing the `filter` option will have effect only on newly
+ * added data. It will _not_ re-evaluate already included features.
+ *
+ * @option coordsToLatLng: Function = *
+ * A `Function` that will be used for converting GeoJSON coordinates to `LatLng`s.
+ * The default is the `coordsToLatLng` static method.
+ */
- this._viscosity = Math.min(1.0, Math.max(0.0, this._map.options.maxBoundsViscosity));
- } else {
- this._offsetLimit = null;
- }
+ initialize: function (geojson, options) {
+ L.setOptions(this, options);
- map
- .fire('movestart')
- .fire('dragstart');
+ this._layers = {};
- if (map.options.inertia) {
- this._positions = [];
- this._times = [];
+ if (geojson) {
+ this.addData(geojson);
}
},
- _onDrag: function (e) {
- if (this._map.options.inertia) {
- var time = this._lastTime = +new Date(),
- pos = this._lastPos = this._draggable._absPos || this._draggable._newPos;
-
- this._positions.push(pos);
- this._times.push(time);
+ // @method addData( <GeoJSON> data ): this
+ // Adds a GeoJSON object to the layer.
+ addData: function (geojson) {
+ var features = L.Util.isArray(geojson) ? geojson : geojson.features,
+ i, len, feature;
- if (time - this._times[0] > 50) {
- this._positions.shift();
- this._times.shift();
+ if (features) {
+ for (i = 0, len = features.length; i < len; i++) {
+ // only add this if geometry or geometries are set and not null
+ feature = features[i];
+ if (feature.geometries || feature.geometry || feature.features || feature.coordinates) {
+ this.addData(feature);
+ }
}
+ return this;
}
- this._map
- .fire('move', e)
- .fire('drag', e);
- },
+ var options = this.options;
- _onZoomEnd: function () {
- var pxCenter = this._map.getSize().divideBy(2),
- pxWorldCenter = this._map.latLngToLayerPoint([0, 0]);
+ if (options.filter && !options.filter(geojson)) { return this; }
- this._initialWorldOffset = pxWorldCenter.subtract(pxCenter).x;
- this._worldWidth = this._map.getPixelWorldBounds().getSize().x;
- },
+ var layer = L.GeoJSON.geometryToLayer(geojson, options);
+ if (!layer) {
+ return this;
+ }
+ layer.feature = L.GeoJSON.asFeature(geojson);
- _viscousLimit: function (value, threshold) {
- return value - (value - threshold) * this._viscosity;
- },
+ layer.defaultOptions = layer.options;
+ this.resetStyle(layer);
- _onPreDragLimit: function () {
- if (!this._viscosity || !this._offsetLimit) { return; }
+ if (options.onEachFeature) {
+ options.onEachFeature(geojson, layer);
+ }
- var offset = this._draggable._newPos.subtract(this._draggable._startPos);
+ return this.addLayer(layer);
+ },
- var limit = this._offsetLimit;
- if (offset.x < limit.min.x) { offset.x = this._viscousLimit(offset.x, limit.min.x); }
- if (offset.y < limit.min.y) { offset.y = this._viscousLimit(offset.y, limit.min.y); }
- if (offset.x > limit.max.x) { offset.x = this._viscousLimit(offset.x, limit.max.x); }
- if (offset.y > limit.max.y) { offset.y = this._viscousLimit(offset.y, limit.max.y); }
+ // @method resetStyle( <Path> layer ): this
+ // Resets the given vector layer's style to the original GeoJSON style, useful for resetting style after hover events.
+ resetStyle: function (layer) {
+ // reset any custom styles
+ layer.options = L.Util.extend({}, layer.defaultOptions);
+ this._setLayerStyle(layer, this.options.style);
+ return this;
+ },
- this._draggable._newPos = this._draggable._startPos.add(offset);
+ // @method setStyle( <Function> style ): this
+ // Changes styles of GeoJSON vector layers with the given style function.
+ setStyle: function (style) {
+ return this.eachLayer(function (layer) {
+ this._setLayerStyle(layer, style);
+ }, this);
},
- _onPreDragWrap: function () {
- // TODO refactor to be able to adjust map pane position after zoom
- var worldWidth = this._worldWidth,
- halfWidth = Math.round(worldWidth / 2),
- dx = this._initialWorldOffset,
- x = this._draggable._newPos.x,
- newX1 = (x - halfWidth + dx) % worldWidth + halfWidth - dx,
- newX2 = (x + halfWidth + dx) % worldWidth - halfWidth - dx,
- newX = Math.abs(newX1 + dx) < Math.abs(newX2 + dx) ? newX1 : newX2;
+ _setLayerStyle: function (layer, style) {
+ if (typeof style === 'function') {
+ style = style(layer.feature);
+ }
+ if (layer.setStyle) {
+ layer.setStyle(style);
+ }
+ }
+});
+
+// @section
+// There are several static functions which can be called without instantiating L.GeoJSON:
+L.extend(L.GeoJSON, {
+ // @function geometryToLayer(featureData: Object, options?: GeoJSON options): Layer
+ // Creates a `Layer` from a given GeoJSON feature. Can use a custom
+ // [`pointToLayer`](#geojson-pointtolayer) and/or [`coordsToLatLng`](#geojson-coordstolatlng)
+ // functions if provided as options.
+ geometryToLayer: function (geojson, options) {
- this._draggable._absPos = this._draggable._newPos.clone();
- this._draggable._newPos.x = newX;
- },
+ var geometry = geojson.type === 'Feature' ? geojson.geometry : geojson,
+ coords = geometry ? geometry.coordinates : null,
+ layers = [],
+ pointToLayer = options && options.pointToLayer,
+ coordsToLatLng = options && options.coordsToLatLng || this.coordsToLatLng,
+ latlng, latlngs, i, len;
- _onDragEnd: function (e) {
- var map = this._map,
- options = map.options,
+ if (!coords && !geometry) {
+ return null;
+ }
- noInertia = !options.inertia || this._times.length < 2;
+ switch (geometry.type) {
+ case 'Point':
+ latlng = coordsToLatLng(coords);
+ return pointToLayer ? pointToLayer(geojson, latlng) : new L.Marker(latlng);
- map.fire('dragend', e);
+ case 'MultiPoint':
+ for (i = 0, len = coords.length; i < len; i++) {
+ latlng = coordsToLatLng(coords[i]);
+ layers.push(pointToLayer ? pointToLayer(geojson, latlng) : new L.Marker(latlng));
+ }
+ return new L.FeatureGroup(layers);
- if (noInertia) {
- map.fire('moveend');
+ case 'LineString':
+ case 'MultiLineString':
+ latlngs = this.coordsToLatLngs(coords, geometry.type === 'LineString' ? 0 : 1, coordsToLatLng);
+ return new L.Polyline(latlngs, options);
- } else {
+ case 'Polygon':
+ case 'MultiPolygon':
+ latlngs = this.coordsToLatLngs(coords, geometry.type === 'Polygon' ? 1 : 2, coordsToLatLng);
+ return new L.Polygon(latlngs, options);
- var direction = this._lastPos.subtract(this._positions[0]),
- duration = (this._lastTime - this._times[0]) / 1000,
- ease = options.easeLinearity,
+ case 'GeometryCollection':
+ for (i = 0, len = geometry.geometries.length; i < len; i++) {
+ var layer = this.geometryToLayer({
+ geometry: geometry.geometries[i],
+ type: 'Feature',
+ properties: geojson.properties
+ }, options);
- speedVector = direction.multiplyBy(ease / duration),
- speed = speedVector.distanceTo([0, 0]),
+ if (layer) {
+ layers.push(layer);
+ }
+ }
+ return new L.FeatureGroup(layers);
- limitedSpeed = Math.min(options.inertiaMaxSpeed, speed),
- limitedSpeedVector = speedVector.multiplyBy(limitedSpeed / speed),
+ default:
+ throw new Error('Invalid GeoJSON object.');
+ }
+ },
- decelerationDuration = limitedSpeed / (options.inertiaDeceleration * ease),
- offset = limitedSpeedVector.multiplyBy(-decelerationDuration / 2).round();
+ // @function coordsToLatLng(coords: Array): LatLng
+ // Creates a `LatLng` object from an array of 2 numbers (longitude, latitude)
+ // or 3 numbers (longitude, latitude, altitude) used in GeoJSON for points.
+ coordsToLatLng: function (coords) {
+ return new L.LatLng(coords[1], coords[0], coords[2]);
+ },
- if (!offset.x && !offset.y) {
- map.fire('moveend');
+ // @function coordsToLatLngs(coords: Array, levelsDeep?: Number, coordsToLatLng?: Function): Array
+ // Creates a multidimensional array of `LatLng`s from a GeoJSON coordinates array.
+ // `levelsDeep` specifies the nesting level (0 is for an array of points, 1 for an array of arrays of points, etc., 0 by default).
+ // Can use a custom [`coordsToLatLng`](#geojson-coordstolatlng) function.
+ coordsToLatLngs: function (coords, levelsDeep, coordsToLatLng) {
+ var latlngs = [];
- } else {
- offset = map._limitOffset(offset, map.options.maxBounds);
+ for (var i = 0, len = coords.length, latlng; i < len; i++) {
+ latlng = levelsDeep ?
+ this.coordsToLatLngs(coords[i], levelsDeep - 1, coordsToLatLng) :
+ (coordsToLatLng || this.coordsToLatLng)(coords[i]);
- L.Util.requestAnimFrame(function () {
- map.panBy(offset, {
- duration: decelerationDuration,
- easeLinearity: ease,
- noMoveStart: true,
- animate: true
- });
- });
- }
+ latlngs.push(latlng);
}
- }
-});
-
-// @section Handlers
-// @property dragging: Handler
-// Map dragging handler (by both mouse and touch).
-L.Map.addInitHook('addHandler', 'dragging', L.Map.Drag);
+ return latlngs;
+ },
+ // @function latLngToCoords(latlng: LatLng): Array
+ // Reverse of [`coordsToLatLng`](#geojson-coordstolatlng)
+ latLngToCoords: function (latlng) {
+ return latlng.alt !== undefined ?
+ [latlng.lng, latlng.lat, latlng.alt] :
+ [latlng.lng, latlng.lat];
+ },
-/*
- * L.Handler.DoubleClickZoom is used to handle double-click zoom on the map, enabled by default.
- */
+ // @function latLngsToCoords(latlngs: Array, levelsDeep?: Number, closed?: Boolean): Array
+ // Reverse of [`coordsToLatLngs`](#geojson-coordstolatlngs)
+ // `closed` determines whether the first point should be appended to the end of the array to close the feature, only used when `levelsDeep` is 0. False by default.
+ latLngsToCoords: function (latlngs, levelsDeep, closed) {
+ var coords = [];
-// @namespace Map
-// @section Interaction Options
+ for (var i = 0, len = latlngs.length; i < len; i++) {
+ coords.push(levelsDeep ?
+ L.GeoJSON.latLngsToCoords(latlngs[i], levelsDeep - 1, closed) :
+ L.GeoJSON.latLngToCoords(latlngs[i]));
+ }
-L.Map.mergeOptions({
- // @option doubleClickZoom: Boolean|String = true
- // Whether the map can be zoomed in by double clicking on it and
- // zoomed out by double clicking while holding shift. If passed
- // `'center'`, double-click zoom will zoom to the center of the
- // view regardless of where the mouse was.
- doubleClickZoom: true
-});
+ if (!levelsDeep && closed) {
+ coords.push(coords[0]);
+ }
-L.Map.DoubleClickZoom = L.Handler.extend({
- addHooks: function () {
- this._map.on('dblclick', this._onDoubleClick, this);
+ return coords;
},
- removeHooks: function () {
- this._map.off('dblclick', this._onDoubleClick, this);
+ getFeature: function (layer, newGeometry) {
+ return layer.feature ?
+ L.extend({}, layer.feature, {geometry: newGeometry}) :
+ L.GeoJSON.asFeature(newGeometry);
},
- _onDoubleClick: function (e) {
- var map = this._map,
- oldZoom = map.getZoom(),
- delta = map.options.zoomDelta,
- zoom = e.originalEvent.shiftKey ? oldZoom - delta : oldZoom + delta;
-
- if (map.options.doubleClickZoom === 'center') {
- map.setZoom(zoom);
- } else {
- map.setZoomAround(e.containerPoint, zoom);
+ // @function asFeature(geojson: Object): Object
+ // Normalize GeoJSON geometries/features into GeoJSON features.
+ asFeature: function (geojson) {
+ if (geojson.type === 'Feature' || geojson.type === 'FeatureCollection') {
+ return geojson;
}
+
+ return {
+ type: 'Feature',
+ properties: {},
+ geometry: geojson
+ };
}
});
-// @section Handlers
-//
-// Map properties include interaction handlers that allow you to control
-// interaction behavior in runtime, enabling or disabling certain features such
-// as dragging or touch zoom (see `Handler` methods). For example:
-//
-// ```js
-// map.doubleClickZoom.disable();
-// ```
-//
-// @property doubleClickZoom: Handler
-// Double click zoom handler.
-L.Map.addInitHook('addHandler', 'doubleClickZoom', L.Map.DoubleClickZoom);
-
-
+var PointToGeoJSON = {
+ toGeoJSON: function () {
+ return L.GeoJSON.getFeature(this, {
+ type: 'Point',
+ coordinates: L.GeoJSON.latLngToCoords(this.getLatLng())
+ });
+ }
+};
-/*
- * L.Handler.ScrollWheelZoom is used by L.Map to enable mouse scroll wheel zoom on the map.
- */
+// @namespace Marker
+// @method toGeoJSON(): Object
+// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the marker (as a GeoJSON `Point` Feature).
+L.Marker.include(PointToGeoJSON);
-// @namespace Map
-// @section Interaction Options
-L.Map.mergeOptions({
- // @section Mousewheel options
- // @option scrollWheelZoom: Boolean|String = true
- // Whether the map can be zoomed by using the mouse wheel. If passed `'center'`,
- // it will zoom to the center of the view regardless of where the mouse was.
- scrollWheelZoom: true,
+// @namespace CircleMarker
+// @method toGeoJSON(): Object
+// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the circle marker (as a GeoJSON `Point` Feature).
+L.Circle.include(PointToGeoJSON);
+L.CircleMarker.include(PointToGeoJSON);
- // @option wheelDebounceTime: Number = 40
- // Limits the rate at which a wheel can fire (in milliseconds). By default
- // user can't zoom via wheel more often than once per 40 ms.
- wheelDebounceTime: 40,
- // @option wheelPxPerZoomLevel: Number = 60
- // How many scroll pixels (as reported by [L.DomEvent.getWheelDelta](#domevent-getwheeldelta))
- // mean a change of one full zoom level. Smaller values will make wheel-zooming
- // faster (and vice versa).
- wheelPxPerZoomLevel: 60
-});
+// @namespace Polyline
+// @method toGeoJSON(): Object
+// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the polyline (as a GeoJSON `LineString` or `MultiLineString` Feature).
+L.Polyline.prototype.toGeoJSON = function () {
+ var multi = !L.Polyline._flat(this._latlngs);
-L.Map.ScrollWheelZoom = L.Handler.extend({
- addHooks: function () {
- L.DomEvent.on(this._map._container, 'mousewheel', this._onWheelScroll, this);
+ var coords = L.GeoJSON.latLngsToCoords(this._latlngs, multi ? 1 : 0);
- this._delta = 0;
- },
+ return L.GeoJSON.getFeature(this, {
+ type: (multi ? 'Multi' : '') + 'LineString',
+ coordinates: coords
+ });
+};
- removeHooks: function () {
- L.DomEvent.off(this._map._container, 'mousewheel', this._onWheelScroll, this);
- },
+// @namespace Polygon
+// @method toGeoJSON(): Object
+// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the polygon (as a GeoJSON `Polygon` or `MultiPolygon` Feature).
+L.Polygon.prototype.toGeoJSON = function () {
+ var holes = !L.Polyline._flat(this._latlngs),
+ multi = holes && !L.Polyline._flat(this._latlngs[0]);
- _onWheelScroll: function (e) {
- var delta = L.DomEvent.getWheelDelta(e);
+ var coords = L.GeoJSON.latLngsToCoords(this._latlngs, multi ? 2 : holes ? 1 : 0, true);
- var debounce = this._map.options.wheelDebounceTime;
+ if (!holes) {
+ coords = [coords];
+ }
- this._delta += delta;
- this._lastMousePos = this._map.mouseEventToContainerPoint(e);
+ return L.GeoJSON.getFeature(this, {
+ type: (multi ? 'Multi' : '') + 'Polygon',
+ coordinates: coords
+ });
+};
- if (!this._startTime) {
- this._startTime = +new Date();
- }
- var left = Math.max(debounce - (+new Date() - this._startTime), 0);
+// @namespace LayerGroup
+L.LayerGroup.include({
+ toMultiPoint: function () {
+ var coords = [];
- clearTimeout(this._timer);
- this._timer = setTimeout(L.bind(this._performZoom, this), left);
+ this.eachLayer(function (layer) {
+ coords.push(layer.toGeoJSON().geometry.coordinates);
+ });
- L.DomEvent.stop(e);
+ return L.GeoJSON.getFeature(this, {
+ type: 'MultiPoint',
+ coordinates: coords
+ });
},
- _performZoom: function () {
- var map = this._map,
- zoom = map.getZoom(),
- snap = this._map.options.zoomSnap || 0;
+ // @method toGeoJSON(): Object
+ // Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the layer group (as a GeoJSON `GeometryCollection`).
+ toGeoJSON: function () {
- map._stop(); // stop panning and fly animations if any
+ var type = this.feature && this.feature.geometry && this.feature.geometry.type;
- // map the delta with a sigmoid function to -4..4 range leaning on -1..1
- var d2 = this._delta / (this._map.options.wheelPxPerZoomLevel * 4),
- d3 = 4 * Math.log(2 / (1 + Math.exp(-Math.abs(d2)))) / Math.LN2,
- d4 = snap ? Math.ceil(d3 / snap) * snap : d3,
- delta = map._limitZoom(zoom + (this._delta > 0 ? d4 : -d4)) - zoom;
+ if (type === 'MultiPoint') {
+ return this.toMultiPoint();
+ }
- this._delta = 0;
- this._startTime = null;
+ var isGeometryCollection = type === 'GeometryCollection',
+ jsons = [];
- if (!delta) { return; }
+ this.eachLayer(function (layer) {
+ if (layer.toGeoJSON) {
+ var json = layer.toGeoJSON();
+ jsons.push(isGeometryCollection ? json.geometry : L.GeoJSON.asFeature(json));
+ }
+ });
- if (map.options.scrollWheelZoom === 'center') {
- map.setZoom(zoom + delta);
- } else {
- map.setZoomAround(this._lastMousePos, zoom + delta);
+ if (isGeometryCollection) {
+ return L.GeoJSON.getFeature(this, {
+ geometries: jsons,
+ type: 'GeometryCollection'
+ });
}
+
+ return {
+ type: 'FeatureCollection',
+ features: jsons
+ };
}
});
-// @section Handlers
-// @property scrollWheelZoom: Handler
-// Scroll wheel zoom handler.
-L.Map.addInitHook('addHandler', 'scrollWheelZoom', L.Map.ScrollWheelZoom);
+// @namespace GeoJSON
+// @factory L.geoJSON(geojson?: Object, options?: GeoJSON options)
+// Creates a GeoJSON layer. Optionally accepts an object in
+// [GeoJSON format](http://geojson.org/geojson-spec.html) to display on the map
+// (you can alternatively add it later with `addData` method) and an `options` object.
+L.geoJSON = function (geojson, options) {
+ return new L.GeoJSON(geojson, options);
+};
+// Backward compatibility.
+L.geoJson = L.geoJSON;
/*
- * Extends the event handling code with double tap support for mobile browsers.
+ * @class Draggable
+ * @aka L.Draggable
+ * @inherits Evented
+ *
+ * A class for making DOM elements draggable (including touch support).
+ * Used internally for map and marker dragging. Only works for elements
+ * that were positioned with [`L.DomUtil.setPosition`](#domutil-setposition).
+ *
+ * @example
+ * ```js
+ * var draggable = new L.Draggable(elementToDrag);
+ * draggable.enable();
+ * ```
*/
-L.extend(L.DomEvent, {
+L.Draggable = L.Evented.extend({
- _touchstart: L.Browser.msPointer ? 'MSPointerDown' : L.Browser.pointer ? 'pointerdown' : 'touchstart',
- _touchend: L.Browser.msPointer ? 'MSPointerUp' : L.Browser.pointer ? 'pointerup' : 'touchend',
+ options: {
+ // @option clickTolerance: Number = 3
+ // The max number of pixels a user can shift the mouse pointer during a click
+ // for it to be considered a valid click (as opposed to a mouse drag).
+ clickTolerance: 3
+ },
- // inspired by Zepto touch code by Thomas Fuchs
- addDoubleTapListener: function (obj, handler, id) {
- var last, touch,
- doubleTap = false,
- delay = 250;
+ statics: {
+ START: L.Browser.touch ? ['touchstart', 'mousedown'] : ['mousedown'],
+ END: {
+ mousedown: 'mouseup',
+ touchstart: 'touchend',
+ pointerdown: 'touchend',
+ MSPointerDown: 'touchend'
+ },
+ MOVE: {
+ mousedown: 'mousemove',
+ touchstart: 'touchmove',
+ pointerdown: 'touchmove',
+ MSPointerDown: 'touchmove'
+ }
+ },
- function onTouchStart(e) {
- var count;
+ // @constructor L.Draggable(el: HTMLElement, dragHandle?: HTMLElement, preventOutline: Boolean)
+ // Creates a `Draggable` object for moving `el` when you start dragging the `dragHandle` element (equals `el` itself by default).
+ initialize: function (element, dragStartTarget, preventOutline) {
+ this._element = element;
+ this._dragStartTarget = dragStartTarget || element;
+ this._preventOutline = preventOutline;
+ },
- if (L.Browser.pointer) {
- count = L.DomEvent._pointersCount;
- } else {
- count = e.touches.length;
- }
+ // @method enable()
+ // Enables the dragging ability
+ enable: function () {
+ if (this._enabled) { return; }
- if (count > 1) { return; }
+ L.DomEvent.on(this._dragStartTarget, L.Draggable.START.join(' '), this._onDown, this);
- var now = Date.now(),
- delta = now - (last || now);
+ this._enabled = true;
+ },
- touch = e.touches ? e.touches[0] : e;
- doubleTap = (delta > 0 && delta <= delay);
- last = now;
+ // @method disable()
+ // Disables the dragging ability
+ disable: function () {
+ if (!this._enabled) { return; }
+
+ // If we're currently dragging this draggable,
+ // disabling it counts as first ending the drag.
+ if (L.Draggable._dragging === this) {
+ this.finishDrag();
}
- function onTouchEnd() {
- if (doubleTap && !touch.cancelBubble) {
- if (L.Browser.pointer) {
- // work around .type being readonly with MSPointer* events
- var newTouch = {},
- prop, i;
+ L.DomEvent.off(this._dragStartTarget, L.Draggable.START.join(' '), this._onDown, this);
- for (i in touch) {
- prop = touch[i];
- newTouch[i] = prop && prop.bind ? prop.bind(touch) : prop;
- }
- touch = newTouch;
- }
- touch.type = 'dblclick';
- handler(touch);
- last = null;
- }
- }
+ this._enabled = false;
+ this._moved = false;
+ },
- var pre = '_leaflet_',
- touchstart = this._touchstart,
- touchend = this._touchend;
+ _onDown: function (e) {
+ // Ignore simulated events, since we handle both touch and
+ // mouse explicitly; otherwise we risk getting duplicates of
+ // touch events, see #4315.
+ // Also ignore the event if disabled; this happens in IE11
+ // under some circumstances, see #3666.
+ if (e._simulated || !this._enabled) { return; }
- obj[pre + touchstart + id] = onTouchStart;
- obj[pre + touchend + id] = onTouchEnd;
- obj[pre + 'dblclick' + id] = handler;
+ this._moved = false;
- obj.addEventListener(touchstart, onTouchStart, false);
- obj.addEventListener(touchend, onTouchEnd, false);
+ if (L.DomUtil.hasClass(this._element, 'leaflet-zoom-anim')) { return; }
- // On some platforms (notably, chrome on win10 + touchscreen + mouse),
- // the browser doesn't fire touchend/pointerup events but does fire
- // native dblclicks. See #4127.
- if (!L.Browser.edge) {
- obj.addEventListener('dblclick', handler, false);
+ if (L.Draggable._dragging || e.shiftKey || ((e.which !== 1) && (e.button !== 1) && !e.touches)) { return; }
+ L.Draggable._dragging = this; // Prevent dragging multiple objects at once.
+
+ if (this._preventOutline) {
+ L.DomUtil.preventOutline(this._element);
}
- return this;
- },
+ L.DomUtil.disableImageDrag();
+ L.DomUtil.disableTextSelection();
- removeDoubleTapListener: function (obj, id) {
- var pre = '_leaflet_',
- touchstart = obj[pre + this._touchstart + id],
- touchend = obj[pre + this._touchend + id],
- dblclick = obj[pre + 'dblclick' + id];
+ if (this._moving) { return; }
- obj.removeEventListener(this._touchstart, touchstart, false);
- obj.removeEventListener(this._touchend, touchend, false);
- if (!L.Browser.edge) {
- obj.removeEventListener('dblclick', dblclick, false);
- }
+ // @event down: Event
+ // Fired when a drag is about to start.
+ this.fire('down');
- return this;
- }
-});
+ var first = e.touches ? e.touches[0] : e;
+
+ this._startPoint = new L.Point(first.clientX, first.clientY);
+
+ L.DomEvent
+ .on(document, L.Draggable.MOVE[e.type], this._onMove, this)
+ .on(document, L.Draggable.END[e.type], this._onUp, this);
+ },
+ _onMove: function (e) {
+ // Ignore simulated events, since we handle both touch and
+ // mouse explicitly; otherwise we risk getting duplicates of
+ // touch events, see #4315.
+ // Also ignore the event if disabled; this happens in IE11
+ // under some circumstances, see #3666.
+ if (e._simulated || !this._enabled) { return; }
+ if (e.touches && e.touches.length > 1) {
+ this._moved = true;
+ return;
+ }
-/*
- * Extends L.DomEvent to provide touch support for Internet Explorer and Windows-based devices.
- */
+ var first = (e.touches && e.touches.length === 1 ? e.touches[0] : e),
+ newPoint = new L.Point(first.clientX, first.clientY),
+ offset = newPoint.subtract(this._startPoint);
-L.extend(L.DomEvent, {
+ if (!offset.x && !offset.y) { return; }
+ if (Math.abs(offset.x) + Math.abs(offset.y) < this.options.clickTolerance) { return; }
- POINTER_DOWN: L.Browser.msPointer ? 'MSPointerDown' : 'pointerdown',
- POINTER_MOVE: L.Browser.msPointer ? 'MSPointerMove' : 'pointermove',
- POINTER_UP: L.Browser.msPointer ? 'MSPointerUp' : 'pointerup',
- POINTER_CANCEL: L.Browser.msPointer ? 'MSPointerCancel' : 'pointercancel',
- TAG_WHITE_LIST: ['INPUT', 'SELECT', 'OPTION'],
+ L.DomEvent.preventDefault(e);
+
+ if (!this._moved) {
+ // @event dragstart: Event
+ // Fired when a drag starts
+ this.fire('dragstart');
- _pointers: {},
- _pointersCount: 0,
+ this._moved = true;
+ this._startPos = L.DomUtil.getPosition(this._element).subtract(offset);
- // Provides a touch events wrapper for (ms)pointer events.
- // ref http://www.w3.org/TR/pointerevents/ https://www.w3.org/Bugs/Public/show_bug.cgi?id=22890
+ L.DomUtil.addClass(document.body, 'leaflet-dragging');
- addPointerListener: function (obj, type, handler, id) {
+ this._lastTarget = e.target || e.srcElement;
+ // IE and Edge do not give the <use> element, so fetch it
+ // if necessary
+ if ((window.SVGElementInstance) && (this._lastTarget instanceof SVGElementInstance)) {
+ this._lastTarget = this._lastTarget.correspondingUseElement;
+ }
+ L.DomUtil.addClass(this._lastTarget, 'leaflet-drag-target');
+ }
- if (type === 'touchstart') {
- this._addPointerStart(obj, handler, id);
+ this._newPos = this._startPos.add(offset);
+ this._moving = true;
- } else if (type === 'touchmove') {
- this._addPointerMove(obj, handler, id);
+ L.Util.cancelAnimFrame(this._animRequest);
+ this._lastEvent = e;
+ this._animRequest = L.Util.requestAnimFrame(this._updatePosition, this, true);
+ },
- } else if (type === 'touchend') {
- this._addPointerEnd(obj, handler, id);
- }
+ _updatePosition: function () {
+ var e = {originalEvent: this._lastEvent};
- return this;
+ // @event predrag: Event
+ // Fired continuously during dragging *before* each corresponding
+ // update of the element's position.
+ this.fire('predrag', e);
+ L.DomUtil.setPosition(this._element, this._newPos);
+
+ // @event drag: Event
+ // Fired continuously during dragging.
+ this.fire('drag', e);
},
- removePointerListener: function (obj, type, id) {
- var handler = obj['_leaflet_' + type + id];
+ _onUp: function (e) {
+ // Ignore simulated events, since we handle both touch and
+ // mouse explicitly; otherwise we risk getting duplicates of
+ // touch events, see #4315.
+ // Also ignore the event if disabled; this happens in IE11
+ // under some circumstances, see #3666.
+ if (e._simulated || !this._enabled) { return; }
+ this.finishDrag();
+ },
- if (type === 'touchstart') {
- obj.removeEventListener(this.POINTER_DOWN, handler, false);
+ finishDrag: function () {
+ L.DomUtil.removeClass(document.body, 'leaflet-dragging');
- } else if (type === 'touchmove') {
- obj.removeEventListener(this.POINTER_MOVE, handler, false);
+ if (this._lastTarget) {
+ L.DomUtil.removeClass(this._lastTarget, 'leaflet-drag-target');
+ this._lastTarget = null;
+ }
- } else if (type === 'touchend') {
- obj.removeEventListener(this.POINTER_UP, handler, false);
- obj.removeEventListener(this.POINTER_CANCEL, handler, false);
+ for (var i in L.Draggable.MOVE) {
+ L.DomEvent
+ .off(document, L.Draggable.MOVE[i], this._onMove, this)
+ .off(document, L.Draggable.END[i], this._onUp, this);
}
- return this;
- },
+ L.DomUtil.enableImageDrag();
+ L.DomUtil.enableTextSelection();
- _addPointerStart: function (obj, handler, id) {
- var onDown = L.bind(function (e) {
- if (e.pointerType !== 'mouse' && e.pointerType !== e.MSPOINTER_TYPE_MOUSE) {
- // In IE11, some touch events needs to fire for form controls, or
- // the controls will stop working. We keep a whitelist of tag names that
- // need these events. For other target tags, we prevent default on the event.
- if (this.TAG_WHITE_LIST.indexOf(e.target.tagName) < 0) {
- L.DomEvent.preventDefault(e);
- } else {
- return;
- }
- }
+ if (this._moved && this._moving) {
+ // ensure drag is not fired after dragend
+ L.Util.cancelAnimFrame(this._animRequest);
- this._handlePointer(e, handler);
- }, this);
+ // @event dragend: DragEndEvent
+ // Fired when the drag ends.
+ this.fire('dragend', {
+ distance: this._newPos.distanceTo(this._startPos)
+ });
+ }
- obj['_leaflet_touchstart' + id] = onDown;
- obj.addEventListener(this.POINTER_DOWN, onDown, false);
+ this._moving = false;
+ L.Draggable._dragging = false;
+ }
- // need to keep track of what pointers and how many are active to provide e.touches emulation
- if (!this._pointerDocListener) {
- var pointerUp = L.bind(this._globalPointerUp, this);
+});
- // we listen documentElement as any drags that end by moving the touch off the screen get fired there
- document.documentElement.addEventListener(this.POINTER_DOWN, L.bind(this._globalPointerDown, this), true);
- document.documentElement.addEventListener(this.POINTER_MOVE, L.bind(this._globalPointerMove, this), true);
- document.documentElement.addEventListener(this.POINTER_UP, pointerUp, true);
- document.documentElement.addEventListener(this.POINTER_CANCEL, pointerUp, true);
- this._pointerDocListener = true;
- }
- },
- _globalPointerDown: function (e) {
- this._pointers[e.pointerId] = e;
- this._pointersCount++;
- },
+/*
+ L.Handler is a base class for handler classes that are used internally to inject
+ interaction features like dragging to classes like Map and Marker.
+*/
- _globalPointerMove: function (e) {
- if (this._pointers[e.pointerId]) {
- this._pointers[e.pointerId] = e;
- }
- },
+// @class Handler
+// @aka L.Handler
+// Abstract class for map interaction handlers
- _globalPointerUp: function (e) {
- delete this._pointers[e.pointerId];
- this._pointersCount--;
+L.Handler = L.Class.extend({
+ initialize: function (map) {
+ this._map = map;
},
- _handlePointer: function (e, handler) {
- e.touches = [];
- for (var i in this._pointers) {
- e.touches.push(this._pointers[i]);
- }
- e.changedTouches = [e];
+ // @method enable(): this
+ // Enables the handler
+ enable: function () {
+ if (this._enabled) { return this; }
- handler(e);
+ this._enabled = true;
+ this.addHooks();
+ return this;
},
- _addPointerMove: function (obj, handler, id) {
- var onMove = L.bind(function (e) {
- // don't fire touch moves when mouse isn't down
- if ((e.pointerType === e.MSPOINTER_TYPE_MOUSE || e.pointerType === 'mouse') && e.buttons === 0) { return; }
-
- this._handlePointer(e, handler);
- }, this);
+ // @method disable(): this
+ // Disables the handler
+ disable: function () {
+ if (!this._enabled) { return this; }
- obj['_leaflet_touchmove' + id] = onMove;
- obj.addEventListener(this.POINTER_MOVE, onMove, false);
+ this._enabled = false;
+ this.removeHooks();
+ return this;
},
- _addPointerEnd: function (obj, handler, id) {
- var onUp = L.bind(function (e) {
- this._handlePointer(e, handler);
- }, this);
-
- obj['_leaflet_touchend' + id] = onUp;
- obj.addEventListener(this.POINTER_UP, onUp, false);
- obj.addEventListener(this.POINTER_CANCEL, onUp, false);
+ // @method enabled(): Boolean
+ // Returns `true` if the handler is enabled
+ enabled: function () {
+ return !!this._enabled;
}
+
+ // @section Extension methods
+ // Classes inheriting from `Handler` must implement the two following methods:
+ // @method addHooks()
+ // Called when the handler is enabled, should add event hooks.
+ // @method removeHooks()
+ // Called when the handler is disabled, should remove the event hooks added previously.
});
/*
- * L.Handler.TouchZoom is used by L.Map to add pinch zoom on supported mobile browsers.
+ * L.Handler.MapDrag is used to make the map draggable (with panning inertia), enabled by default.
*/
// @namespace Map
// @section Interaction Options
L.Map.mergeOptions({
- // @section Touch interaction options
- // @option touchZoom: Boolean|String = *
- // Whether the map can be zoomed by touch-dragging with two fingers. If
- // passed `'center'`, it will zoom to the center of the view regardless of
- // where the touch events (fingers) were. Enabled for touch-capable web
- // browsers except for old Androids.
- touchZoom: L.Browser.touch && !L.Browser.android23,
+ // @option dragging: Boolean = true
+ // Whether the map be draggable with mouse/touch or not.
+ dragging: true,
- // @option bounceAtZoomLimits: Boolean = true
- // Set it to false if you don't want the map to zoom beyond min/max zoom
- // and then bounce back when pinch-zooming.
- bounceAtZoomLimits: true
-});
+ // @section Panning Inertia Options
+ // @option inertia: Boolean = *
+ // If enabled, panning of the map will have an inertia effect where
+ // the map builds momentum while dragging and continues moving in
+ // the same direction for some time. Feels especially nice on touch
+ // devices. Enabled by default unless running on old Android devices.
+ inertia: !L.Browser.android23,
-L.Map.TouchZoom = L.Handler.extend({
- addHooks: function () {
- L.DomUtil.addClass(this._map._container, 'leaflet-touch-zoom');
- L.DomEvent.on(this._map._container, 'touchstart', this._onTouchStart, this);
- },
+ // @option inertiaDeceleration: Number = 3000
+ // The rate with which the inertial movement slows down, in pixels/second².
+ inertiaDeceleration: 3400, // px/s^2
- removeHooks: function () {
- L.DomUtil.removeClass(this._map._container, 'leaflet-touch-zoom');
- L.DomEvent.off(this._map._container, 'touchstart', this._onTouchStart, this);
- },
+ // @option inertiaMaxSpeed: Number = Infinity
+ // Max speed of the inertial movement, in pixels/second.
+ inertiaMaxSpeed: Infinity, // px/s
- _onTouchStart: function (e) {
- var map = this._map;
- if (!e.touches || e.touches.length !== 2 || map._animatingZoom || this._zooming) { return; }
+ // @option easeLinearity: Number = 0.2
+ easeLinearity: 0.2,
- var p1 = map.mouseEventToContainerPoint(e.touches[0]),
- p2 = map.mouseEventToContainerPoint(e.touches[1]);
+ // TODO refactor, move to CRS
+ // @option worldCopyJump: Boolean = false
+ // With this option enabled, the map tracks when you pan to another "copy"
+ // of the world and seamlessly jumps to the original one so that all overlays
+ // like markers and vector layers are still visible.
+ worldCopyJump: false,
- this._centerPoint = map.getSize()._divideBy(2);
- this._startLatLng = map.containerPointToLatLng(this._centerPoint);
- if (map.options.touchZoom !== 'center') {
- this._pinchStartLatLng = map.containerPointToLatLng(p1.add(p2)._divideBy(2));
- }
+ // @option maxBoundsViscosity: Number = 0.0
+ // If `maxBounds` is set, this option will control how solid the bounds
+ // are when dragging the map around. The default value of `0.0` allows the
+ // user to drag outside the bounds at normal speed, higher values will
+ // slow down map dragging outside bounds, and `1.0` makes the bounds fully
+ // solid, preventing the user from dragging outside the bounds.
+ maxBoundsViscosity: 0.0
+});
+
+L.Map.Drag = L.Handler.extend({
+ addHooks: function () {
+ if (!this._draggable) {
+ var map = this._map;
+
+ this._draggable = new L.Draggable(map._mapPane, map._container);
- this._startDist = p1.distanceTo(p2);
- this._startZoom = map.getZoom();
+ this._draggable.on({
+ down: this._onDown,
+ dragstart: this._onDragStart,
+ drag: this._onDrag,
+ dragend: this._onDragEnd
+ }, this);
- this._moved = false;
- this._zooming = true;
+ this._draggable.on('predrag', this._onPreDragLimit, this);
+ if (map.options.worldCopyJump) {
+ this._draggable.on('predrag', this._onPreDragWrap, this);
+ map.on('zoomend', this._onZoomEnd, this);
- map._stop();
+ map.whenReady(this._onZoomEnd, this);
+ }
+ }
+ L.DomUtil.addClass(this._map._container, 'leaflet-grab leaflet-touch-drag');
+ this._draggable.enable();
+ this._positions = [];
+ this._times = [];
+ },
- L.DomEvent
- .on(document, 'touchmove', this._onTouchMove, this)
- .on(document, 'touchend', this._onTouchEnd, this);
+ removeHooks: function () {
+ L.DomUtil.removeClass(this._map._container, 'leaflet-grab');
+ L.DomUtil.removeClass(this._map._container, 'leaflet-touch-drag');
+ this._draggable.disable();
+ },
- L.DomEvent.preventDefault(e);
+ moved: function () {
+ return this._draggable && this._draggable._moved;
},
- _onTouchMove: function (e) {
- if (!e.touches || e.touches.length !== 2 || !this._zooming) { return; }
+ moving: function () {
+ return this._draggable && this._draggable._moving;
+ },
- var map = this._map,
- p1 = map.mouseEventToContainerPoint(e.touches[0]),
- p2 = map.mouseEventToContainerPoint(e.touches[1]),
- scale = p1.distanceTo(p2) / this._startDist;
+ _onDown: function () {
+ this._map._stop();
+ },
+ _onDragStart: function () {
+ var map = this._map;
- this._zoom = map.getScaleZoom(scale, this._startZoom);
+ if (this._map.options.maxBounds && this._map.options.maxBoundsViscosity) {
+ var bounds = L.latLngBounds(this._map.options.maxBounds);
- if (!map.options.bounceAtZoomLimits && (
- (this._zoom < map.getMinZoom() && scale < 1) ||
- (this._zoom > map.getMaxZoom() && scale > 1))) {
- this._zoom = map._limitZoom(this._zoom);
- }
+ this._offsetLimit = L.bounds(
+ this._map.latLngToContainerPoint(bounds.getNorthWest()).multiplyBy(-1),
+ this._map.latLngToContainerPoint(bounds.getSouthEast()).multiplyBy(-1)
+ .add(this._map.getSize()));
- if (map.options.touchZoom === 'center') {
- this._center = this._startLatLng;
- if (scale === 1) { return; }
+ this._viscosity = Math.min(1.0, Math.max(0.0, this._map.options.maxBoundsViscosity));
} else {
- // Get delta from pinch to center, so centerLatLng is delta applied to initial pinchLatLng
- var delta = p1._add(p2)._divideBy(2)._subtract(this._centerPoint);
- if (scale === 1 && delta.x === 0 && delta.y === 0) { return; }
- this._center = map.unproject(map.project(this._pinchStartLatLng, this._zoom).subtract(delta), this._zoom);
+ this._offsetLimit = null;
}
- if (!this._moved) {
- map._moveStart(true);
- this._moved = true;
- }
+ map
+ .fire('movestart')
+ .fire('dragstart');
- L.Util.cancelAnimFrame(this._animRequest);
+ if (map.options.inertia) {
+ this._positions = [];
+ this._times = [];
+ }
+ },
- var moveFn = L.bind(map._move, map, this._center, this._zoom, {pinch: true, round: false});
- this._animRequest = L.Util.requestAnimFrame(moveFn, this, true);
+ _onDrag: function (e) {
+ if (this._map.options.inertia) {
+ var time = this._lastTime = +new Date(),
+ pos = this._lastPos = this._draggable._absPos || this._draggable._newPos;
- L.DomEvent.preventDefault(e);
- },
+ this._positions.push(pos);
+ this._times.push(time);
- _onTouchEnd: function () {
- if (!this._moved || !this._zooming) {
- this._zooming = false;
- return;
+ if (time - this._times[0] > 50) {
+ this._positions.shift();
+ this._times.shift();
+ }
}
- this._zooming = false;
- L.Util.cancelAnimFrame(this._animRequest);
+ this._map
+ .fire('move', e)
+ .fire('drag', e);
+ },
- L.DomEvent
- .off(document, 'touchmove', this._onTouchMove)
- .off(document, 'touchend', this._onTouchEnd);
+ _onZoomEnd: function () {
+ var pxCenter = this._map.getSize().divideBy(2),
+ pxWorldCenter = this._map.latLngToLayerPoint([0, 0]);
- // Pinch updates GridLayers' levels only when zoomSnap is off, so zoomSnap becomes noUpdate.
- if (this._map.options.zoomAnimation) {
- this._map._animateZoom(this._center, this._map._limitZoom(this._zoom), true, this._map.options.zoomSnap);
- } else {
- this._map._resetView(this._center, this._map._limitZoom(this._zoom));
- }
- }
-});
+ this._initialWorldOffset = pxWorldCenter.subtract(pxCenter).x;
+ this._worldWidth = this._map.getPixelWorldBounds().getSize().x;
+ },
-// @section Handlers
-// @property touchZoom: Handler
-// Touch zoom handler.
-L.Map.addInitHook('addHandler', 'touchZoom', L.Map.TouchZoom);
+ _viscousLimit: function (value, threshold) {
+ return value - (value - threshold) * this._viscosity;
+ },
+ _onPreDragLimit: function () {
+ if (!this._viscosity || !this._offsetLimit) { return; }
+ var offset = this._draggable._newPos.subtract(this._draggable._startPos);
-/*
- * L.Map.Tap is used to enable mobile hacks like quick taps and long hold.
- */
+ var limit = this._offsetLimit;
+ if (offset.x < limit.min.x) { offset.x = this._viscousLimit(offset.x, limit.min.x); }
+ if (offset.y < limit.min.y) { offset.y = this._viscousLimit(offset.y, limit.min.y); }
+ if (offset.x > limit.max.x) { offset.x = this._viscousLimit(offset.x, limit.max.x); }
+ if (offset.y > limit.max.y) { offset.y = this._viscousLimit(offset.y, limit.max.y); }
-// @namespace Map
-// @section Interaction Options
-L.Map.mergeOptions({
- // @section Touch interaction options
- // @option tap: Boolean = true
- // Enables mobile hacks for supporting instant taps (fixing 200ms click
- // delay on iOS/Android) and touch holds (fired as `contextmenu` events).
- tap: true,
+ this._draggable._newPos = this._draggable._startPos.add(offset);
+ },
- // @option tapTolerance: Number = 15
- // The max number of pixels a user can shift his finger during touch
- // for it to be considered a valid tap.
- tapTolerance: 15
-});
+ _onPreDragWrap: function () {
+ // TODO refactor to be able to adjust map pane position after zoom
+ var worldWidth = this._worldWidth,
+ halfWidth = Math.round(worldWidth / 2),
+ dx = this._initialWorldOffset,
+ x = this._draggable._newPos.x,
+ newX1 = (x - halfWidth + dx) % worldWidth + halfWidth - dx,
+ newX2 = (x + halfWidth + dx) % worldWidth - halfWidth - dx,
+ newX = Math.abs(newX1 + dx) < Math.abs(newX2 + dx) ? newX1 : newX2;
-L.Map.Tap = L.Handler.extend({
- addHooks: function () {
- L.DomEvent.on(this._map._container, 'touchstart', this._onDown, this);
+ this._draggable._absPos = this._draggable._newPos.clone();
+ this._draggable._newPos.x = newX;
},
- removeHooks: function () {
- L.DomEvent.off(this._map._container, 'touchstart', this._onDown, this);
- },
+ _onDragEnd: function (e) {
+ var map = this._map,
+ options = map.options,
- _onDown: function (e) {
- if (!e.touches) { return; }
+ noInertia = !options.inertia || this._times.length < 2;
- L.DomEvent.preventDefault(e);
+ map.fire('dragend', e);
- this._fireClick = true;
+ if (noInertia) {
+ map.fire('moveend');
- // don't simulate click or track longpress if more than 1 touch
- if (e.touches.length > 1) {
- this._fireClick = false;
- clearTimeout(this._holdTimeout);
- return;
- }
+ } else {
- var first = e.touches[0],
- el = first.target;
+ var direction = this._lastPos.subtract(this._positions[0]),
+ duration = (this._lastTime - this._times[0]) / 1000,
+ ease = options.easeLinearity,
- this._startPos = this._newPos = new L.Point(first.clientX, first.clientY);
+ speedVector = direction.multiplyBy(ease / duration),
+ speed = speedVector.distanceTo([0, 0]),
- // if touching a link, highlight it
- if (el.tagName && el.tagName.toLowerCase() === 'a') {
- L.DomUtil.addClass(el, 'leaflet-active');
- }
+ limitedSpeed = Math.min(options.inertiaMaxSpeed, speed),
+ limitedSpeedVector = speedVector.multiplyBy(limitedSpeed / speed),
- // simulate long hold but setting a timeout
- this._holdTimeout = setTimeout(L.bind(function () {
- if (this._isTapValid()) {
- this._fireClick = false;
- this._onUp();
- this._simulateEvent('contextmenu', first);
- }
- }, this), 1000);
+ decelerationDuration = limitedSpeed / (options.inertiaDeceleration * ease),
+ offset = limitedSpeedVector.multiplyBy(-decelerationDuration / 2).round();
- this._simulateEvent('mousedown', first);
+ if (!offset.x && !offset.y) {
+ map.fire('moveend');
- L.DomEvent.on(document, {
- touchmove: this._onMove,
- touchend: this._onUp
- }, this);
- },
+ } else {
+ offset = map._limitOffset(offset, map.options.maxBounds);
- _onUp: function (e) {
- clearTimeout(this._holdTimeout);
+ L.Util.requestAnimFrame(function () {
+ map.panBy(offset, {
+ duration: decelerationDuration,
+ easeLinearity: ease,
+ noMoveStart: true,
+ animate: true
+ });
+ });
+ }
+ }
+ }
+});
- L.DomEvent.off(document, {
- touchmove: this._onMove,
- touchend: this._onUp
- }, this);
+// @section Handlers
+// @property dragging: Handler
+// Map dragging handler (by both mouse and touch).
+L.Map.addInitHook('addHandler', 'dragging', L.Map.Drag);
- if (this._fireClick && e && e.changedTouches) {
- var first = e.changedTouches[0],
- el = first.target;
- if (el && el.tagName && el.tagName.toLowerCase() === 'a') {
- L.DomUtil.removeClass(el, 'leaflet-active');
- }
+/*
+ * L.Handler.DoubleClickZoom is used to handle double-click zoom on the map, enabled by default.
+ */
- this._simulateEvent('mouseup', first);
+// @namespace Map
+// @section Interaction Options
- // simulate click if the touch didn't move too much
- if (this._isTapValid()) {
- this._simulateEvent('click', first);
- }
- }
- },
+L.Map.mergeOptions({
+ // @option doubleClickZoom: Boolean|String = true
+ // Whether the map can be zoomed in by double clicking on it and
+ // zoomed out by double clicking while holding shift. If passed
+ // `'center'`, double-click zoom will zoom to the center of the
+ // view regardless of where the mouse was.
+ doubleClickZoom: true
+});
- _isTapValid: function () {
- return this._newPos.distanceTo(this._startPos) <= this._map.options.tapTolerance;
+L.Map.DoubleClickZoom = L.Handler.extend({
+ addHooks: function () {
+ this._map.on('dblclick', this._onDoubleClick, this);
},
- _onMove: function (e) {
- var first = e.touches[0];
- this._newPos = new L.Point(first.clientX, first.clientY);
- this._simulateEvent('mousemove', first);
+ removeHooks: function () {
+ this._map.off('dblclick', this._onDoubleClick, this);
},
- _simulateEvent: function (type, e) {
- var simulatedEvent = document.createEvent('MouseEvents');
-
- simulatedEvent._simulated = true;
- e.target._simulatedClick = true;
-
- simulatedEvent.initMouseEvent(
- type, true, true, window, 1,
- e.screenX, e.screenY,
- e.clientX, e.clientY,
- false, false, false, false, 0, null);
+ _onDoubleClick: function (e) {
+ var map = this._map,
+ oldZoom = map.getZoom(),
+ delta = map.options.zoomDelta,
+ zoom = e.originalEvent.shiftKey ? oldZoom - delta : oldZoom + delta;
- e.target.dispatchEvent(simulatedEvent);
+ if (map.options.doubleClickZoom === 'center') {
+ map.setZoom(zoom);
+ } else {
+ map.setZoomAround(e.containerPoint, zoom);
+ }
}
});
// @section Handlers
-// @property tap: Handler
-// Mobile touch hacks (quick tap and touch hold) handler.
-if (L.Browser.touch && !L.Browser.pointer) {
- L.Map.addInitHook('addHandler', 'tap', L.Map.Tap);
-}
+//
+// Map properties include interaction handlers that allow you to control
+// interaction behavior in runtime, enabling or disabling certain features such
+// as dragging or touch zoom (see `Handler` methods). For example:
+//
+// ```js
+// map.doubleClickZoom.disable();
+// ```
+//
+// @property doubleClickZoom: Handler
+// Double click zoom handler.
+L.Map.addInitHook('addHandler', 'doubleClickZoom', L.Map.DoubleClickZoom);
/*
- * L.Handler.BoxZoom is used to add shift-drag zoom interaction to the map
- * (zoom to a selected bounding box), enabled by default.
+ * L.Handler.ScrollWheelZoom is used by L.Map to enable mouse scroll wheel zoom on the map.
*/
// @namespace Map
// @section Interaction Options
L.Map.mergeOptions({
- // @option boxZoom: Boolean = true
- // Whether the map can be zoomed to a rectangular area specified by
- // dragging the mouse while pressing the shift key.
- boxZoom: true
-});
+ // @section Mousewheel options
+ // @option scrollWheelZoom: Boolean|String = true
+ // Whether the map can be zoomed by using the mouse wheel. If passed `'center'`,
+ // it will zoom to the center of the view regardless of where the mouse was.
+ scrollWheelZoom: true,
-L.Map.BoxZoom = L.Handler.extend({
- initialize: function (map) {
- this._map = map;
- this._container = map._container;
- this._pane = map._panes.overlayPane;
- },
+ // @option wheelDebounceTime: Number = 40
+ // Limits the rate at which a wheel can fire (in milliseconds). By default
+ // user can't zoom via wheel more often than once per 40 ms.
+ wheelDebounceTime: 40,
+
+ // @option wheelPxPerZoomLevel: Number = 60
+ // How many scroll pixels (as reported by [L.DomEvent.getWheelDelta](#domevent-getwheeldelta))
+ // mean a change of one full zoom level. Smaller values will make wheel-zooming
+ // faster (and vice versa).
+ wheelPxPerZoomLevel: 60
+});
+L.Map.ScrollWheelZoom = L.Handler.extend({
addHooks: function () {
- L.DomEvent.on(this._container, 'mousedown', this._onMouseDown, this);
+ L.DomEvent.on(this._map._container, 'mousewheel', this._onWheelScroll, this);
+
+ this._delta = 0;
},
removeHooks: function () {
- L.DomEvent.off(this._container, 'mousedown', this._onMouseDown, this);
+ L.DomEvent.off(this._map._container, 'mousewheel', this._onWheelScroll, this);
},
- moved: function () {
- return this._moved;
- },
+ _onWheelScroll: function (e) {
+ var delta = L.DomEvent.getWheelDelta(e);
- _resetState: function () {
- this._moved = false;
- },
+ var debounce = this._map.options.wheelDebounceTime;
- _onMouseDown: function (e) {
- if (!e.shiftKey || ((e.which !== 1) && (e.button !== 1))) { return false; }
+ this._delta += delta;
+ this._lastMousePos = this._map.mouseEventToContainerPoint(e);
- this._resetState();
+ if (!this._startTime) {
+ this._startTime = +new Date();
+ }
- L.DomUtil.disableTextSelection();
- L.DomUtil.disableImageDrag();
+ var left = Math.max(debounce - (+new Date() - this._startTime), 0);
- this._startPoint = this._map.mouseEventToContainerPoint(e);
+ clearTimeout(this._timer);
+ this._timer = setTimeout(L.bind(this._performZoom, this), left);
- L.DomEvent.on(document, {
- contextmenu: L.DomEvent.stop,
- mousemove: this._onMouseMove,
- mouseup: this._onMouseUp,
- keydown: this._onKeyDown
- }, this);
+ L.DomEvent.stop(e);
},
- _onMouseMove: function (e) {
- if (!this._moved) {
- this._moved = true;
+ _performZoom: function () {
+ var map = this._map,
+ zoom = map.getZoom(),
+ snap = this._map.options.zoomSnap || 0;
- this._box = L.DomUtil.create('div', 'leaflet-zoom-box', this._container);
- L.DomUtil.addClass(this._container, 'leaflet-crosshair');
+ map._stop(); // stop panning and fly animations if any
- this._map.fire('boxzoomstart');
+ // map the delta with a sigmoid function to -4..4 range leaning on -1..1
+ var d2 = this._delta / (this._map.options.wheelPxPerZoomLevel * 4),
+ d3 = 4 * Math.log(2 / (1 + Math.exp(-Math.abs(d2)))) / Math.LN2,
+ d4 = snap ? Math.ceil(d3 / snap) * snap : d3,
+ delta = map._limitZoom(zoom + (this._delta > 0 ? d4 : -d4)) - zoom;
+
+ this._delta = 0;
+ this._startTime = null;
+
+ if (!delta) { return; }
+
+ if (map.options.scrollWheelZoom === 'center') {
+ map.setZoom(zoom + delta);
+ } else {
+ map.setZoomAround(this._lastMousePos, zoom + delta);
}
+ }
+});
- this._point = this._map.mouseEventToContainerPoint(e);
+// @section Handlers
+// @property scrollWheelZoom: Handler
+// Scroll wheel zoom handler.
+L.Map.addInitHook('addHandler', 'scrollWheelZoom', L.Map.ScrollWheelZoom);
- var bounds = new L.Bounds(this._point, this._startPoint),
- size = bounds.getSize();
- L.DomUtil.setPosition(this._box, bounds.min);
- this._box.style.width = size.x + 'px';
- this._box.style.height = size.y + 'px';
- },
+/*
+ * Extends the event handling code with double tap support for mobile browsers.
+ */
- _finish: function () {
- if (this._moved) {
- L.DomUtil.remove(this._box);
- L.DomUtil.removeClass(this._container, 'leaflet-crosshair');
+L.extend(L.DomEvent, {
+
+ _touchstart: L.Browser.msPointer ? 'MSPointerDown' : L.Browser.pointer ? 'pointerdown' : 'touchstart',
+ _touchend: L.Browser.msPointer ? 'MSPointerUp' : L.Browser.pointer ? 'pointerup' : 'touchend',
+
+ // inspired by Zepto touch code by Thomas Fuchs
+ addDoubleTapListener: function (obj, handler, id) {
+ var last, touch,
+ doubleTap = false,
+ delay = 250;
+
+ function onTouchStart(e) {
+ var count;
+
+ if (L.Browser.pointer) {
+ count = L.DomEvent._pointersCount;
+ } else {
+ count = e.touches.length;
+ }
+
+ if (count > 1) { return; }
+
+ var now = Date.now(),
+ delta = now - (last || now);
+
+ touch = e.touches ? e.touches[0] : e;
+ doubleTap = (delta > 0 && delta <= delay);
+ last = now;
}
- L.DomUtil.enableTextSelection();
- L.DomUtil.enableImageDrag();
+ function onTouchEnd() {
+ if (doubleTap && !touch.cancelBubble) {
+ if (L.Browser.pointer) {
+ // work around .type being readonly with MSPointer* events
+ var newTouch = {},
+ prop, i;
- L.DomEvent.off(document, {
- contextmenu: L.DomEvent.stop,
- mousemove: this._onMouseMove,
- mouseup: this._onMouseUp,
- keydown: this._onKeyDown
- }, this);
- },
+ for (i in touch) {
+ prop = touch[i];
+ newTouch[i] = prop && prop.bind ? prop.bind(touch) : prop;
+ }
+ touch = newTouch;
+ }
+ touch.type = 'dblclick';
+ handler(touch);
+ last = null;
+ }
+ }
- _onMouseUp: function (e) {
- if ((e.which !== 1) && (e.button !== 1)) { return; }
+ var pre = '_leaflet_',
+ touchstart = this._touchstart,
+ touchend = this._touchend;
- this._finish();
+ obj[pre + touchstart + id] = onTouchStart;
+ obj[pre + touchend + id] = onTouchEnd;
+ obj[pre + 'dblclick' + id] = handler;
- if (!this._moved) { return; }
- // Postpone to next JS tick so internal click event handling
- // still see it as "moved".
- setTimeout(L.bind(this._resetState, this), 0);
+ obj.addEventListener(touchstart, onTouchStart, false);
+ obj.addEventListener(touchend, onTouchEnd, false);
- var bounds = new L.LatLngBounds(
- this._map.containerPointToLatLng(this._startPoint),
- this._map.containerPointToLatLng(this._point));
+ // On some platforms (notably, chrome on win10 + touchscreen + mouse),
+ // the browser doesn't fire touchend/pointerup events but does fire
+ // native dblclicks. See #4127.
+ if (!L.Browser.edge) {
+ obj.addEventListener('dblclick', handler, false);
+ }
- this._map
- .fitBounds(bounds)
- .fire('boxzoomend', {boxZoomBounds: bounds});
+ return this;
},
- _onKeyDown: function (e) {
- if (e.keyCode === 27) {
- this._finish();
+ removeDoubleTapListener: function (obj, id) {
+ var pre = '_leaflet_',
+ touchstart = obj[pre + this._touchstart + id],
+ touchend = obj[pre + this._touchend + id],
+ dblclick = obj[pre + 'dblclick' + id];
+
+ obj.removeEventListener(this._touchstart, touchstart, false);
+ obj.removeEventListener(this._touchend, touchend, false);
+ if (!L.Browser.edge) {
+ obj.removeEventListener('dblclick', dblclick, false);
}
+
+ return this;
}
});
-// @section Handlers
-// @property boxZoom: Handler
-// Box (shift-drag with mouse) zoom handler.
-L.Map.addInitHook('addHandler', 'boxZoom', L.Map.BoxZoom);
-
/*
- * L.Map.Keyboard is handling keyboard interaction with the map, enabled by default.
+ * Extends L.DomEvent to provide touch support for Internet Explorer and Windows-based devices.
*/
-// @namespace Map
-// @section Keyboard Navigation Options
-L.Map.mergeOptions({
- // @option keyboard: Boolean = true
- // Makes the map focusable and allows users to navigate the map with keyboard
- // arrows and `+`/`-` keys.
- keyboard: true,
+L.extend(L.DomEvent, {
- // @option keyboardPanDelta: Number = 80
- // Amount of pixels to pan when pressing an arrow key.
- keyboardPanDelta: 80
-});
+ POINTER_DOWN: L.Browser.msPointer ? 'MSPointerDown' : 'pointerdown',
+ POINTER_MOVE: L.Browser.msPointer ? 'MSPointerMove' : 'pointermove',
+ POINTER_UP: L.Browser.msPointer ? 'MSPointerUp' : 'pointerup',
+ POINTER_CANCEL: L.Browser.msPointer ? 'MSPointerCancel' : 'pointercancel',
+ TAG_WHITE_LIST: ['INPUT', 'SELECT', 'OPTION'],
-L.Map.Keyboard = L.Handler.extend({
+ _pointers: {},
+ _pointersCount: 0,
- keyCodes: {
- left: [37],
- right: [39],
- down: [40],
- up: [38],
- zoomIn: [187, 107, 61, 171],
- zoomOut: [189, 109, 54, 173]
- },
+ // Provides a touch events wrapper for (ms)pointer events.
+ // ref http://www.w3.org/TR/pointerevents/ https://www.w3.org/Bugs/Public/show_bug.cgi?id=22890
- initialize: function (map) {
- this._map = map;
+ addPointerListener: function (obj, type, handler, id) {
- this._setPanDelta(map.options.keyboardPanDelta);
- this._setZoomDelta(map.options.zoomDelta);
- },
+ if (type === 'touchstart') {
+ this._addPointerStart(obj, handler, id);
- addHooks: function () {
- var container = this._map._container;
+ } else if (type === 'touchmove') {
+ this._addPointerMove(obj, handler, id);
- // make the container focusable by tabbing
- if (container.tabIndex <= 0) {
- container.tabIndex = '0';
+ } else if (type === 'touchend') {
+ this._addPointerEnd(obj, handler, id);
}
- L.DomEvent.on(container, {
- focus: this._onFocus,
- blur: this._onBlur,
- mousedown: this._onMouseDown
- }, this);
-
- this._map.on({
- focus: this._addHooks,
- blur: this._removeHooks
- }, this);
+ return this;
},
- removeHooks: function () {
- this._removeHooks();
+ removePointerListener: function (obj, type, id) {
+ var handler = obj['_leaflet_' + type + id];
- L.DomEvent.off(this._map._container, {
- focus: this._onFocus,
- blur: this._onBlur,
- mousedown: this._onMouseDown
- }, this);
+ if (type === 'touchstart') {
+ obj.removeEventListener(this.POINTER_DOWN, handler, false);
- this._map.off({
- focus: this._addHooks,
- blur: this._removeHooks
- }, this);
- },
+ } else if (type === 'touchmove') {
+ obj.removeEventListener(this.POINTER_MOVE, handler, false);
- _onMouseDown: function () {
- if (this._focused) { return; }
+ } else if (type === 'touchend') {
+ obj.removeEventListener(this.POINTER_UP, handler, false);
+ obj.removeEventListener(this.POINTER_CANCEL, handler, false);
+ }
- var body = document.body,
- docEl = document.documentElement,
- top = body.scrollTop || docEl.scrollTop,
- left = body.scrollLeft || docEl.scrollLeft;
+ return this;
+ },
- this._map._container.focus();
+ _addPointerStart: function (obj, handler, id) {
+ var onDown = L.bind(function (e) {
+ if (e.pointerType !== 'mouse' && e.pointerType !== e.MSPOINTER_TYPE_MOUSE) {
+ // In IE11, some touch events needs to fire for form controls, or
+ // the controls will stop working. We keep a whitelist of tag names that
+ // need these events. For other target tags, we prevent default on the event.
+ if (this.TAG_WHITE_LIST.indexOf(e.target.tagName) < 0) {
+ L.DomEvent.preventDefault(e);
+ } else {
+ return;
+ }
+ }
- window.scrollTo(left, top);
- },
+ this._handlePointer(e, handler);
+ }, this);
- _onFocus: function () {
- this._focused = true;
- this._map.fire('focus');
- },
+ obj['_leaflet_touchstart' + id] = onDown;
+ obj.addEventListener(this.POINTER_DOWN, onDown, false);
- _onBlur: function () {
- this._focused = false;
- this._map.fire('blur');
- },
+ // need to keep track of what pointers and how many are active to provide e.touches emulation
+ if (!this._pointerDocListener) {
+ var pointerUp = L.bind(this._globalPointerUp, this);
- _setPanDelta: function (panDelta) {
- var keys = this._panKeys = {},
- codes = this.keyCodes,
- i, len;
+ // we listen documentElement as any drags that end by moving the touch off the screen get fired there
+ document.documentElement.addEventListener(this.POINTER_DOWN, L.bind(this._globalPointerDown, this), true);
+ document.documentElement.addEventListener(this.POINTER_MOVE, L.bind(this._globalPointerMove, this), true);
+ document.documentElement.addEventListener(this.POINTER_UP, pointerUp, true);
+ document.documentElement.addEventListener(this.POINTER_CANCEL, pointerUp, true);
- for (i = 0, len = codes.left.length; i < len; i++) {
- keys[codes.left[i]] = [-1 * panDelta, 0];
- }
- for (i = 0, len = codes.right.length; i < len; i++) {
- keys[codes.right[i]] = [panDelta, 0];
- }
- for (i = 0, len = codes.down.length; i < len; i++) {
- keys[codes.down[i]] = [0, panDelta];
- }
- for (i = 0, len = codes.up.length; i < len; i++) {
- keys[codes.up[i]] = [0, -1 * panDelta];
+ this._pointerDocListener = true;
}
},
- _setZoomDelta: function (zoomDelta) {
- var keys = this._zoomKeys = {},
- codes = this.keyCodes,
- i, len;
+ _globalPointerDown: function (e) {
+ this._pointers[e.pointerId] = e;
+ this._pointersCount++;
+ },
- for (i = 0, len = codes.zoomIn.length; i < len; i++) {
- keys[codes.zoomIn[i]] = zoomDelta;
- }
- for (i = 0, len = codes.zoomOut.length; i < len; i++) {
- keys[codes.zoomOut[i]] = -zoomDelta;
+ _globalPointerMove: function (e) {
+ if (this._pointers[e.pointerId]) {
+ this._pointers[e.pointerId] = e;
}
},
- _addHooks: function () {
- L.DomEvent.on(document, 'keydown', this._onKeyDown, this);
+ _globalPointerUp: function (e) {
+ delete this._pointers[e.pointerId];
+ this._pointersCount--;
},
- _removeHooks: function () {
- L.DomEvent.off(document, 'keydown', this._onKeyDown, this);
+ _handlePointer: function (e, handler) {
+ e.touches = [];
+ for (var i in this._pointers) {
+ e.touches.push(this._pointers[i]);
+ }
+ e.changedTouches = [e];
+
+ handler(e);
},
- _onKeyDown: function (e) {
- if (e.altKey || e.ctrlKey || e.metaKey) { return; }
+ _addPointerMove: function (obj, handler, id) {
+ var onMove = L.bind(function (e) {
+ // don't fire touch moves when mouse isn't down
+ if ((e.pointerType === e.MSPOINTER_TYPE_MOUSE || e.pointerType === 'mouse') && e.buttons === 0) { return; }
- var key = e.keyCode,
- map = this._map,
- offset;
+ this._handlePointer(e, handler);
+ }, this);
- if (key in this._panKeys) {
+ obj['_leaflet_touchmove' + id] = onMove;
+ obj.addEventListener(this.POINTER_MOVE, onMove, false);
+ },
- if (map._panAnim && map._panAnim._inProgress) { return; }
+ _addPointerEnd: function (obj, handler, id) {
+ var onUp = L.bind(function (e) {
+ this._handlePointer(e, handler);
+ }, this);
- offset = this._panKeys[key];
- if (e.shiftKey) {
- offset = L.point(offset).multiplyBy(3);
- }
+ obj['_leaflet_touchend' + id] = onUp;
+ obj.addEventListener(this.POINTER_UP, onUp, false);
+ obj.addEventListener(this.POINTER_CANCEL, onUp, false);
+ }
+});
- map.panBy(offset);
- if (map.options.maxBounds) {
- map.panInsideBounds(map.options.maxBounds);
- }
- } else if (key in this._zoomKeys) {
- map.setZoom(map.getZoom() + (e.shiftKey ? 3 : 1) * this._zoomKeys[key]);
+/*
+ * L.Handler.TouchZoom is used by L.Map to add pinch zoom on supported mobile browsers.
+ */
- } else if (key === 27) {
- map.closePopup();
+// @namespace Map
+// @section Interaction Options
+L.Map.mergeOptions({
+ // @section Touch interaction options
+ // @option touchZoom: Boolean|String = *
+ // Whether the map can be zoomed by touch-dragging with two fingers. If
+ // passed `'center'`, it will zoom to the center of the view regardless of
+ // where the touch events (fingers) were. Enabled for touch-capable web
+ // browsers except for old Androids.
+ touchZoom: L.Browser.touch && !L.Browser.android23,
+
+ // @option bounceAtZoomLimits: Boolean = true
+ // Set it to false if you don't want the map to zoom beyond min/max zoom
+ // and then bounce back when pinch-zooming.
+ bounceAtZoomLimits: true
+});
+
+L.Map.TouchZoom = L.Handler.extend({
+ addHooks: function () {
+ L.DomUtil.addClass(this._map._container, 'leaflet-touch-zoom');
+ L.DomEvent.on(this._map._container, 'touchstart', this._onTouchStart, this);
+ },
- } else {
- return;
- }
+ removeHooks: function () {
+ L.DomUtil.removeClass(this._map._container, 'leaflet-touch-zoom');
+ L.DomEvent.off(this._map._container, 'touchstart', this._onTouchStart, this);
+ },
- L.DomEvent.stop(e);
- }
-});
+ _onTouchStart: function (e) {
+ var map = this._map;
+ if (!e.touches || e.touches.length !== 2 || map._animatingZoom || this._zooming) { return; }
-// @section Handlers
-// @section Handlers
-// @property keyboard: Handler
-// Keyboard navigation handler.
-L.Map.addInitHook('addHandler', 'keyboard', L.Map.Keyboard);
+ var p1 = map.mouseEventToContainerPoint(e.touches[0]),
+ p2 = map.mouseEventToContainerPoint(e.touches[1]);
+ this._centerPoint = map.getSize()._divideBy(2);
+ this._startLatLng = map.containerPointToLatLng(this._centerPoint);
+ if (map.options.touchZoom !== 'center') {
+ this._pinchStartLatLng = map.containerPointToLatLng(p1.add(p2)._divideBy(2));
+ }
+ this._startDist = p1.distanceTo(p2);
+ this._startZoom = map.getZoom();
-/*
- * L.Handler.MarkerDrag is used internally by L.Marker to make the markers draggable.
- */
+ this._moved = false;
+ this._zooming = true;
+ map._stop();
-/* @namespace Marker
- * @section Interaction handlers
- *
- * Interaction handlers are properties of a marker instance that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging (see `Handler` methods). Example:
- *
- * ```js
- * marker.dragging.disable();
- * ```
- *
- * @property dragging: Handler
- * Marker dragging handler (by both mouse and touch).
- */
+ L.DomEvent
+ .on(document, 'touchmove', this._onTouchMove, this)
+ .on(document, 'touchend', this._onTouchEnd, this);
-L.Handler.MarkerDrag = L.Handler.extend({
- initialize: function (marker) {
- this._marker = marker;
+ L.DomEvent.preventDefault(e);
},
- addHooks: function () {
- var icon = this._marker._icon;
+ _onTouchMove: function (e) {
+ if (!e.touches || e.touches.length !== 2 || !this._zooming) { return; }
- if (!this._draggable) {
- this._draggable = new L.Draggable(icon, icon, true);
- }
+ var map = this._map,
+ p1 = map.mouseEventToContainerPoint(e.touches[0]),
+ p2 = map.mouseEventToContainerPoint(e.touches[1]),
+ scale = p1.distanceTo(p2) / this._startDist;
- this._draggable.on({
- dragstart: this._onDragStart,
- drag: this._onDrag,
- dragend: this._onDragEnd
- }, this).enable();
- L.DomUtil.addClass(icon, 'leaflet-marker-draggable');
- },
+ this._zoom = map.getScaleZoom(scale, this._startZoom);
- removeHooks: function () {
- this._draggable.off({
- dragstart: this._onDragStart,
- drag: this._onDrag,
- dragend: this._onDragEnd
- }, this).disable();
+ if (!map.options.bounceAtZoomLimits && (
+ (this._zoom < map.getMinZoom() && scale < 1) ||
+ (this._zoom > map.getMaxZoom() && scale > 1))) {
+ this._zoom = map._limitZoom(this._zoom);
+ }
- if (this._marker._icon) {
- L.DomUtil.removeClass(this._marker._icon, 'leaflet-marker-draggable');
+ if (map.options.touchZoom === 'center') {
+ this._center = this._startLatLng;
+ if (scale === 1) { return; }
+ } else {
+ // Get delta from pinch to center, so centerLatLng is delta applied to initial pinchLatLng
+ var delta = p1._add(p2)._divideBy(2)._subtract(this._centerPoint);
+ if (scale === 1 && delta.x === 0 && delta.y === 0) { return; }
+ this._center = map.unproject(map.project(this._pinchStartLatLng, this._zoom).subtract(delta), this._zoom);
}
- },
- moved: function () {
- return this._draggable && this._draggable._moved;
- },
+ if (!this._moved) {
+ map._moveStart(true);
+ this._moved = true;
+ }
- _onDragStart: function () {
- // @section Dragging events
- // @event dragstart: Event
- // Fired when the user starts dragging the marker.
+ L.Util.cancelAnimFrame(this._animRequest);
- // @event movestart: Event
- // Fired when the marker starts moving (because of dragging).
+ var moveFn = L.bind(map._move, map, this._center, this._zoom, {pinch: true, round: false});
+ this._animRequest = L.Util.requestAnimFrame(moveFn, this, true);
- this._oldLatLng = this._marker.getLatLng();
- this._marker
- .closePopup()
- .fire('movestart')
- .fire('dragstart');
+ L.DomEvent.preventDefault(e);
},
- _onDrag: function (e) {
- var marker = this._marker,
- shadow = marker._shadow,
- iconPos = L.DomUtil.getPosition(marker._icon),
- latlng = marker._map.layerPointToLatLng(iconPos);
-
- // update shadow position
- if (shadow) {
- L.DomUtil.setPosition(shadow, iconPos);
+ _onTouchEnd: function () {
+ if (!this._moved || !this._zooming) {
+ this._zooming = false;
+ return;
}
- marker._latlng = latlng;
- e.latlng = latlng;
- e.oldLatLng = this._oldLatLng;
-
- // @event drag: Event
- // Fired repeatedly while the user drags the marker.
- marker
- .fire('move', e)
- .fire('drag', e);
- },
+ this._zooming = false;
+ L.Util.cancelAnimFrame(this._animRequest);
- _onDragEnd: function (e) {
- // @event dragend: DragEndEvent
- // Fired when the user stops dragging the marker.
+ L.DomEvent
+ .off(document, 'touchmove', this._onTouchMove)
+ .off(document, 'touchend', this._onTouchEnd);
- // @event moveend: Event
- // Fired when the marker stops moving (because of dragging).
- delete this._oldLatLng;
- this._marker
- .fire('moveend')
- .fire('dragend', e);
+ // Pinch updates GridLayers' levels only when zoomSnap is off, so zoomSnap becomes noUpdate.
+ if (this._map.options.zoomAnimation) {
+ this._map._animateZoom(this._center, this._map._limitZoom(this._zoom), true, this._map.options.zoomSnap);
+ } else {
+ this._map._resetView(this._center, this._map._limitZoom(this._zoom));
+ }
}
});
+// @section Handlers
+// @property touchZoom: Handler
+// Touch zoom handler.
+L.Map.addInitHook('addHandler', 'touchZoom', L.Map.TouchZoom);
+
/*
- * @class Control
- * @aka L.Control
- *
- * L.Control is a base class for implementing map controls. Handles positioning.
- * All other controls extend from this class.
+ * L.Map.Tap is used to enable mobile hacks like quick taps and long hold.
*/
-L.Control = L.Class.extend({
- // @section
- // @aka Control options
- options: {
- // @option position: String = 'topright'
- // The position of the control (one of the map corners). Possible values are `'topleft'`,
- // `'topright'`, `'bottomleft'` or `'bottomright'`
- position: 'topright'
- },
-
- initialize: function (options) {
- L.setOptions(this, options);
- },
-
- /* @section
- * Classes extending L.Control will inherit the following methods:
- *
- * @method getPosition: string
- * Returns the position of the control.
- */
- getPosition: function () {
- return this.options.position;
- },
-
- // @method setPosition(position: string): this
- // Sets the position of the control.
- setPosition: function (position) {
- var map = this._map;
-
- if (map) {
- map.removeControl(this);
- }
-
- this.options.position = position;
+// @namespace Map
+// @section Interaction Options
+L.Map.mergeOptions({
+ // @section Touch interaction options
+ // @option tap: Boolean = true
+ // Enables mobile hacks for supporting instant taps (fixing 200ms click
+ // delay on iOS/Android) and touch holds (fired as `contextmenu` events).
+ tap: true,
- if (map) {
- map.addControl(this);
- }
+ // @option tapTolerance: Number = 15
+ // The max number of pixels a user can shift his finger during touch
+ // for it to be considered a valid tap.
+ tapTolerance: 15
+});
- return this;
+L.Map.Tap = L.Handler.extend({
+ addHooks: function () {
+ L.DomEvent.on(this._map._container, 'touchstart', this._onDown, this);
},
- // @method getContainer: HTMLElement
- // Returns the HTMLElement that contains the control.
- getContainer: function () {
- return this._container;
+ removeHooks: function () {
+ L.DomEvent.off(this._map._container, 'touchstart', this._onDown, this);
},
- // @method addTo(map: Map): this
- // Adds the control to the given map.
- addTo: function (map) {
- this.remove();
- this._map = map;
+ _onDown: function (e) {
+ if (!e.touches) { return; }
- var container = this._container = this.onAdd(map),
- pos = this.getPosition(),
- corner = map._controlCorners[pos];
+ L.DomEvent.preventDefault(e);
- L.DomUtil.addClass(container, 'leaflet-control');
+ this._fireClick = true;
- if (pos.indexOf('bottom') !== -1) {
- corner.insertBefore(container, corner.firstChild);
- } else {
- corner.appendChild(container);
+ // don't simulate click or track longpress if more than 1 touch
+ if (e.touches.length > 1) {
+ this._fireClick = false;
+ clearTimeout(this._holdTimeout);
+ return;
}
- return this;
- },
-
- // @method remove: this
- // Removes the control from the map it is currently active on.
- remove: function () {
- if (!this._map) {
- return this;
- }
+ var first = e.touches[0],
+ el = first.target;
- L.DomUtil.remove(this._container);
+ this._startPos = this._newPos = new L.Point(first.clientX, first.clientY);
- if (this.onRemove) {
- this.onRemove(this._map);
+ // if touching a link, highlight it
+ if (el.tagName && el.tagName.toLowerCase() === 'a') {
+ L.DomUtil.addClass(el, 'leaflet-active');
}
- this._map = null;
+ // simulate long hold but setting a timeout
+ this._holdTimeout = setTimeout(L.bind(function () {
+ if (this._isTapValid()) {
+ this._fireClick = false;
+ this._onUp();
+ this._simulateEvent('contextmenu', first);
+ }
+ }, this), 1000);
- return this;
+ this._simulateEvent('mousedown', first);
+
+ L.DomEvent.on(document, {
+ touchmove: this._onMove,
+ touchend: this._onUp
+ }, this);
},
- _refocusOnMap: function (e) {
- // if map exists and event is not a keyboard event
- if (this._map && e && e.screenX > 0 && e.screenY > 0) {
- this._map.getContainer().focus();
- }
- }
-});
+ _onUp: function (e) {
+ clearTimeout(this._holdTimeout);
-L.control = function (options) {
- return new L.Control(options);
-};
+ L.DomEvent.off(document, {
+ touchmove: this._onMove,
+ touchend: this._onUp
+ }, this);
-/* @section Extension methods
- * @uninheritable
- *
- * Every control should extend from `L.Control` and (re-)implement the following methods.
- *
- * @method onAdd(map: Map): HTMLElement
- * Should return the container DOM element for the control and add listeners on relevant map events. Called on [`control.addTo(map)`](#control-addTo).
- *
- * @method onRemove(map: Map)
- * Optional method. Should contain all clean up code that removes the listeners previously added in [`onAdd`](#control-onadd). Called on [`control.remove()`](#control-remove).
- */
+ if (this._fireClick && e && e.changedTouches) {
-/* @namespace Map
- * @section Methods for Layers and Controls
- */
-L.Map.include({
- // @method addControl(control: Control): this
- // Adds the given control to the map
- addControl: function (control) {
- control.addTo(this);
- return this;
+ var first = e.changedTouches[0],
+ el = first.target;
+
+ if (el && el.tagName && el.tagName.toLowerCase() === 'a') {
+ L.DomUtil.removeClass(el, 'leaflet-active');
+ }
+
+ this._simulateEvent('mouseup', first);
+
+ // simulate click if the touch didn't move too much
+ if (this._isTapValid()) {
+ this._simulateEvent('click', first);
+ }
+ }
},
- // @method removeControl(control: Control): this
- // Removes the given control from the map
- removeControl: function (control) {
- control.remove();
- return this;
+ _isTapValid: function () {
+ return this._newPos.distanceTo(this._startPos) <= this._map.options.tapTolerance;
},
- _initControlPos: function () {
- var corners = this._controlCorners = {},
- l = 'leaflet-',
- container = this._controlContainer =
- L.DomUtil.create('div', l + 'control-container', this._container);
+ _onMove: function (e) {
+ var first = e.touches[0];
+ this._newPos = new L.Point(first.clientX, first.clientY);
+ this._simulateEvent('mousemove', first);
+ },
- function createCorner(vSide, hSide) {
- var className = l + vSide + ' ' + l + hSide;
+ _simulateEvent: function (type, e) {
+ var simulatedEvent = document.createEvent('MouseEvents');
- corners[vSide + hSide] = L.DomUtil.create('div', className, container);
- }
+ simulatedEvent._simulated = true;
+ e.target._simulatedClick = true;
- createCorner('top', 'left');
- createCorner('top', 'right');
- createCorner('bottom', 'left');
- createCorner('bottom', 'right');
- },
+ simulatedEvent.initMouseEvent(
+ type, true, true, window, 1,
+ e.screenX, e.screenY,
+ e.clientX, e.clientY,
+ false, false, false, false, 0, null);
- _clearControlPos: function () {
- L.DomUtil.remove(this._controlContainer);
+ e.target.dispatchEvent(simulatedEvent);
}
});
+// @section Handlers
+// @property tap: Handler
+// Mobile touch hacks (quick tap and touch hold) handler.
+if (L.Browser.touch && !L.Browser.pointer) {
+ L.Map.addInitHook('addHandler', 'tap', L.Map.Tap);
+}
+
/*
- * @class Control.Zoom
- * @aka L.Control.Zoom
- * @inherits Control
- *
- * A basic zoom control with two buttons (zoom in and zoom out). It is put on the map by default unless you set its [`zoomControl` option](#map-zoomcontrol) to `false`. Extends `Control`.
+ * L.Handler.BoxZoom is used to add shift-drag zoom interaction to the map
+ * (zoom to a selected bounding box), enabled by default.
*/
-L.Control.Zoom = L.Control.extend({
- // @section
- // @aka Control.Zoom options
- options: {
- position: 'topleft',
+// @namespace Map
+// @section Interaction Options
+L.Map.mergeOptions({
+ // @option boxZoom: Boolean = true
+ // Whether the map can be zoomed to a rectangular area specified by
+ // dragging the mouse while pressing the shift key.
+ boxZoom: true
+});
- // @option zoomInText: String = '+'
- // The text set on the 'zoom in' button.
- zoomInText: '+',
+L.Map.BoxZoom = L.Handler.extend({
+ initialize: function (map) {
+ this._map = map;
+ this._container = map._container;
+ this._pane = map._panes.overlayPane;
+ },
- // @option zoomInTitle: String = 'Zoom in'
- // The title set on the 'zoom in' button.
- zoomInTitle: 'Zoom in',
+ addHooks: function () {
+ L.DomEvent.on(this._container, 'mousedown', this._onMouseDown, this);
+ },
- // @option zoomOutText: String = '-'
- // The text set on the 'zoom out' button.
- zoomOutText: '-',
+ removeHooks: function () {
+ L.DomEvent.off(this._container, 'mousedown', this._onMouseDown, this);
+ },
- // @option zoomOutTitle: String = 'Zoom out'
- // The title set on the 'zoom out' button.
- zoomOutTitle: 'Zoom out'
+ moved: function () {
+ return this._moved;
},
- onAdd: function (map) {
- var zoomName = 'leaflet-control-zoom',
- container = L.DomUtil.create('div', zoomName + ' leaflet-bar'),
- options = this.options;
+ _resetState: function () {
+ this._moved = false;
+ },
- this._zoomInButton = this._createButton(options.zoomInText, options.zoomInTitle,
- zoomName + '-in', container, this._zoomIn);
- this._zoomOutButton = this._createButton(options.zoomOutText, options.zoomOutTitle,
- zoomName + '-out', container, this._zoomOut);
+ _onMouseDown: function (e) {
+ if (!e.shiftKey || ((e.which !== 1) && (e.button !== 1))) { return false; }
- this._updateDisabled();
- map.on('zoomend zoomlevelschange', this._updateDisabled, this);
+ this._resetState();
- return container;
- },
+ L.DomUtil.disableTextSelection();
+ L.DomUtil.disableImageDrag();
- onRemove: function (map) {
- map.off('zoomend zoomlevelschange', this._updateDisabled, this);
- },
+ this._startPoint = this._map.mouseEventToContainerPoint(e);
- disable: function () {
- this._disabled = true;
- this._updateDisabled();
- return this;
+ L.DomEvent.on(document, {
+ contextmenu: L.DomEvent.stop,
+ mousemove: this._onMouseMove,
+ mouseup: this._onMouseUp,
+ keydown: this._onKeyDown
+ }, this);
},
- enable: function () {
- this._disabled = false;
- this._updateDisabled();
- return this;
- },
+ _onMouseMove: function (e) {
+ if (!this._moved) {
+ this._moved = true;
- _zoomIn: function (e) {
- if (!this._disabled && this._map._zoom < this._map.getMaxZoom()) {
- this._map.zoomIn(this._map.options.zoomDelta * (e.shiftKey ? 3 : 1));
- }
- },
+ this._box = L.DomUtil.create('div', 'leaflet-zoom-box', this._container);
+ L.DomUtil.addClass(this._container, 'leaflet-crosshair');
- _zoomOut: function (e) {
- if (!this._disabled && this._map._zoom > this._map.getMinZoom()) {
- this._map.zoomOut(this._map.options.zoomDelta * (e.shiftKey ? 3 : 1));
+ this._map.fire('boxzoomstart');
}
+
+ this._point = this._map.mouseEventToContainerPoint(e);
+
+ var bounds = new L.Bounds(this._point, this._startPoint),
+ size = bounds.getSize();
+
+ L.DomUtil.setPosition(this._box, bounds.min);
+
+ this._box.style.width = size.x + 'px';
+ this._box.style.height = size.y + 'px';
},
- _createButton: function (html, title, className, container, fn) {
- var link = L.DomUtil.create('a', className, container);
- link.innerHTML = html;
- link.href = '#';
- link.title = title;
+ _finish: function () {
+ if (this._moved) {
+ L.DomUtil.remove(this._box);
+ L.DomUtil.removeClass(this._container, 'leaflet-crosshair');
+ }
- L.DomEvent
- .on(link, 'mousedown dblclick', L.DomEvent.stopPropagation)
- .on(link, 'click', L.DomEvent.stop)
- .on(link, 'click', fn, this)
- .on(link, 'click', this._refocusOnMap, this);
+ L.DomUtil.enableTextSelection();
+ L.DomUtil.enableImageDrag();
- return link;
+ L.DomEvent.off(document, {
+ contextmenu: L.DomEvent.stop,
+ mousemove: this._onMouseMove,
+ mouseup: this._onMouseUp,
+ keydown: this._onKeyDown
+ }, this);
},
- _updateDisabled: function () {
- var map = this._map,
- className = 'leaflet-disabled';
+ _onMouseUp: function (e) {
+ if ((e.which !== 1) && (e.button !== 1)) { return; }
- L.DomUtil.removeClass(this._zoomInButton, className);
- L.DomUtil.removeClass(this._zoomOutButton, className);
+ this._finish();
- if (this._disabled || map._zoom === map.getMinZoom()) {
- L.DomUtil.addClass(this._zoomOutButton, className);
- }
- if (this._disabled || map._zoom === map.getMaxZoom()) {
- L.DomUtil.addClass(this._zoomInButton, className);
- }
- }
-});
+ if (!this._moved) { return; }
+ // Postpone to next JS tick so internal click event handling
+ // still see it as "moved".
+ setTimeout(L.bind(this._resetState, this), 0);
-// @namespace Map
-// @section Control options
-// @option zoomControl: Boolean = true
-// Whether a [zoom control](#control-zoom) is added to the map by default.
-L.Map.mergeOptions({
- zoomControl: true
-});
+ var bounds = new L.LatLngBounds(
+ this._map.containerPointToLatLng(this._startPoint),
+ this._map.containerPointToLatLng(this._point));
-L.Map.addInitHook(function () {
- if (this.options.zoomControl) {
- this.zoomControl = new L.Control.Zoom();
- this.addControl(this.zoomControl);
+ this._map
+ .fitBounds(bounds)
+ .fire('boxzoomend', {boxZoomBounds: bounds});
+ },
+
+ _onKeyDown: function (e) {
+ if (e.keyCode === 27) {
+ this._finish();
+ }
}
});
-// @namespace Control.Zoom
-// @factory L.control.zoom(options: Control.Zoom options)
-// Creates a zoom control
-L.control.zoom = function (options) {
- return new L.Control.Zoom(options);
-};
+// @section Handlers
+// @property boxZoom: Handler
+// Box (shift-drag with mouse) zoom handler.
+L.Map.addInitHook('addHandler', 'boxZoom', L.Map.BoxZoom);
/*
- * @class Control.Attribution
- * @aka L.Control.Attribution
- * @inherits Control
- *
- * 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.
+ * L.Map.Keyboard is handling keyboard interaction with the map, enabled by default.
*/
-L.Control.Attribution = L.Control.extend({
- // @section
- // @aka Control.Attribution options
- options: {
- position: 'bottomright',
+// @namespace Map
+// @section Keyboard Navigation Options
+L.Map.mergeOptions({
+ // @option keyboard: Boolean = true
+ // Makes the map focusable and allows users to navigate the map with keyboard
+ // arrows and `+`/`-` keys.
+ keyboard: true,
- // @option prefix: String = 'Leaflet'
- // The HTML text shown before the attributions. Pass `false` to disable.
- prefix: '<a href="http://leafletjs.com" title="A JS library for interactive maps">Leaflet</a>'
+ // @option keyboardPanDelta: Number = 80
+ // Amount of pixels to pan when pressing an arrow key.
+ keyboardPanDelta: 80
+});
+
+L.Map.Keyboard = L.Handler.extend({
+
+ keyCodes: {
+ left: [37],
+ right: [39],
+ down: [40],
+ up: [38],
+ zoomIn: [187, 107, 61, 171],
+ zoomOut: [189, 109, 54, 173]
},
- initialize: function (options) {
- L.setOptions(this, options);
+ initialize: function (map) {
+ this._map = map;
- this._attributions = {};
+ this._setPanDelta(map.options.keyboardPanDelta);
+ this._setZoomDelta(map.options.zoomDelta);
},
- onAdd: function (map) {
- map.attributionControl = this;
- this._container = L.DomUtil.create('div', 'leaflet-control-attribution');
- if (L.DomEvent) {
- L.DomEvent.disableClickPropagation(this._container);
- }
+ addHooks: function () {
+ var container = this._map._container;
- // TODO ugly, refactor
- for (var i in map._layers) {
- if (map._layers[i].getAttribution) {
- this.addAttribution(map._layers[i].getAttribution());
- }
+ // make the container focusable by tabbing
+ if (container.tabIndex <= 0) {
+ container.tabIndex = '0';
}
- this._update();
+ L.DomEvent.on(container, {
+ focus: this._onFocus,
+ blur: this._onBlur,
+ mousedown: this._onMouseDown
+ }, this);
- return this._container;
+ this._map.on({
+ focus: this._addHooks,
+ blur: this._removeHooks
+ }, this);
},
- // @method setPrefix(prefix: String): this
- // Sets the text before the attributions.
- setPrefix: function (prefix) {
- this.options.prefix = prefix;
- this._update();
- return this;
+ removeHooks: function () {
+ this._removeHooks();
+
+ L.DomEvent.off(this._map._container, {
+ focus: this._onFocus,
+ blur: this._onBlur,
+ mousedown: this._onMouseDown
+ }, this);
+
+ this._map.off({
+ focus: this._addHooks,
+ blur: this._removeHooks
+ }, this);
},
- // @method addAttribution(text: String): this
- // Adds an attribution text (e.g. `'Vector data © Mapbox'`).
- addAttribution: function (text) {
- if (!text) { return this; }
+ _onMouseDown: function () {
+ if (this._focused) { return; }
- if (!this._attributions[text]) {
- this._attributions[text] = 0;
- }
- this._attributions[text]++;
+ var body = document.body,
+ docEl = document.documentElement,
+ top = body.scrollTop || docEl.scrollTop,
+ left = body.scrollLeft || docEl.scrollLeft;
- this._update();
+ this._map._container.focus();
- return this;
+ window.scrollTo(left, top);
},
- // @method removeAttribution(text: String): this
- // Removes an attribution text.
- removeAttribution: function (text) {
- if (!text) { return this; }
+ _onFocus: function () {
+ this._focused = true;
+ this._map.fire('focus');
+ },
- if (this._attributions[text]) {
- this._attributions[text]--;
- this._update();
+ _onBlur: function () {
+ this._focused = false;
+ this._map.fire('blur');
+ },
+
+ _setPanDelta: function (panDelta) {
+ var keys = this._panKeys = {},
+ codes = this.keyCodes,
+ i, len;
+
+ for (i = 0, len = codes.left.length; i < len; i++) {
+ keys[codes.left[i]] = [-1 * panDelta, 0];
+ }
+ for (i = 0, len = codes.right.length; i < len; i++) {
+ keys[codes.right[i]] = [panDelta, 0];
}
+ for (i = 0, len = codes.down.length; i < len; i++) {
+ keys[codes.down[i]] = [0, panDelta];
+ }
+ for (i = 0, len = codes.up.length; i < len; i++) {
+ keys[codes.up[i]] = [0, -1 * panDelta];
+ }
+ },
- return this;
+ _setZoomDelta: function (zoomDelta) {
+ var keys = this._zoomKeys = {},
+ codes = this.keyCodes,
+ i, len;
+
+ for (i = 0, len = codes.zoomIn.length; i < len; i++) {
+ keys[codes.zoomIn[i]] = zoomDelta;
+ }
+ for (i = 0, len = codes.zoomOut.length; i < len; i++) {
+ keys[codes.zoomOut[i]] = -zoomDelta;
+ }
},
- _update: function () {
- if (!this._map) { return; }
+ _addHooks: function () {
+ L.DomEvent.on(document, 'keydown', this._onKeyDown, this);
+ },
- var attribs = [];
+ _removeHooks: function () {
+ L.DomEvent.off(document, 'keydown', this._onKeyDown, this);
+ },
- for (var i in this._attributions) {
- if (this._attributions[i]) {
- attribs.push(i);
+ _onKeyDown: function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey) { return; }
+
+ var key = e.keyCode,
+ map = this._map,
+ offset;
+
+ if (key in this._panKeys) {
+
+ if (map._panAnim && map._panAnim._inProgress) { return; }
+
+ offset = this._panKeys[key];
+ if (e.shiftKey) {
+ offset = L.point(offset).multiplyBy(3);
}
- }
- var prefixAndAttribs = [];
+ map.panBy(offset);
- if (this.options.prefix) {
- prefixAndAttribs.push(this.options.prefix);
- }
- if (attribs.length) {
- prefixAndAttribs.push(attribs.join(', '));
+ if (map.options.maxBounds) {
+ map.panInsideBounds(map.options.maxBounds);
+ }
+
+ } else if (key in this._zoomKeys) {
+ map.setZoom(map.getZoom() + (e.shiftKey ? 3 : 1) * this._zoomKeys[key]);
+
+ } else if (key === 27) {
+ map.closePopup();
+
+ } else {
+ return;
}
- this._container.innerHTML = prefixAndAttribs.join(' | ');
+ L.DomEvent.stop(e);
}
});
-// @namespace Map
-// @section Control options
-// @option attributionControl: Boolean = true
-// Whether a [attribution control](#control-attribution) is added to the map by default.
-L.Map.mergeOptions({
- attributionControl: true
-});
+// @section Handlers
+// @section Handlers
+// @property keyboard: Handler
+// Keyboard navigation handler.
+L.Map.addInitHook('addHandler', 'keyboard', L.Map.Keyboard);
-L.Map.addInitHook(function () {
- if (this.options.attributionControl) {
- new L.Control.Attribution().addTo(this);
- }
-});
-// @namespace Control.Attribution
-// @factory L.control.attribution(options: Control.Attribution options)
-// Creates an attribution control.
-L.control.attribution = function (options) {
- return new L.Control.Attribution(options);
-};
+/*
+ * L.Handler.MarkerDrag is used internally by L.Marker to make the markers draggable.
+ */
-/*
- * @class Control.Scale
- * @aka L.Control.Scale
- * @inherits Control
- *
- * A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems. Extends `Control`.
+/* @namespace Marker
+ * @section Interaction handlers
*
- * @example
+ * Interaction handlers are properties of a marker instance that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging (see `Handler` methods). Example:
*
* ```js
- * L.control.scale().addTo(map);
+ * marker.dragging.disable();
* ```
+ *
+ * @property dragging: Handler
+ * Marker dragging handler (by both mouse and touch).
*/
-L.Control.Scale = L.Control.extend({
- // @section
- // @aka Control.Scale options
- options: {
- position: 'bottomleft',
-
- // @option maxWidth: Number = 100
- // Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500).
- maxWidth: 100,
-
- // @option metric: Boolean = True
- // Whether to show the metric scale line (m/km).
- metric: true,
-
- // @option imperial: Boolean = True
- // Whether to show the imperial scale line (mi/ft).
- imperial: true
-
- // @option updateWhenIdle: Boolean = false
- // If `true`, the control is updated on [`moveend`](#map-moveend), otherwise it's always up-to-date (updated on [`move`](#map-move)).
+L.Handler.MarkerDrag = L.Handler.extend({
+ initialize: function (marker) {
+ this._marker = marker;
},
- onAdd: function (map) {
- var className = 'leaflet-control-scale',
- container = L.DomUtil.create('div', className),
- options = this.options;
+ addHooks: function () {
+ var icon = this._marker._icon;
- this._addScales(options, className + '-line', container);
+ if (!this._draggable) {
+ this._draggable = new L.Draggable(icon, icon, true);
+ }
- map.on(options.updateWhenIdle ? 'moveend' : 'move', this._update, this);
- map.whenReady(this._update, this);
+ this._draggable.on({
+ dragstart: this._onDragStart,
+ drag: this._onDrag,
+ dragend: this._onDragEnd
+ }, this).enable();
- return container;
+ L.DomUtil.addClass(icon, 'leaflet-marker-draggable');
},
- onRemove: function (map) {
- map.off(this.options.updateWhenIdle ? 'moveend' : 'move', this._update, this);
- },
+ removeHooks: function () {
+ this._draggable.off({
+ dragstart: this._onDragStart,
+ drag: this._onDrag,
+ dragend: this._onDragEnd
+ }, this).disable();
- _addScales: function (options, className, container) {
- if (options.metric) {
- this._mScale = L.DomUtil.create('div', className, container);
- }
- if (options.imperial) {
- this._iScale = L.DomUtil.create('div', className, container);
+ if (this._marker._icon) {
+ L.DomUtil.removeClass(this._marker._icon, 'leaflet-marker-draggable');
}
},
- _update: function () {
- var map = this._map,
- y = map.getSize().y / 2;
-
- var maxMeters = map.distance(
- map.containerPointToLatLng([0, y]),
- map.containerPointToLatLng([this.options.maxWidth, y]));
-
- this._updateScales(maxMeters);
+ moved: function () {
+ return this._draggable && this._draggable._moved;
},
- _updateScales: function (maxMeters) {
- if (this.options.metric && maxMeters) {
- this._updateMetric(maxMeters);
- }
- if (this.options.imperial && maxMeters) {
- this._updateImperial(maxMeters);
- }
- },
+ _onDragStart: function () {
+ // @section Dragging events
+ // @event dragstart: Event
+ // Fired when the user starts dragging the marker.
- _updateMetric: function (maxMeters) {
- var meters = this._getRoundNum(maxMeters),
- label = meters < 1000 ? meters + ' m' : (meters / 1000) + ' km';
+ // @event movestart: Event
+ // Fired when the marker starts moving (because of dragging).
- this._updateScale(this._mScale, label, meters / maxMeters);
+ this._oldLatLng = this._marker.getLatLng();
+ this._marker
+ .closePopup()
+ .fire('movestart')
+ .fire('dragstart');
},
- _updateImperial: function (maxMeters) {
- var maxFeet = maxMeters * 3.2808399,
- maxMiles, miles, feet;
-
- if (maxFeet > 5280) {
- maxMiles = maxFeet / 5280;
- miles = this._getRoundNum(maxMiles);
- this._updateScale(this._iScale, miles + ' mi', miles / maxMiles);
+ _onDrag: function (e) {
+ var marker = this._marker,
+ shadow = marker._shadow,
+ iconPos = L.DomUtil.getPosition(marker._icon),
+ latlng = marker._map.layerPointToLatLng(iconPos);
- } else {
- feet = this._getRoundNum(maxFeet);
- this._updateScale(this._iScale, feet + ' ft', feet / maxFeet);
+ // update shadow position
+ if (shadow) {
+ L.DomUtil.setPosition(shadow, iconPos);
}
- },
- _updateScale: function (scale, text, ratio) {
- scale.style.width = Math.round(this.options.maxWidth * ratio) + 'px';
- scale.innerHTML = text;
- },
+ marker._latlng = latlng;
+ e.latlng = latlng;
+ e.oldLatLng = this._oldLatLng;
- _getRoundNum: function (num) {
- var pow10 = Math.pow(10, (Math.floor(num) + '').length - 1),
- d = num / pow10;
+ // @event drag: Event
+ // Fired repeatedly while the user drags the marker.
+ marker
+ .fire('move', e)
+ .fire('drag', e);
+ },
- d = d >= 10 ? 10 :
- d >= 5 ? 5 :
- d >= 3 ? 3 :
- d >= 2 ? 2 : 1;
+ _onDragEnd: function (e) {
+ // @event dragend: DragEndEvent
+ // Fired when the user stops dragging the marker.
- return pow10 * d;
+ // @event moveend: Event
+ // Fired when the marker stops moving (because of dragging).
+ delete this._oldLatLng;
+ this._marker
+ .fire('moveend')
+ .fire('dragend', e);
}
});
-// @factory L.control.scale(options?: Control.Scale options)
-// Creates an scale control with the given options.
-L.control.scale = function (options) {
- return new L.Control.Scale(options);
-};
-
-
/*
- * @class Control.Layers
- * @aka L.Control.Layers
- * @inherits Control
- *
- * The layers control gives users the ability to switch between different base layers and switch overlays on/off (check out the [detailed example](http://leafletjs.com/examples/layers-control.html)). Extends `Control`.
- *
- * @example
- *
- * ```js
- * var baseLayers = {
- * "Mapbox": mapbox,
- * "OpenStreetMap": osm
- * };
- *
- * var overlays = {
- * "Marker": marker,
- * "Roads": roadsLayer
- * };
- *
- * L.control.layers(baseLayers, overlays).addTo(map);
- * ```
- *
- * The `baseLayers` and `overlays` parameters are object literals with layer names as keys and `Layer` objects as values:
- *
- * ```js
- * {
- * "<someName1>": layer1,
- * "<someName2>": layer2
- * }
- * ```
- *
- * The layer names can contain HTML, which allows you to add additional styling to the items:
+ * @class Control
+ * @aka L.Control
+ * @inherits Class
*
- * ```js
- * {"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}
- * ```
+ * L.Control is a base class for implementing map controls. Handles positioning.
+ * All other controls extend from this class.
*/
-
-L.Control.Layers = L.Control.extend({
+L.Control = L.Class.extend({
// @section
- // @aka Control.Layers options
+ // @aka Control options
options: {
- // @option collapsed: Boolean = true
- // If `true`, the control will be collapsed into an icon and expanded on mouse hover or touch.
- collapsed: true,
- position: 'topright',
-
- // @option autoZIndex: Boolean = true
- // If `true`, the control will assign zIndexes in increasing order to all of its layers so that the order is preserved when switching them on/off.
- autoZIndex: true,
+ // @option position: String = 'topright'
+ // The position of the control (one of the map corners). Possible values are `'topleft'`,
+ // `'topright'`, `'bottomleft'` or `'bottomright'`
+ position: 'topright'
+ },
- // @option hideSingleBase: Boolean = false
- // If `true`, the base layers in the control will be hidden when there is only one.
- hideSingleBase: false
+ initialize: function (options) {
+ L.setOptions(this, options);
},
- initialize: function (baseLayers, overlays, options) {
- L.setOptions(this, options);
+ /* @section
+ * Classes extending L.Control will inherit the following methods:
+ *
+ * @method getPosition: string
+ * Returns the position of the control.
+ */
+ getPosition: function () {
+ return this.options.position;
+ },
- this._layers = [];
- this._lastZIndex = 0;
- this._handlingClick = false;
+ // @method setPosition(position: string): this
+ // Sets the position of the control.
+ setPosition: function (position) {
+ var map = this._map;
- for (var i in baseLayers) {
- this._addLayer(baseLayers[i], i);
+ if (map) {
+ map.removeControl(this);
}
- for (i in overlays) {
- this._addLayer(overlays[i], i, true);
+ this.options.position = position;
+
+ if (map) {
+ map.addControl(this);
}
+
+ return this;
},
- onAdd: function (map) {
- this._initLayout();
- this._update();
+ // @method getContainer: HTMLElement
+ // Returns the HTMLElement that contains the control.
+ getContainer: function () {
+ return this._container;
+ },
+ // @method addTo(map: Map): this
+ // Adds the control to the given map.
+ addTo: function (map) {
+ this.remove();
this._map = map;
- map.on('zoomend', this._checkDisabledLayers, this);
- return this._container;
- },
+ var container = this._container = this.onAdd(map),
+ pos = this.getPosition(),
+ corner = map._controlCorners[pos];
- onRemove: function () {
- this._map.off('zoomend', this._checkDisabledLayers, this);
+ L.DomUtil.addClass(container, 'leaflet-control');
- for (var i = 0; i < this._layers.length; i++) {
- this._layers[i].layer.off('add remove', this._onLayerChange, this);
+ if (pos.indexOf('bottom') !== -1) {
+ corner.insertBefore(container, corner.firstChild);
+ } else {
+ corner.appendChild(container);
}
- },
- // @method addBaseLayer(layer: Layer, name: String): this
- // Adds a base layer (radio button entry) with the given name to the control.
- addBaseLayer: function (layer, name) {
- this._addLayer(layer, name);
- return (this._map) ? this._update() : this;
+ return this;
},
- // @method addOverlay(layer: Layer, name: String): this
- // Adds an overlay (checkbox entry) with the given name to the control.
- addOverlay: function (layer, name) {
- this._addLayer(layer, name, true);
- return (this._map) ? this._update() : this;
- },
+ // @method remove: this
+ // Removes the control from the map it is currently active on.
+ remove: function () {
+ if (!this._map) {
+ return this;
+ }
- // @method removeLayer(layer: Layer): this
- // Remove the given layer from the control.
- removeLayer: function (layer) {
- layer.off('add remove', this._onLayerChange, this);
+ L.DomUtil.remove(this._container);
- var obj = this._getLayer(L.stamp(layer));
- if (obj) {
- this._layers.splice(this._layers.indexOf(obj), 1);
+ if (this.onRemove) {
+ this.onRemove(this._map);
}
- return (this._map) ? this._update() : this;
+
+ this._map = null;
+
+ return this;
},
- // @method expand(): this
- // Expand the control container if collapsed.
- expand: function () {
- L.DomUtil.addClass(this._container, 'leaflet-control-layers-expanded');
- this._form.style.height = null;
- var acceptableHeight = this._map.getSize().y - (this._container.offsetTop + 50);
- if (acceptableHeight < this._form.clientHeight) {
- L.DomUtil.addClass(this._form, 'leaflet-control-layers-scrollbar');
- this._form.style.height = acceptableHeight + 'px';
- } else {
- L.DomUtil.removeClass(this._form, 'leaflet-control-layers-scrollbar');
+ _refocusOnMap: function (e) {
+ // if map exists and event is not a keyboard event
+ if (this._map && e && e.screenX > 0 && e.screenY > 0) {
+ this._map.getContainer().focus();
}
- this._checkDisabledLayers();
+ }
+});
+
+L.control = function (options) {
+ return new L.Control(options);
+};
+
+/* @section Extension methods
+ * @uninheritable
+ *
+ * Every control should extend from `L.Control` and (re-)implement the following methods.
+ *
+ * @method onAdd(map: Map): HTMLElement
+ * Should return the container DOM element for the control and add listeners on relevant map events. Called on [`control.addTo(map)`](#control-addTo).
+ *
+ * @method onRemove(map: Map)
+ * Optional method. Should contain all clean up code that removes the listeners previously added in [`onAdd`](#control-onadd). Called on [`control.remove()`](#control-remove).
+ */
+
+/* @namespace Map
+ * @section Methods for Layers and Controls
+ */
+L.Map.include({
+ // @method addControl(control: Control): this
+ // Adds the given control to the map
+ addControl: function (control) {
+ control.addTo(this);
return this;
},
- // @method collapse(): this
- // Collapse the control container if expanded.
- collapse: function () {
- L.DomUtil.removeClass(this._container, 'leaflet-control-layers-expanded');
+ // @method removeControl(control: Control): this
+ // Removes the given control from the map
+ removeControl: function (control) {
+ control.remove();
return this;
},
- _initLayout: function () {
- var className = 'leaflet-control-layers',
- container = this._container = L.DomUtil.create('div', className);
+ _initControlPos: function () {
+ var corners = this._controlCorners = {},
+ l = 'leaflet-',
+ container = this._controlContainer =
+ L.DomUtil.create('div', l + 'control-container', this._container);
- // makes this work on IE touch devices by stopping it from firing a mouseout event when the touch is released
- container.setAttribute('aria-haspopup', true);
+ function createCorner(vSide, hSide) {
+ var className = l + vSide + ' ' + l + hSide;
- L.DomEvent.disableClickPropagation(container);
- if (!L.Browser.touch) {
- L.DomEvent.disableScrollPropagation(container);
+ corners[vSide + hSide] = L.DomUtil.create('div', className, container);
}
- var form = this._form = L.DomUtil.create('form', className + '-list');
-
- if (this.options.collapsed) {
- if (!L.Browser.android) {
- L.DomEvent.on(container, {
- mouseenter: this.expand,
- mouseleave: this.collapse
- }, this);
- }
-
- var link = this._layersLink = L.DomUtil.create('a', className + '-toggle', container);
- link.href = '#';
- link.title = 'Layers';
-
- if (L.Browser.touch) {
- L.DomEvent
- .on(link, 'click', L.DomEvent.stop)
- .on(link, 'click', this.expand, this);
- } else {
- L.DomEvent.on(link, 'focus', this.expand, this);
- }
+ createCorner('top', 'left');
+ createCorner('top', 'right');
+ createCorner('bottom', 'left');
+ createCorner('bottom', 'right');
+ },
- // work around for Firefox Android issue https://github.com/Leaflet/Leaflet/issues/2033
- L.DomEvent.on(form, 'click', function () {
- setTimeout(L.bind(this._onInputClick, this), 0);
- }, this);
+ _clearControlPos: function () {
+ L.DomUtil.remove(this._controlContainer);
+ }
+});
- this._map.on('click', this.collapse, this);
- // TODO keyboard accessibility
- } else {
- this.expand();
- }
- this._baseLayersList = L.DomUtil.create('div', className + '-base', form);
- this._separator = L.DomUtil.create('div', className + '-separator', form);
- this._overlaysList = L.DomUtil.create('div', className + '-overlays', form);
- container.appendChild(form);
- },
+/*
+ * @class Control.Zoom
+ * @aka L.Control.Zoom
+ * @inherits Control
+ *
+ * A basic zoom control with two buttons (zoom in and zoom out). It is put on the map by default unless you set its [`zoomControl` option](#map-zoomcontrol) to `false`. Extends `Control`.
+ */
- _getLayer: function (id) {
- for (var i = 0; i < this._layers.length; i++) {
+L.Control.Zoom = L.Control.extend({
+ // @section
+ // @aka Control.Zoom options
+ options: {
+ position: 'topleft',
- if (this._layers[i] && L.stamp(this._layers[i].layer) === id) {
- return this._layers[i];
- }
- }
- },
+ // @option zoomInText: String = '+'
+ // The text set on the 'zoom in' button.
+ zoomInText: '+',
- _addLayer: function (layer, name, overlay) {
- layer.on('add remove', this._onLayerChange, this);
+ // @option zoomInTitle: String = 'Zoom in'
+ // The title set on the 'zoom in' button.
+ zoomInTitle: 'Zoom in',
- this._layers.push({
- layer: layer,
- name: name,
- overlay: overlay
- });
+ // @option zoomOutText: String = '-'
+ // The text set on the 'zoom out' button.
+ zoomOutText: '-',
- if (this.options.autoZIndex && layer.setZIndex) {
- this._lastZIndex++;
- layer.setZIndex(this._lastZIndex);
- }
+ // @option zoomOutTitle: String = 'Zoom out'
+ // The title set on the 'zoom out' button.
+ zoomOutTitle: 'Zoom out'
},
- _update: function () {
- if (!this._container) { return this; }
-
- L.DomUtil.empty(this._baseLayersList);
- L.DomUtil.empty(this._overlaysList);
+ onAdd: function (map) {
+ var zoomName = 'leaflet-control-zoom',
+ container = L.DomUtil.create('div', zoomName + ' leaflet-bar'),
+ options = this.options;
- var baseLayersPresent, overlaysPresent, i, obj, baseLayersCount = 0;
+ this._zoomInButton = this._createButton(options.zoomInText, options.zoomInTitle,
+ zoomName + '-in', container, this._zoomIn);
+ this._zoomOutButton = this._createButton(options.zoomOutText, options.zoomOutTitle,
+ zoomName + '-out', container, this._zoomOut);
- for (i = 0; i < this._layers.length; i++) {
- obj = this._layers[i];
- this._addItem(obj);
- overlaysPresent = overlaysPresent || obj.overlay;
- baseLayersPresent = baseLayersPresent || !obj.overlay;
- baseLayersCount += !obj.overlay ? 1 : 0;
- }
+ this._updateDisabled();
+ map.on('zoomend zoomlevelschange', this._updateDisabled, this);
- // Hide base layers section if there's only one layer.
- if (this.options.hideSingleBase) {
- baseLayersPresent = baseLayersPresent && baseLayersCount > 1;
- this._baseLayersList.style.display = baseLayersPresent ? '' : 'none';
- }
+ return container;
+ },
- this._separator.style.display = overlaysPresent && baseLayersPresent ? '' : 'none';
+ onRemove: function (map) {
+ map.off('zoomend zoomlevelschange', this._updateDisabled, this);
+ },
+ disable: function () {
+ this._disabled = true;
+ this._updateDisabled();
return this;
},
- _onLayerChange: function (e) {
- if (!this._handlingClick) {
- this._update();
- }
-
- var obj = this._getLayer(L.stamp(e.target));
+ enable: function () {
+ this._disabled = false;
+ this._updateDisabled();
+ return this;
+ },
- // @namespace Map
- // @section Layer events
- // @event baselayerchange: LayersControlEvent
- // Fired when the base layer is changed through the [layer control](#control-layers).
- // @event overlayadd: LayersControlEvent
- // Fired when an overlay is selected through the [layer control](#control-layers).
- // @event overlayremove: LayersControlEvent
- // Fired when an overlay is deselected through the [layer control](#control-layers).
- // @namespace Control.Layers
- var type = obj.overlay ?
- (e.type === 'add' ? 'overlayadd' : 'overlayremove') :
- (e.type === 'add' ? 'baselayerchange' : null);
+ _zoomIn: function (e) {
+ if (!this._disabled && this._map._zoom < this._map.getMaxZoom()) {
+ this._map.zoomIn(this._map.options.zoomDelta * (e.shiftKey ? 3 : 1));
+ }
+ },
- if (type) {
- this._map.fire(type, obj);
+ _zoomOut: function (e) {
+ if (!this._disabled && this._map._zoom > this._map.getMinZoom()) {
+ this._map.zoomOut(this._map.options.zoomDelta * (e.shiftKey ? 3 : 1));
}
},
- // IE7 bugs out if you create a radio dynamically, so you have to do it this hacky way (see http://bit.ly/PqYLBe)
- _createRadioElement: function (name, checked) {
+ _createButton: function (html, title, className, container, fn) {
+ var link = L.DomUtil.create('a', className, container);
+ link.innerHTML = html;
+ link.href = '#';
+ link.title = title;
- var radioHtml = '<input type="radio" class="leaflet-control-layers-selector" name="' +
- name + '"' + (checked ? ' checked="checked"' : '') + '/>';
+ /*
+ * Will force screen readers like VoiceOver to read this as "Zoom in - button"
+ */
+ link.setAttribute('role', 'button');
+ link.setAttribute('aria-label', title);
- var radioFragment = document.createElement('div');
- radioFragment.innerHTML = radioHtml;
+ L.DomEvent
+ .on(link, 'mousedown dblclick', L.DomEvent.stopPropagation)
+ .on(link, 'click', L.DomEvent.stop)
+ .on(link, 'click', fn, this)
+ .on(link, 'click', this._refocusOnMap, this);
- return radioFragment.firstChild;
+ return link;
},
- _addItem: function (obj) {
- var label = document.createElement('label'),
- checked = this._map.hasLayer(obj.layer),
- input;
+ _updateDisabled: function () {
+ var map = this._map,
+ className = 'leaflet-disabled';
- if (obj.overlay) {
- input = document.createElement('input');
- input.type = 'checkbox';
- input.className = 'leaflet-control-layers-selector';
- input.defaultChecked = checked;
- } else {
- input = this._createRadioElement('leaflet-base-layers', checked);
- }
+ L.DomUtil.removeClass(this._zoomInButton, className);
+ L.DomUtil.removeClass(this._zoomOutButton, className);
- input.layerId = L.stamp(obj.layer);
+ if (this._disabled || map._zoom === map.getMinZoom()) {
+ L.DomUtil.addClass(this._zoomOutButton, className);
+ }
+ if (this._disabled || map._zoom === map.getMaxZoom()) {
+ L.DomUtil.addClass(this._zoomInButton, className);
+ }
+ }
+});
- L.DomEvent.on(input, 'click', this._onInputClick, this);
+// @namespace Map
+// @section Control options
+// @option zoomControl: Boolean = true
+// Whether a [zoom control](#control-zoom) is added to the map by default.
+L.Map.mergeOptions({
+ zoomControl: true
+});
- var name = document.createElement('span');
- name.innerHTML = ' ' + obj.name;
+L.Map.addInitHook(function () {
+ if (this.options.zoomControl) {
+ this.zoomControl = new L.Control.Zoom();
+ this.addControl(this.zoomControl);
+ }
+});
- // Helps from preventing layer control flicker when checkboxes are disabled
- // https://github.com/Leaflet/Leaflet/issues/2771
- var holder = document.createElement('div');
+// @namespace Control.Zoom
+// @factory L.control.zoom(options: Control.Zoom options)
+// Creates a zoom control
+L.control.zoom = function (options) {
+ return new L.Control.Zoom(options);
+};
- label.appendChild(holder);
- holder.appendChild(input);
- holder.appendChild(name);
- var container = obj.overlay ? this._overlaysList : this._baseLayersList;
- container.appendChild(label);
- this._checkDisabledLayers();
- return label;
- },
+/*
+ * @class Control.Attribution
+ * @aka L.Control.Attribution
+ * @inherits Control
+ *
+ * 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.
+ */
- _onInputClick: function () {
- var inputs = this._form.getElementsByTagName('input'),
- input, layer, hasLayer;
- var addedLayers = [],
- removedLayers = [];
+L.Control.Attribution = L.Control.extend({
+ // @section
+ // @aka Control.Attribution options
+ options: {
+ position: 'bottomright',
- this._handlingClick = true;
+ // @option prefix: String = 'Leaflet'
+ // The HTML text shown before the attributions. Pass `false` to disable.
+ prefix: '<a href="http://leafletjs.com" title="A JS library for interactive maps">Leaflet</a>'
+ },
- for (var i = inputs.length - 1; i >= 0; i--) {
- input = inputs[i];
- layer = this._getLayer(input.layerId).layer;
- hasLayer = this._map.hasLayer(layer);
+ initialize: function (options) {
+ L.setOptions(this, options);
- if (input.checked && !hasLayer) {
- addedLayers.push(layer);
+ this._attributions = {};
+ },
- } else if (!input.checked && hasLayer) {
- removedLayers.push(layer);
- }
+ onAdd: function (map) {
+ map.attributionControl = this;
+ this._container = L.DomUtil.create('div', 'leaflet-control-attribution');
+ if (L.DomEvent) {
+ L.DomEvent.disableClickPropagation(this._container);
}
- // Bugfix issue 2318: Should remove all old layers before readding new ones
- for (i = 0; i < removedLayers.length; i++) {
- this._map.removeLayer(removedLayers[i]);
- }
- for (i = 0; i < addedLayers.length; i++) {
- this._map.addLayer(addedLayers[i]);
+ // TODO ugly, refactor
+ for (var i in map._layers) {
+ if (map._layers[i].getAttribution) {
+ this.addAttribution(map._layers[i].getAttribution());
+ }
}
- this._handlingClick = false;
+ this._update();
- this._refocusOnMap();
+ return this._container;
},
- _checkDisabledLayers: function () {
- var inputs = this._form.getElementsByTagName('input'),
- input,
- layer,
- zoom = this._map.getZoom();
+ // @method setPrefix(prefix: String): this
+ // Sets the text before the attributions.
+ setPrefix: function (prefix) {
+ this.options.prefix = prefix;
+ this._update();
+ return this;
+ },
- for (var i = inputs.length - 1; i >= 0; i--) {
- input = inputs[i];
- layer = this._getLayer(input.layerId).layer;
- input.disabled = (layer.options.minZoom !== undefined && zoom < layer.options.minZoom) ||
- (layer.options.maxZoom !== undefined && zoom > layer.options.maxZoom);
+ // @method addAttribution(text: String): this
+ // Adds an attribution text (e.g. `'Vector data © Mapbox'`).
+ addAttribution: function (text) {
+ if (!text) { return this; }
+ if (!this._attributions[text]) {
+ this._attributions[text] = 0;
}
+ this._attributions[text]++;
+
+ this._update();
+
+ return this;
},
- _expand: function () {
- // Backward compatibility, remove me in 1.1.
- return this.expand();
+ // @method removeAttribution(text: String): this
+ // Removes an attribution text.
+ removeAttribution: function (text) {
+ if (!text) { return this; }
+
+ if (this._attributions[text]) {
+ this._attributions[text]--;
+ this._update();
+ }
+
+ return this;
},
- _collapse: function () {
- // Backward compatibility, remove me in 1.1.
- return this.collapse();
- }
+ _update: function () {
+ if (!this._map) { return; }
+
+ var attribs = [];
+
+ for (var i in this._attributions) {
+ if (this._attributions[i]) {
+ attribs.push(i);
+ }
+ }
+
+ var prefixAndAttribs = [];
+
+ if (this.options.prefix) {
+ prefixAndAttribs.push(this.options.prefix);
+ }
+ if (attribs.length) {
+ prefixAndAttribs.push(attribs.join(', '));
+ }
+ this._container.innerHTML = prefixAndAttribs.join(' | ');
+ }
});
+// @namespace Map
+// @section Control options
+// @option attributionControl: Boolean = true
+// Whether a [attribution control](#control-attribution) is added to the map by default.
+L.Map.mergeOptions({
+ attributionControl: true
+});
-// @factory L.control.layers(baselayers?: Object, overlays?: Object, options?: Control.Layers options)
-// Creates an attribution control with the given layers. Base layers will be switched with radio buttons, while overlays will be switched with checkboxes. Note that all base layers should be passed in the base layers object, but only one should be added to the map during map instantiation.
-L.control.layers = function (baseLayers, overlays, options) {
- return new L.Control.Layers(baseLayers, overlays, options);
+L.Map.addInitHook(function () {
+ if (this.options.attributionControl) {
+ new L.Control.Attribution().addTo(this);
+ }
+});
+
+// @namespace Control.Attribution
+// @factory L.control.attribution(options: Control.Attribution options)
+// Creates an attribution control.
+L.control.attribution = function (options) {
+ return new L.Control.Attribution(options);
};
/*
- * @class PosAnimation
- * @aka L.PosAnimation
- * @inherits Evented
- * Used internally for panning animations, utilizing CSS3 Transitions for modern browsers and a timer fallback for IE6-9.
+ * @class Control.Scale
+ * @aka L.Control.Scale
+ * @inherits Control
+ *
+ * A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems. Extends `Control`.
*
* @example
+ *
* ```js
- * var fx = new L.PosAnimation();
- * fx.run(el, [300, 500], 0.5);
+ * L.control.scale().addTo(map);
* ```
- *
- * @constructor L.PosAnimation()
- * Creates a `PosAnimation` object.
- *
*/
-L.PosAnimation = L.Evented.extend({
-
- // @method run(el: HTMLElement, newPos: Point, duration?: Number, easeLinearity?: Number)
- // Run an animation of a given element to a new position, optionally setting
- // duration in seconds (`0.25` by default) and easing linearity factor (3rd
- // argument of the [cubic bezier curve](http://cubic-bezier.com/#0,0,.5,1),
- // `0.5` by default).
- run: function (el, newPos, duration, easeLinearity) {
- this.stop();
+L.Control.Scale = L.Control.extend({
+ // @section
+ // @aka Control.Scale options
+ options: {
+ position: 'bottomleft',
- this._el = el;
- this._inProgress = true;
- this._duration = duration || 0.25;
- this._easeOutPower = 1 / Math.max(easeLinearity || 0.5, 0.2);
+ // @option maxWidth: Number = 100
+ // Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500).
+ maxWidth: 100,
- this._startPos = L.DomUtil.getPosition(el);
- this._offset = newPos.subtract(this._startPos);
- this._startTime = +new Date();
+ // @option metric: Boolean = True
+ // Whether to show the metric scale line (m/km).
+ metric: true,
- // @event start: Event
- // Fired when the animation starts
- this.fire('start');
+ // @option imperial: Boolean = True
+ // Whether to show the imperial scale line (mi/ft).
+ imperial: true
- this._animate();
+ // @option updateWhenIdle: Boolean = false
+ // If `true`, the control is updated on [`moveend`](#map-moveend), otherwise it's always up-to-date (updated on [`move`](#map-move)).
},
- // @method stop()
- // Stops the animation (if currently running).
- stop: function () {
- if (!this._inProgress) { return; }
-
- this._step(true);
- this._complete();
- },
+ onAdd: function (map) {
+ var className = 'leaflet-control-scale',
+ container = L.DomUtil.create('div', className),
+ options = this.options;
- _animate: function () {
- // animation loop
- this._animId = L.Util.requestAnimFrame(this._animate, this);
- this._step();
- },
+ this._addScales(options, className + '-line', container);
- _step: function (round) {
- var elapsed = (+new Date()) - this._startTime,
- duration = this._duration * 1000;
+ map.on(options.updateWhenIdle ? 'moveend' : 'move', this._update, this);
+ map.whenReady(this._update, this);
- if (elapsed < duration) {
- this._runFrame(this._easeOut(elapsed / duration), round);
- } else {
- this._runFrame(1);
- this._complete();
- }
+ return container;
},
- _runFrame: function (progress, round) {
- var pos = this._startPos.add(this._offset.multiplyBy(progress));
- if (round) {
- pos._round();
- }
- L.DomUtil.setPosition(this._el, pos);
-
- // @event step: Event
- // Fired continuously during the animation.
- this.fire('step');
+ onRemove: function (map) {
+ map.off(this.options.updateWhenIdle ? 'moveend' : 'move', this._update, this);
},
- _complete: function () {
- L.Util.cancelAnimFrame(this._animId);
-
- this._inProgress = false;
- // @event end: Event
- // Fired when the animation ends.
- this.fire('end');
+ _addScales: function (options, className, container) {
+ if (options.metric) {
+ this._mScale = L.DomUtil.create('div', className, container);
+ }
+ if (options.imperial) {
+ this._iScale = L.DomUtil.create('div', className, container);
+ }
},
- _easeOut: function (t) {
- return 1 - Math.pow(1 - t, this._easeOutPower);
- }
-});
-
-
-
-/*
- * Extends L.Map to handle panning animations.
- */
+ _update: function () {
+ var map = this._map,
+ y = map.getSize().y / 2;
-L.Map.include({
+ var maxMeters = map.distance(
+ map.containerPointToLatLng([0, y]),
+ map.containerPointToLatLng([this.options.maxWidth, y]));
- setView: function (center, zoom, options) {
+ this._updateScales(maxMeters);
+ },
- zoom = zoom === undefined ? this._zoom : this._limitZoom(zoom);
- center = this._limitCenter(L.latLng(center), zoom, this.options.maxBounds);
- options = options || {};
+ _updateScales: function (maxMeters) {
+ if (this.options.metric && maxMeters) {
+ this._updateMetric(maxMeters);
+ }
+ if (this.options.imperial && maxMeters) {
+ this._updateImperial(maxMeters);
+ }
+ },
- this._stop();
+ _updateMetric: function (maxMeters) {
+ var meters = this._getRoundNum(maxMeters),
+ label = meters < 1000 ? meters + ' m' : (meters / 1000) + ' km';
- if (this._loaded && !options.reset && options !== true) {
+ this._updateScale(this._mScale, label, meters / maxMeters);
+ },
- if (options.animate !== undefined) {
- options.zoom = L.extend({animate: options.animate}, options.zoom);
- options.pan = L.extend({animate: options.animate, duration: options.duration}, options.pan);
- }
+ _updateImperial: function (maxMeters) {
+ var maxFeet = maxMeters * 3.2808399,
+ maxMiles, miles, feet;
- // try animating pan or zoom
- var moved = (this._zoom !== zoom) ?
- this._tryAnimatedZoom && this._tryAnimatedZoom(center, zoom, options.zoom) :
- this._tryAnimatedPan(center, options.pan);
+ if (maxFeet > 5280) {
+ maxMiles = maxFeet / 5280;
+ miles = this._getRoundNum(maxMiles);
+ this._updateScale(this._iScale, miles + ' mi', miles / maxMiles);
- if (moved) {
- // prevent resize handler call, the view will refresh after animation anyway
- clearTimeout(this._sizeTimer);
- return this;
- }
+ } else {
+ feet = this._getRoundNum(maxFeet);
+ this._updateScale(this._iScale, feet + ' ft', feet / maxFeet);
}
-
- // animation didn't start, just reset the map view
- this._resetView(center, zoom);
-
- return this;
},
- panBy: function (offset, options) {
- offset = L.point(offset).round();
- options = options || {};
+ _updateScale: function (scale, text, ratio) {
+ scale.style.width = Math.round(this.options.maxWidth * ratio) + 'px';
+ scale.innerHTML = text;
+ },
- if (!offset.x && !offset.y) {
- return this.fire('moveend');
- }
- // If we pan too far, Chrome gets issues with tiles
- // and makes them disappear or appear in the wrong place (slightly offset) #2602
- if (options.animate !== true && !this.getSize().contains(offset)) {
- this._resetView(this.unproject(this.project(this.getCenter()).add(offset)), this.getZoom());
- return this;
- }
+ _getRoundNum: function (num) {
+ var pow10 = Math.pow(10, (Math.floor(num) + '').length - 1),
+ d = num / pow10;
- if (!this._panAnim) {
- this._panAnim = new L.PosAnimation();
+ d = d >= 10 ? 10 :
+ d >= 5 ? 5 :
+ d >= 3 ? 3 :
+ d >= 2 ? 2 : 1;
- this._panAnim.on({
- 'step': this._onPanTransitionStep,
- 'end': this._onPanTransitionEnd
- }, this);
- }
+ return pow10 * d;
+ }
+});
- // don't fire movestart if animating inertia
- if (!options.noMoveStart) {
- this.fire('movestart');
- }
- // animate pan unless animate: false specified
- if (options.animate !== false) {
- L.DomUtil.addClass(this._mapPane, 'leaflet-pan-anim');
+// @factory L.control.scale(options?: Control.Scale options)
+// Creates an scale control with the given options.
+L.control.scale = function (options) {
+ return new L.Control.Scale(options);
+};
- var newPos = this._getMapPanePos().subtract(offset).round();
- this._panAnim.run(this._mapPane, newPos, options.duration || 0.25, options.easeLinearity);
- } else {
- this._rawPanBy(offset);
- this.fire('move').fire('moveend');
- }
- return this;
- },
- _onPanTransitionStep: function () {
- this.fire('move');
- },
+/*
+ * @class Control.Layers
+ * @aka L.Control.Layers
+ * @inherits Control
+ *
+ * The layers control gives users the ability to switch between different base layers and switch overlays on/off (check out the [detailed example](http://leafletjs.com/examples/layers-control.html)). Extends `Control`.
+ *
+ * @example
+ *
+ * ```js
+ * var baseLayers = {
+ * "Mapbox": mapbox,
+ * "OpenStreetMap": osm
+ * };
+ *
+ * var overlays = {
+ * "Marker": marker,
+ * "Roads": roadsLayer
+ * };
+ *
+ * L.control.layers(baseLayers, overlays).addTo(map);
+ * ```
+ *
+ * The `baseLayers` and `overlays` parameters are object literals with layer names as keys and `Layer` objects as values:
+ *
+ * ```js
+ * {
+ * "<someName1>": layer1,
+ * "<someName2>": layer2
+ * }
+ * ```
+ *
+ * The layer names can contain HTML, which allows you to add additional styling to the items:
+ *
+ * ```js
+ * {"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}
+ * ```
+ */
- _onPanTransitionEnd: function () {
- L.DomUtil.removeClass(this._mapPane, 'leaflet-pan-anim');
- this.fire('moveend');
- },
- _tryAnimatedPan: function (center, options) {
- // difference between the new and current centers in pixels
- var offset = this._getCenterOffset(center)._floor();
+L.Control.Layers = L.Control.extend({
+ // @section
+ // @aka Control.Layers options
+ options: {
+ // @option collapsed: Boolean = true
+ // If `true`, the control will be collapsed into an icon and expanded on mouse hover or touch.
+ collapsed: true,
+ position: 'topright',
- // don't animate too far unless animate: true specified in options
- if ((options && options.animate) !== true && !this.getSize().contains(offset)) { return false; }
+ // @option autoZIndex: Boolean = true
+ // If `true`, the control will assign zIndexes in increasing order to all of its layers so that the order is preserved when switching them on/off.
+ autoZIndex: true,
- this.panBy(offset, options);
+ // @option hideSingleBase: Boolean = false
+ // If `true`, the base layers in the control will be hidden when there is only one.
+ hideSingleBase: false,
- return true;
- }
-});
+ // @option sortLayers: Boolean = false
+ // Whether to sort the layers. When `false`, layers will keep the order
+ // in which they were added to the control.
+ sortLayers: false,
+ // @option sortFunction: Function = *
+ // A [compare function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/sort)
+ // that will be used for sorting the layers, when `sortLayers` is `true`.
+ // The function receives both the `L.Layer` instances and their names, as in
+ // `sortFunction(layerA, layerB, nameA, nameB)`.
+ // By default, it sorts layers alphabetically by their name.
+ sortFunction: function (layerA, layerB, nameA, nameB) {
+ return nameA < nameB ? -1 : (nameB < nameA ? 1 : 0);
+ }
+ },
+ initialize: function (baseLayers, overlays, options) {
+ L.setOptions(this, options);
-/*
- * Extends L.Map to handle zoom animations.
- */
+ this._layers = [];
+ this._lastZIndex = 0;
+ this._handlingClick = false;
-// @namespace Map
-// @section Animation Options
-L.Map.mergeOptions({
- // @option zoomAnimation: Boolean = true
- // Whether the map zoom animation is enabled. By default it's enabled
- // in all browsers that support CSS3 Transitions except Android.
- zoomAnimation: true,
-
- // @option zoomAnimationThreshold: Number = 4
- // Won't animate zoom if the zoom difference exceeds this value.
- zoomAnimationThreshold: 4
-});
+ for (var i in baseLayers) {
+ this._addLayer(baseLayers[i], i);
+ }
-var zoomAnimated = L.DomUtil.TRANSITION && L.Browser.any3d && !L.Browser.mobileOpera;
+ for (i in overlays) {
+ this._addLayer(overlays[i], i, true);
+ }
+ },
-if (zoomAnimated) {
+ onAdd: function (map) {
+ this._initLayout();
+ this._update();
- L.Map.addInitHook(function () {
- // don't animate on browsers without hardware-accelerated transitions or old Android/Opera
- this._zoomAnimated = this.options.zoomAnimation;
+ this._map = map;
+ map.on('zoomend', this._checkDisabledLayers, this);
- // zoom transitions run with the same duration for all layers, so if one of transitionend events
- // happens after starting zoom animation (propagating to the map pane), we know that it ended globally
- if (this._zoomAnimated) {
+ return this._container;
+ },
- this._createAnimProxy();
+ onRemove: function () {
+ this._map.off('zoomend', this._checkDisabledLayers, this);
- L.DomEvent.on(this._proxy, L.DomUtil.TRANSITION_END, this._catchTransitionEnd, this);
+ for (var i = 0; i < this._layers.length; i++) {
+ this._layers[i].layer.off('add remove', this._onLayerChange, this);
}
- });
-}
-
-L.Map.include(!zoomAnimated ? {} : {
-
- _createAnimProxy: function () {
-
- var proxy = this._proxy = L.DomUtil.create('div', 'leaflet-proxy leaflet-zoom-animated');
- this._panes.mapPane.appendChild(proxy);
+ },
- this.on('zoomanim', function (e) {
- var prop = L.DomUtil.TRANSFORM,
- transform = proxy.style[prop];
+ // @method addBaseLayer(layer: Layer, name: String): this
+ // Adds a base layer (radio button entry) with the given name to the control.
+ addBaseLayer: function (layer, name) {
+ this._addLayer(layer, name);
+ return (this._map) ? this._update() : this;
+ },
- L.DomUtil.setTransform(proxy, this.project(e.center, e.zoom), this.getZoomScale(e.zoom, 1));
+ // @method addOverlay(layer: Layer, name: String): this
+ // Adds an overlay (checkbox entry) with the given name to the control.
+ addOverlay: function (layer, name) {
+ this._addLayer(layer, name, true);
+ return (this._map) ? this._update() : this;
+ },
- // workaround for case when transform is the same and so transitionend event is not fired
- if (transform === proxy.style[prop] && this._animatingZoom) {
- this._onZoomTransitionEnd();
- }
- }, this);
+ // @method removeLayer(layer: Layer): this
+ // Remove the given layer from the control.
+ removeLayer: function (layer) {
+ layer.off('add remove', this._onLayerChange, this);
- this.on('load moveend', function () {
- var c = this.getCenter(),
- z = this.getZoom();
- L.DomUtil.setTransform(proxy, this.project(c, z), this.getZoomScale(z, 1));
- }, this);
+ var obj = this._getLayer(L.stamp(layer));
+ if (obj) {
+ this._layers.splice(this._layers.indexOf(obj), 1);
+ }
+ return (this._map) ? this._update() : this;
},
- _catchTransitionEnd: function (e) {
- if (this._animatingZoom && e.propertyName.indexOf('transform') >= 0) {
- this._onZoomTransitionEnd();
+ // @method expand(): this
+ // Expand the control container if collapsed.
+ expand: function () {
+ L.DomUtil.addClass(this._container, 'leaflet-control-layers-expanded');
+ this._form.style.height = null;
+ var acceptableHeight = this._map.getSize().y - (this._container.offsetTop + 50);
+ if (acceptableHeight < this._form.clientHeight) {
+ L.DomUtil.addClass(this._form, 'leaflet-control-layers-scrollbar');
+ this._form.style.height = acceptableHeight + 'px';
+ } else {
+ L.DomUtil.removeClass(this._form, 'leaflet-control-layers-scrollbar');
}
+ this._checkDisabledLayers();
+ return this;
},
- _nothingToAnimate: function () {
- return !this._container.getElementsByClassName('leaflet-zoom-animated').length;
+ // @method collapse(): this
+ // Collapse the control container if expanded.
+ collapse: function () {
+ L.DomUtil.removeClass(this._container, 'leaflet-control-layers-expanded');
+ return this;
},
- _tryAnimatedZoom: function (center, zoom, options) {
-
- if (this._animatingZoom) { return true; }
+ _initLayout: function () {
+ var className = 'leaflet-control-layers',
+ container = this._container = L.DomUtil.create('div', className);
- options = options || {};
+ // makes this work on IE touch devices by stopping it from firing a mouseout event when the touch is released
+ container.setAttribute('aria-haspopup', true);
- // don't animate if disabled, not supported or zoom difference is too large
- if (!this._zoomAnimated || options.animate === false || this._nothingToAnimate() ||
- Math.abs(zoom - this._zoom) > this.options.zoomAnimationThreshold) { return false; }
+ L.DomEvent.disableClickPropagation(container);
+ if (!L.Browser.touch) {
+ L.DomEvent.disableScrollPropagation(container);
+ }
- // offset is the pixel coords of the zoom origin relative to the current center
- var scale = this.getZoomScale(zoom),
- offset = this._getCenterOffset(center)._divideBy(1 - 1 / scale);
+ var form = this._form = L.DomUtil.create('form', className + '-list');
- // don't animate if the zoom origin isn't within one screen from the current center, unless forced
- if (options.animate !== true && !this.getSize().contains(offset)) { return false; }
+ if (!L.Browser.android) {
+ L.DomEvent.on(container, {
+ mouseenter: this.expand,
+ mouseleave: this.collapse
+ }, this);
+ }
- L.Util.requestAnimFrame(function () {
- this
- ._moveStart(true)
- ._animateZoom(center, zoom, true);
- }, this);
+ var link = this._layersLink = L.DomUtil.create('a', className + '-toggle', container);
+ link.href = '#';
+ link.title = 'Layers';
- return true;
- },
+ if (L.Browser.touch) {
+ L.DomEvent
+ .on(link, 'click', L.DomEvent.stop)
+ .on(link, 'click', this.expand, this);
+ } else {
+ L.DomEvent.on(link, 'focus', this.expand, this);
+ }
- _animateZoom: function (center, zoom, startAnim, noUpdate) {
- if (startAnim) {
- this._animatingZoom = true;
+ // work around for Firefox Android issue https://github.com/Leaflet/Leaflet/issues/2033
+ L.DomEvent.on(form, 'click', function () {
+ setTimeout(L.bind(this._onInputClick, this), 0);
+ }, this);
- // remember what center/zoom to set after animation
- this._animateToCenter = center;
- this._animateToZoom = zoom;
+ this._map.on('click', this.collapse, this);
+ // TODO keyboard accessibility
- L.DomUtil.addClass(this._mapPane, 'leaflet-zoom-anim');
+ if (!this.options.collapsed) {
+ this.expand();
}
- // @event zoomanim: ZoomAnimEvent
- // Fired on every frame of a zoom animation
- this.fire('zoomanim', {
- center: center,
- zoom: zoom,
- noUpdate: noUpdate
- });
+ this._baseLayersList = L.DomUtil.create('div', className + '-base', form);
+ this._separator = L.DomUtil.create('div', className + '-separator', form);
+ this._overlaysList = L.DomUtil.create('div', className + '-overlays', form);
- // Work around webkit not firing 'transitionend', see https://github.com/Leaflet/Leaflet/issues/3689, 2693
- setTimeout(L.bind(this._onZoomTransitionEnd, this), 250);
+ container.appendChild(form);
},
- _onZoomTransitionEnd: function () {
- if (!this._animatingZoom) { return; }
-
- L.DomUtil.removeClass(this._mapPane, 'leaflet-zoom-anim');
-
- this._animatingZoom = false;
-
- this._move(this._animateToCenter, this._animateToZoom);
-
- // This anim frame should prevent an obscure iOS webkit tile loading race condition.
- L.Util.requestAnimFrame(function () {
- this._moveEnd(true);
- }, this);
- }
-});
+ _getLayer: function (id) {
+ for (var i = 0; i < this._layers.length; i++) {
+ if (this._layers[i] && L.stamp(this._layers[i].layer) === id) {
+ return this._layers[i];
+ }
+ }
+ },
+ _addLayer: function (layer, name, overlay) {
+ layer.on('add remove', this._onLayerChange, this);
-// @namespace Map
-// @section Methods for modifying map state
-L.Map.include({
+ this._layers.push({
+ layer: layer,
+ name: name,
+ overlay: overlay
+ });
- // @method flyTo(latlng: LatLng, zoom?: Number, options?: Zoom/pan options): this
- // Sets the view of the map (geographical center and zoom) performing a smooth
- // pan-zoom animation.
- flyTo: function (targetCenter, targetZoom, options) {
+ if (this.options.sortLayers) {
+ this._layers.sort(L.bind(function (a, b) {
+ return this.options.sortFunction(a.layer, b.layer, a.name, b.name);
+ }, this));
+ }
- options = options || {};
- if (options.animate === false || !L.Browser.any3d) {
- return this.setView(targetCenter, targetZoom, options);
+ if (this.options.autoZIndex && layer.setZIndex) {
+ this._lastZIndex++;
+ layer.setZIndex(this._lastZIndex);
}
+ },
- this._stop();
+ _update: function () {
+ if (!this._container) { return this; }
- var from = this.project(this.getCenter()),
- to = this.project(targetCenter),
- size = this.getSize(),
- startZoom = this._zoom;
+ L.DomUtil.empty(this._baseLayersList);
+ L.DomUtil.empty(this._overlaysList);
- targetCenter = L.latLng(targetCenter);
- targetZoom = targetZoom === undefined ? startZoom : targetZoom;
+ var baseLayersPresent, overlaysPresent, i, obj, baseLayersCount = 0;
- var w0 = Math.max(size.x, size.y),
- w1 = w0 * this.getZoomScale(startZoom, targetZoom),
- u1 = (to.distanceTo(from)) || 1,
- rho = 1.42,
- rho2 = rho * rho;
+ for (i = 0; i < this._layers.length; i++) {
+ obj = this._layers[i];
+ this._addItem(obj);
+ overlaysPresent = overlaysPresent || obj.overlay;
+ baseLayersPresent = baseLayersPresent || !obj.overlay;
+ baseLayersCount += !obj.overlay ? 1 : 0;
+ }
- function r(i) {
- var s1 = i ? -1 : 1,
- s2 = i ? w1 : w0,
- t1 = w1 * w1 - w0 * w0 + s1 * rho2 * rho2 * u1 * u1,
- b1 = 2 * s2 * rho2 * u1,
- b = t1 / b1,
- sq = Math.sqrt(b * b + 1) - b;
+ // Hide base layers section if there's only one layer.
+ if (this.options.hideSingleBase) {
+ baseLayersPresent = baseLayersPresent && baseLayersCount > 1;
+ this._baseLayersList.style.display = baseLayersPresent ? '' : 'none';
+ }
- // workaround for floating point precision bug when sq = 0, log = -Infinite,
- // thus triggering an infinite loop in flyTo
- var log = sq < 0.000000001 ? -18 : Math.log(sq);
+ this._separator.style.display = overlaysPresent && baseLayersPresent ? '' : 'none';
- return log;
+ return this;
+ },
+
+ _onLayerChange: function (e) {
+ if (!this._handlingClick) {
+ this._update();
}
- function sinh(n) { return (Math.exp(n) - Math.exp(-n)) / 2; }
- function cosh(n) { return (Math.exp(n) + Math.exp(-n)) / 2; }
- function tanh(n) { return sinh(n) / cosh(n); }
+ var obj = this._getLayer(L.stamp(e.target));
- var r0 = r(0);
+ // @namespace Map
+ // @section Layer events
+ // @event baselayerchange: LayersControlEvent
+ // Fired when the base layer is changed through the [layer control](#control-layers).
+ // @event overlayadd: LayersControlEvent
+ // Fired when an overlay is selected through the [layer control](#control-layers).
+ // @event overlayremove: LayersControlEvent
+ // Fired when an overlay is deselected through the [layer control](#control-layers).
+ // @namespace Control.Layers
+ var type = obj.overlay ?
+ (e.type === 'add' ? 'overlayadd' : 'overlayremove') :
+ (e.type === 'add' ? 'baselayerchange' : null);
- function w(s) { return w0 * (cosh(r0) / cosh(r0 + rho * s)); }
- function u(s) { return w0 * (cosh(r0) * tanh(r0 + rho * s) - sinh(r0)) / rho2; }
+ if (type) {
+ this._map.fire(type, obj);
+ }
+ },
- function easeOut(t) { return 1 - Math.pow(1 - t, 1.5); }
+ // IE7 bugs out if you create a radio dynamically, so you have to do it this hacky way (see http://bit.ly/PqYLBe)
+ _createRadioElement: function (name, checked) {
- var start = Date.now(),
- S = (r(1) - r0) / rho,
- duration = options.duration ? 1000 * options.duration : 1000 * S * 0.8;
+ var radioHtml = '<input type="radio" class="leaflet-control-layers-selector" name="' +
+ name + '"' + (checked ? ' checked="checked"' : '') + '/>';
- function frame() {
- var t = (Date.now() - start) / duration,
- s = easeOut(t) * S;
+ var radioFragment = document.createElement('div');
+ radioFragment.innerHTML = radioHtml;
- if (t <= 1) {
- this._flyToFrame = L.Util.requestAnimFrame(frame, this);
+ return radioFragment.firstChild;
+ },
- this._move(
- this.unproject(from.add(to.subtract(from).multiplyBy(u(s) / u1)), startZoom),
- this.getScaleZoom(w0 / w(s), startZoom),
- {flyTo: true});
+ _addItem: function (obj) {
+ var label = document.createElement('label'),
+ checked = this._map.hasLayer(obj.layer),
+ input;
- } else {
- this
- ._move(targetCenter, targetZoom)
- ._moveEnd(true);
- }
+ if (obj.overlay) {
+ input = document.createElement('input');
+ input.type = 'checkbox';
+ input.className = 'leaflet-control-layers-selector';
+ input.defaultChecked = checked;
+ } else {
+ input = this._createRadioElement('leaflet-base-layers', checked);
}
- this._moveStart(true);
-
- frame.call(this);
- return this;
- },
+ input.layerId = L.stamp(obj.layer);
- // @method flyToBounds(bounds: LatLngBounds, options?: fitBounds options): this
- // Sets the view of the map with a smooth animation like [`flyTo`](#map-flyto),
- // but takes a bounds parameter like [`fitBounds`](#map-fitbounds).
- flyToBounds: function (bounds, options) {
- var target = this._getBoundsCenterZoom(bounds, options);
- return this.flyTo(target.center, target.zoom, options);
- }
-});
+ L.DomEvent.on(input, 'click', this._onInputClick, this);
+ var name = document.createElement('span');
+ name.innerHTML = ' ' + obj.name;
+ // Helps from preventing layer control flicker when checkboxes are disabled
+ // https://github.com/Leaflet/Leaflet/issues/2771
+ var holder = document.createElement('div');
-/*
- * Provides L.Map with convenient shortcuts for using browser geolocation features.
- */
+ label.appendChild(holder);
+ holder.appendChild(input);
+ holder.appendChild(name);
-// @namespace Map
+ var container = obj.overlay ? this._overlaysList : this._baseLayersList;
+ container.appendChild(label);
-L.Map.include({
- // @section Geolocation methods
- _defaultLocateOptions: {
- timeout: 10000,
- watch: false
- // setView: false
- // maxZoom: <Number>
- // maximumAge: 0
- // enableHighAccuracy: false
+ this._checkDisabledLayers();
+ return label;
},
- // @method locate(options?: Locate options): this
- // Tries to locate the user using the Geolocation API, firing a [`locationfound`](#map-locationfound)
- // event with location data on success or a [`locationerror`](#map-locationerror) event on failure,
- // and optionally sets the map view to the user's location with respect to
- // detection accuracy (or to the world view if geolocation failed).
- // Note that, if your page doesn't use HTTPS, this method will fail in
- // modern browsers ([Chrome 50 and newer](https://sites.google.com/a/chromium.org/dev/Home/chromium-security/deprecating-powerful-features-on-insecure-origins))
- // See `Locate options` for more details.
- locate: function (options) {
+ _onInputClick: function () {
+ var inputs = this._form.getElementsByTagName('input'),
+ input, layer, hasLayer;
+ var addedLayers = [],
+ removedLayers = [];
- options = this._locateOptions = L.extend({}, this._defaultLocateOptions, options);
+ this._handlingClick = true;
- if (!('geolocation' in navigator)) {
- this._handleGeolocationError({
- code: 0,
- message: 'Geolocation not supported.'
- });
- return this;
- }
+ for (var i = inputs.length - 1; i >= 0; i--) {
+ input = inputs[i];
+ layer = this._getLayer(input.layerId).layer;
+ hasLayer = this._map.hasLayer(layer);
- var onResponse = L.bind(this._handleGeolocationResponse, this),
- onError = L.bind(this._handleGeolocationError, this);
+ if (input.checked && !hasLayer) {
+ addedLayers.push(layer);
- if (options.watch) {
- this._locationWatchId =
- navigator.geolocation.watchPosition(onResponse, onError, options);
- } else {
- navigator.geolocation.getCurrentPosition(onResponse, onError, options);
+ } else if (!input.checked && hasLayer) {
+ removedLayers.push(layer);
+ }
}
- return this;
- },
- // @method stopLocate(): this
- // Stops watching location previously initiated by `map.locate({watch: true})`
- // and aborts resetting the map view if map.locate was called with
- // `{setView: true}`.
- stopLocate: function () {
- if (navigator.geolocation && navigator.geolocation.clearWatch) {
- navigator.geolocation.clearWatch(this._locationWatchId);
+ // Bugfix issue 2318: Should remove all old layers before readding new ones
+ for (i = 0; i < removedLayers.length; i++) {
+ this._map.removeLayer(removedLayers[i]);
}
- if (this._locateOptions) {
- this._locateOptions.setView = false;
+ for (i = 0; i < addedLayers.length; i++) {
+ this._map.addLayer(addedLayers[i]);
}
- return this;
- },
-
- _handleGeolocationError: function (error) {
- var c = error.code,
- message = error.message ||
- (c === 1 ? 'permission denied' :
- (c === 2 ? 'position unavailable' : 'timeout'));
- if (this._locateOptions.setView && !this._loaded) {
- this.fitWorld();
- }
+ this._handlingClick = false;
- // @section Location events
- // @event locationerror: ErrorEvent
- // Fired when geolocation (using the [`locate`](#map-locate) method) failed.
- this.fire('locationerror', {
- code: c,
- message: 'Geolocation error: ' + message + '.'
- });
+ this._refocusOnMap();
},
- _handleGeolocationResponse: function (pos) {
- var lat = pos.coords.latitude,
- lng = pos.coords.longitude,
- latlng = new L.LatLng(lat, lng),
- bounds = latlng.toBounds(pos.coords.accuracy),
- options = this._locateOptions;
-
- if (options.setView) {
- var zoom = this.getBoundsZoom(bounds);
- this.setView(latlng, options.maxZoom ? Math.min(zoom, options.maxZoom) : zoom);
- }
+ _checkDisabledLayers: function () {
+ var inputs = this._form.getElementsByTagName('input'),
+ input,
+ layer,
+ zoom = this._map.getZoom();
- var data = {
- latlng: latlng,
- bounds: bounds,
- timestamp: pos.timestamp
- };
+ for (var i = inputs.length - 1; i >= 0; i--) {
+ input = inputs[i];
+ layer = this._getLayer(input.layerId).layer;
+ input.disabled = (layer.options.minZoom !== undefined && zoom < layer.options.minZoom) ||
+ (layer.options.maxZoom !== undefined && zoom > layer.options.maxZoom);
- for (var i in pos.coords) {
- if (typeof pos.coords[i] === 'number') {
- data[i] = pos.coords[i];
- }
}
+ },
- // @event locationfound: LocationEvent
- // Fired when geolocation (using the [`locate`](#map-locate) method)
- // went successfully.
- this.fire('locationfound', data);
+ _expand: function () {
+ // Backward compatibility, remove me in 1.1.
+ return this.expand();
+ },
+
+ _collapse: function () {
+ // Backward compatibility, remove me in 1.1.
+ return this.collapse();
}
+
});
+// @factory L.control.layers(baselayers?: Object, overlays?: Object, options?: Control.Layers options)
+// Creates an attribution control with the given layers. Base layers will be switched with radio buttons, while overlays will be switched with checkboxes. Note that all base layers should be passed in the base layers object, but only one should be added to the map during map instantiation.
+L.control.layers = function (baseLayers, overlays, options) {
+ return new L.Control.Layers(baseLayers, overlays, options);
+};
+
+
}(window, document));
//# sourceMappingURL=leaflet-src.map
\ No newline at end of file
projects / rails.git / blobdiff