`
+ * element instead of an image. Inherits from `Icon` but ignores the `iconUrl` and shadow options.
*
* @example
- *
* ```js
- * var southWest = L.latLng(40.712, -74.227),
- * northEast = L.latLng(40.774, -74.125),
- * bounds = L.latLngBounds(southWest, northEast);
- * ```
- *
- * 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:
+ * var myIcon = L.divIcon({className: 'my-div-icon'});
+ * // you can set .my-div-icon styles in CSS
*
- * ```js
- * map.fitBounds([
- * [40.712, -74.227],
- * [40.774, -74.125]
- * ]);
+ * 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.
*/
-L.LatLngBounds = function (southWest, northEast) { // (LatLng, LatLng) or (LatLng[])
- if (!southWest) { return; }
-
- var latlngs = northEast ? [southWest, northEast] : southWest;
-
- for (var i = 0, len = latlngs.length; i < len; i++) {
- this.extend(latlngs[i]);
- }
-};
-
-L.LatLngBounds.prototype = {
+L.DivIcon = L.Icon.extend({
+ options: {
+ // @section
+ // @aka DivIcon options
+ iconSize: [12, 12], // also can be set through CSS
- // @method extend(latlng: LatLng): this
- // Extend the bounds to contain the given point
+ // iconAnchor: (Point),
+ // popupAnchor: (Point),
- // @alternative
- // @method extend(otherBounds: LatLngBounds): this
- // Extend the bounds to contain the given bounds
- extend: function (obj) {
- var sw = this._southWest,
- ne = this._northEast,
- sw2, ne2;
+ // @option html: String = ''
+ // Custom HTML code to put inside the div element, empty by default.
+ html: false,
- if (obj instanceof L.LatLng) {
- sw2 = obj;
- ne2 = obj;
+ // @option bgPos: Point = [0, 0]
+ // Optional relative position of the background, in pixels
+ bgPos: null,
- } else if (obj instanceof L.LatLngBounds) {
- sw2 = obj._southWest;
- ne2 = obj._northEast;
+ className: 'leaflet-div-icon'
+ },
- if (!sw2 || !ne2) { return this; }
+ createIcon: function (oldIcon) {
+ var div = (oldIcon && oldIcon.tagName === 'DIV') ? oldIcon : document.createElement('div'),
+ options = this.options;
- } else {
- return obj ? this.extend(L.latLng(obj) || L.latLngBounds(obj)) : this;
- }
+ div.innerHTML = options.html !== false ? options.html : '';
- if (!sw && !ne) {
- this._southWest = new L.LatLng(sw2.lat, sw2.lng);
- this._northEast = new L.LatLng(ne2.lat, ne2.lng);
- } else {
- sw.lat = Math.min(sw2.lat, sw.lat);
- sw.lng = Math.min(sw2.lng, sw.lng);
- ne.lat = Math.max(ne2.lat, ne.lat);
- ne.lng = Math.max(ne2.lng, ne.lng);
+ if (options.bgPos) {
+ var bgPos = L.point(options.bgPos);
+ div.style.backgroundPosition = (-bgPos.x) + 'px ' + (-bgPos.y) + 'px';
}
+ this._setIconStyles(div, 'icon');
- return this;
- },
-
- // @method pad(bufferRatio: Number): LatLngBounds
- // Returns bigger bounds created by extending the current bounds by a given percentage in each direction.
- pad: function (bufferRatio) {
- var sw = this._southWest,
- ne = this._northEast,
- heightBuffer = Math.abs(sw.lat - ne.lat) * bufferRatio,
- widthBuffer = Math.abs(sw.lng - ne.lng) * bufferRatio;
-
- return new L.LatLngBounds(
- new L.LatLng(sw.lat - heightBuffer, sw.lng - widthBuffer),
- new L.LatLng(ne.lat + heightBuffer, ne.lng + widthBuffer));
- },
-
- // @method getCenter(): LatLng
- // Returns the center point of the bounds.
- getCenter: function () {
- return new L.LatLng(
- (this._southWest.lat + this._northEast.lat) / 2,
- (this._southWest.lng + this._northEast.lng) / 2);
+ return div;
},
- // @method getSouthWest(): LatLng
- // Returns the south-west point of the bounds.
- getSouthWest: function () {
- return this._southWest;
- },
+ createShadow: function () {
+ return null;
+ }
+});
- // @method getNorthEast(): LatLng
- // Returns the north-east point of the bounds.
- getNorthEast: function () {
- return this._northEast;
- },
+// @factory L.divIcon(options: DivIcon options)
+// Creates a `DivIcon` instance with the given options.
+L.divIcon = function (options) {
+ return new L.DivIcon(options);
+};
- // @method getNorthWest(): LatLng
- // Returns the north-west point of the bounds.
- getNorthWest: function () {
- return new L.LatLng(this.getNorth(), this.getWest());
- },
- // @method getSouthEast(): LatLng
- // Returns the south-east point of the bounds.
- getSouthEast: function () {
- return new L.LatLng(this.getSouth(), this.getEast());
- },
- // @method getWest(): Number
- // Returns the west longitude of the bounds
- getWest: function () {
- return this._southWest.lng;
- },
+/*
+ * @class DivOverlay
+ * @inherits Layer
+ * @aka L.DivOverlay
+ * Base model for L.Popup and L.Tooltip. Inherit from it for custom popup like plugins.
+ */
+
+// @namespace DivOverlay
+L.DivOverlay = L.Layer.extend({
+
+ // @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],
+
+ // @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 (map._fadeAnimated) {
+ L.DomUtil.setOpacity(this._container, 0);
+ }
+
+ clearTimeout(this._removeTimeout);
+ this.getPane().appendChild(this._container);
+ this.update();
+
+ if (map._fadeAnimated) {
+ L.DomUtil.setOpacity(this._container, 1);
+ }
+
+ this.bringToFront();
+ },
+
+ 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);
+ }
+ },
+
+ // @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;
+ },
+
+ // @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 getElement: String|HTMLElement
+ // Alias for [getContent()](#popup-getcontent)
+ getElement: function () {
+ return this._container;
+ },
+
+ // @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; }
+
+ this._container.style.visibility = 'hidden';
+
+ this._updateContent();
+ this._updateLayout();
+ this._updatePosition();
+
+ this._container.style.visibility = '';
+
+ this._adjustPan();
+ },
+
+ getEvents: function () {
+ var events = {
+ zoom: this._updatePosition,
+ viewreset: this._updatePosition
+ };
+
+ if (this._zoomAnimated) {
+ events.zoomanim = this._animateZoom;
+ }
+ return events;
+ },
+
+ // @method isOpen: Boolean
+ // Returns `true` when the popup is visible on the map.
+ isOpen: function () {
+ return !!this._map && this._map.hasLayer(this);
+ },
+
+ // @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 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; }
+
+ var node = this._contentNode;
+ var content = (typeof this._content === 'function') ? this._content(this._source || this) : this._content;
+
+ if (typeof content === 'string') {
+ node.innerHTML = content;
+ } else {
+ while (node.hasChildNodes()) {
+ node.removeChild(node.firstChild);
+ }
+ node.appendChild(content);
+ }
+ this.fire('contentupdate');
+ },
+
+ _updatePosition: function () {
+ if (!this._map) { return; }
+
+ var pos = this._map.latLngToLayerPoint(this._latlng),
+ offset = L.point(this.options.offset),
+ anchor = this._getAnchor();
+
+ if (this._zoomAnimated) {
+ L.DomUtil.setPosition(this._container, pos.add(anchor));
+ } else {
+ offset = offset.add(pos).add(anchor);
+ }
+
+ var bottom = this._containerBottom = -offset.y,
+ left = this._containerLeft = -Math.round(this._containerWidth / 2) + offset.x;
+
+ // 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';
+ },
+
+ _getAnchor: function () {
+ return [0, 0];
+ }
+
+});
+
+
+
+/*
+ * @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('
Hello world!
This is a nice popup.
')
+ * .openOn(map);
+ * ```
+ */
+
+
+// @namespace Popup
+L.Popup = L.DivOverlay.extend({
+
+ // @section
+ // @aka Popup options
+ options: {
+ // @option maxWidth: Number = 300
+ // Max width of the popup, in pixels.
+ maxWidth: 300,
+
+ // @option minWidth: Number = 50
+ // Min width of the popup, in pixels.
+ minWidth: 50,
+
+ // @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 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 autoPanPaddingTopLeft: Point = null
+ // The margin between the popup and the top left corner of the map
+ // view after autopanning was performed.
+ autoPanPaddingTopLeft: null,
+
+ // @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 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);
+
+ // @namespace Map
+ // @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 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);
+ }
+ }
+ },
+
+ onRemove: function (map) {
+ L.DivOverlay.prototype.onRemove.call(this, map);
+
+ // @namespace Map
+ // @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 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 ('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.closePopup(this);
+ }
+ },
+
+ _initLayout: function () {
+ var prefix = 'leaflet-popup',
+ container = this._container = L.DomUtil.create('div',
+ prefix + ' ' + (this.options.className || '') +
+ ' leaflet-zoom-animated');
+
+ 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 () {
+ var container = this._contentNode,
+ style = container.style;
+
+ style.width = '';
+ style.whiteSpace = 'nowrap';
+
+ var width = container.offsetWidth;
+ width = Math.min(width, this.options.maxWidth);
+ width = Math.max(width, this.options.minWidth);
+
+ 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 {
+ L.DomUtil.removeClass(container, scrolledClass);
+ }
+
+ this._containerWidth = this._container.offsetWidth;
+ },
+
+ _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));
+ },
+
+ _adjustPan: function () {
+ if (!this.options.autoPan || (this._map._panAnim && this._map._panAnim._inProgress)) { return; }
+
+ 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]);
+ }
+ },
+
+ _onCloseButtonClick: function (e) {
+ this._close();
+ L.DomEvent.stop(e);
+ },
+
+ _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]);
+ }
+
+});
+
+// @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 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);
+ }
+
+ if (latlng) {
+ popup.setLatLng(latlng);
+ }
+
+ if (this.hasLayer(popup)) {
+ return this;
+ }
+
+ if (this._popup && this._popup.options.autoClose) {
+ this.closePopup();
+ }
+
+ this._popup = popup;
+ return this.addLayer(popup);
+ },
+
+ // @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;
+ }
+});
- // @method getSouth(): Number
- // Returns the south latitude of the bounds
- getSouth: function () {
- return this._southWest.lat;
- },
- // @method getEast(): Number
- // Returns the east longitude of the bounds
- getEast: function () {
- return this._northEast.lng;
- },
- // @method getNorth(): Number
- // Returns the north latitude of the bounds
- getNorth: function () {
- return this._northEast.lat;
- },
+/*
+ * @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 contains(otherBounds: LatLngBounds): Boolean
- // Returns `true` if the rectangle contains the given one.
+ // @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) {
- // @alternative
- // @method contains (latlng: LatLng): Boolean
- // Returns `true` if the rectangle contains the given point.
- contains: function (obj) { // (LatLngBounds) or (LatLng) -> Boolean
- if (typeof obj[0] === 'number' || obj instanceof L.LatLng) {
- obj = L.latLng(obj);
+ if (content instanceof L.Popup) {
+ L.setOptions(content, options);
+ this._popup = content;
+ content._source = this;
} else {
- obj = L.latLngBounds(obj);
+ if (!this._popup || options) {
+ this._popup = new L.Popup(options, this);
+ }
+ this._popup.setContent(content);
}
- var sw = this._southWest,
- ne = this._northEast,
- sw2, ne2;
-
- if (obj instanceof L.LatLngBounds) {
- sw2 = obj.getSouthWest();
- ne2 = obj.getNorthEast();
- } else {
- sw2 = ne2 = obj;
+ if (!this._popupHandlersAdded) {
+ this.on({
+ click: this._openPopup,
+ remove: this.closePopup,
+ move: this._movePopup
+ });
+ this._popupHandlersAdded = true;
}
- return (sw2.lat >= sw.lat) && (ne2.lat <= ne.lat) &&
- (sw2.lng >= sw.lng) && (ne2.lng <= ne.lng);
+ return this;
},
- // @method intersects(otherBounds: LatLngBounds): Boolean
- // Returns `true` if the rectangle intersects the given bounds. Two bounds intersect if they have at least one point in common.
- intersects: function (bounds) {
- bounds = L.latLngBounds(bounds);
+ // @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;
+ },
- var sw = this._southWest,
- ne = this._northEast,
- sw2 = bounds.getSouthWest(),
- ne2 = bounds.getNorthEast(),
+ // @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;
+ }
- latIntersects = (ne2.lat >= sw.lat) && (sw2.lat <= ne.lat),
- lngIntersects = (ne2.lng >= sw.lng) && (sw2.lng <= ne.lng);
+ if (layer instanceof L.FeatureGroup) {
+ for (var id in this._layers) {
+ layer = this._layers[id];
+ break;
+ }
+ }
- return latIntersects && lngIntersects;
- },
+ if (!latlng) {
+ latlng = layer.getCenter ? layer.getCenter() : layer.getLatLng();
+ }
- // @method overlaps(otherBounds: Bounds): Boolean
- // Returns `true` if the rectangle overlaps the given bounds. Two bounds overlap if their intersection is an area.
- overlaps: function (bounds) {
- bounds = L.latLngBounds(bounds);
+ if (this._popup && this._map) {
+ // set popup source to this layer
+ this._popup._source = layer;
- var sw = this._southWest,
- ne = this._northEast,
- sw2 = bounds.getSouthWest(),
- ne2 = bounds.getNorthEast(),
+ // update the popup (content, layout, ect...)
+ this._popup.update();
- latOverlaps = (ne2.lat > sw.lat) && (sw2.lat < ne.lat),
- lngOverlaps = (ne2.lng > sw.lng) && (sw2.lng < ne.lng);
+ // open the popup on the map
+ this._map.openPopup(this._popup, latlng);
+ }
- return latOverlaps && lngOverlaps;
+ return this;
},
- // @method toBBoxString(): String
- // Returns a string with bounding box coordinates in a 'southwest_lng,southwest_lat,northeast_lng,northeast_lat' format. Useful for sending requests to web services that return geo data.
- toBBoxString: function () {
- return [this.getWest(), this.getSouth(), this.getEast(), this.getNorth()].join(',');
+ // @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 equals(otherBounds: LatLngBounds): Boolean
- // Returns `true` if the rectangle is equivalent (within a small margin of error) to the given bounds.
- equals: function (bounds) {
- if (!bounds) { return false; }
+ // @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);
+ }
+ }
+ return this;
+ },
- bounds = L.latLngBounds(bounds);
+ // @method isPopupOpen(): boolean
+ // Returns `true` if the popup bound to this layer is currently open.
+ isPopupOpen: function () {
+ return this._popup.isOpen();
+ },
- return this._southWest.equals(bounds.getSouthWest()) &&
- this._northEast.equals(bounds.getNorthEast());
+ // @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 isValid(): Boolean
- // Returns `true` if the bounds are properly initialized.
- isValid: function () {
- return !!(this._southWest && this._northEast);
- }
-};
+ // @method getPopup(): Popup
+ // Returns the popup bound to this layer.
+ getPopup: function () {
+ return this._popup;
+ },
-// TODO International date line?
+ _openPopup: function (e) {
+ var layer = e.layer || e.target;
-// @factory L.latLngBounds(southWest: LatLng, northEast: LatLng)
-// Creates a `LatLngBounds` object by defining south-west and north-east corners of the rectangle.
+ if (!this._popup) {
+ return;
+ }
-// @alternative
-// @factory L.latLngBounds(latlngs: LatLng[])
-// Creates a `LatLngBounds` object defined by the geographical points it contains. Very useful for zooming the map to fit a particular set of locations with [`fitBounds`](#map-fitbounds).
-L.latLngBounds = function (a, b) {
- if (a instanceof L.LatLngBounds) {
- return a;
- }
- return new L.LatLngBounds(a, b);
-};
+ if (!this._map) {
+ return;
+ }
+ // prevent map click
+ L.DomEvent.stop(e);
+ // 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;
+ }
-/*
- * @namespace Projection
- * @section
- * Leaflet comes with a set of already defined Projections out of the box:
- *
- * @projection L.Projection.LonLat
- *
- * Equirectangular, or Plate Carree projection — the most simple projection,
- * mostly used by GIS enthusiasts. Directly maps `x` as longitude, and `y` as
- * latitude. Also suitable for flat worlds, e.g. game maps. Used by the
- * `EPSG:3395` and `Simple` CRS.
- */
+ // 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);
+ }
+ },
-L.Projection = {};
+ _movePopup: function (e) {
+ this._popup.setLatLng(e.latlng);
+ }
+});
-L.Projection.LonLat = {
- project: function (latlng) {
- return new L.Point(latlng.lng, latlng.lat);
- },
- unproject: function (point) {
- return new L.LatLng(point.y, point.x);
- },
- bounds: L.bounds([-180, -90], [180, 90])
-};
+/*
+ * Popup extension to L.Marker, adding popup-related methods.
+ */
+
+L.Marker.include({
+ _getPopupAnchor: function () {
+ return this.options.icon.options.popupAnchor || [0, 0];
+ }
+});
/*
- * @namespace Projection
- * @projection L.Projection.SphericalMercator
+ * @class Tooltip
+ * @inherits DivOverlay
+ * @aka L.Tooltip
+ * Used to display small texts on top of map layers.
+ *
+ * @example
*
- * Spherical Mercator projection — the most common projection for online maps,
- * used by almost all free and commercial tile providers. Assumes that Earth is
- * a sphere. Used by the `EPSG:3857` CRS.
+ * ```js
+ * 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.Projection.SphericalMercator = {
- R: 6378137,
- MAX_LATITUDE: 85.0511287798,
+// @namespace Tooltip
+L.Tooltip = L.DivOverlay.extend({
- project: function (latlng) {
- var d = Math.PI / 180,
- max = this.MAX_LATITUDE,
- lat = Math.max(Math.min(max, latlng.lat), -max),
- sin = Math.sin(lat * d);
+ // @section
+ // @aka Tooltip options
+ options: {
+ // @option pane: String = 'tooltipPane'
+ // `Map pane` where the tooltip will be added.
+ pane: 'tooltipPane',
- return new L.Point(
- this.R * latlng.lng * d,
- this.R * Math.log((1 + sin) / (1 - sin)) / 2);
- },
+ // @option offset: Point = Point(0, 0)
+ // Optional offset of the tooltip position.
+ offset: [0, 0],
- unproject: function (point) {
- var d = 180 / Math.PI;
+ // @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',
- return new L.LatLng(
- (2 * Math.atan(Math.exp(point.y / this.R)) - (Math.PI / 2)) * d,
- point.x * d / this.R);
- },
+ // @option permanent: Boolean = false
+ // Whether to open the tooltip permanently or only on mouseover.
+ permanent: false,
- bounds: (function () {
- var d = 6378137 * Math.PI;
- return L.bounds([-d, -d], [d, d]);
- })()
-};
+ // @option sticky: Boolean = false
+ // If true, the tooltip will follow the mouse instead of being fixed at the feature center.
+ sticky: false,
+ // @option interactive: Boolean = false
+ // If true, the tooltip will listen to the feature events.
+ interactive: false,
+ // @option opacity: Number = 0.9
+ // Tooltip container opacity.
+ opacity: 0.9
+ },
-/*
- * @class CRS
- * @aka L.CRS
- * Abstract class that defines coordinate reference systems for projecting
- * geographical points into pixel (screen) coordinates and back (and to
- * coordinates in other units for [WMS](https://en.wikipedia.org/wiki/Web_Map_Service) services). See
- * [spatial reference system](http://en.wikipedia.org/wiki/Coordinate_reference_system).
- *
- * Leaflet defines the most usual CRSs by default. If you want to use a
- * CRS not defined by default, take a look at the
- * [Proj4Leaflet](https://github.com/kartena/Proj4Leaflet) plugin.
- */
+ onAdd: function (map) {
+ L.DivOverlay.prototype.onAdd.call(this, map);
+ this.setOpacity(this.options.opacity);
-L.CRS = {
- // @method latLngToPoint(latlng: LatLng, zoom: Number): Point
- // Projects geographical coordinates into pixel coordinates for a given zoom.
- latLngToPoint: function (latlng, zoom) {
- var projectedPoint = this.projection.project(latlng),
- scale = this.scale(zoom);
+ // @namespace Map
+ // @section Tooltip events
+ // @event tooltipopen: TooltipEvent
+ // Fired when a tooltip is opened in the map.
+ map.fire('tooltipopen', {tooltip: this});
- return this.transformation._transform(projectedPoint, scale);
+ 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 pointToLatLng(point: Point, zoom: Number): LatLng
- // The inverse of `latLngToPoint`. Projects pixel coordinates on a given
- // zoom into geographical coordinates.
- pointToLatLng: function (point, zoom) {
- var scale = this.scale(zoom),
- untransformedPoint = this.transformation.untransform(point, scale);
+ onRemove: function (map) {
+ L.DivOverlay.prototype.onRemove.call(this, map);
- return this.projection.unproject(untransformedPoint);
- },
+ // @namespace Map
+ // @section Tooltip events
+ // @event tooltipclose: TooltipEvent
+ // Fired when a tooltip in the map is closed.
+ map.fire('tooltipclose', {tooltip: this});
- // @method project(latlng: LatLng): Point
- // Projects geographical coordinates into coordinates in units accepted for
- // this CRS (e.g. meters for EPSG:3857, for passing it to WMS services).
- project: function (latlng) {
- return this.projection.project(latlng);
+ 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);
+ }
},
- // @method unproject(point: Point): LatLng
- // Given a projected coordinate returns the corresponding LatLng.
- // The inverse of `project`.
- unproject: function (point) {
- return this.projection.unproject(point);
- },
+ getEvents: function () {
+ var events = L.DivOverlay.prototype.getEvents.call(this);
- // @method scale(zoom: Number): Number
- // Returns the scale used when transforming projected coordinates into
- // pixel coordinates for a particular zoom. For example, it returns
- // `256 * 2^zoom` for Mercator-based CRS.
- scale: function (zoom) {
- return 256 * Math.pow(2, zoom);
- },
+ if (L.Browser.touch && !this.options.permanent) {
+ events.preclick = this._close;
+ }
- // @method zoom(scale: Number): Number
- // Inverse of `scale()`, returns the zoom level correspondingto a scale
- // factor of `scale`.
- zoom: function (scale) {
- return Math.log(scale / 256) / Math.LN2;
+ return events;
},
- // @method getProjectedBounds(zoom): Bounds
- // Returns the projection's bounds scaled and transformed for the provided `zoom`.
- getProjectedBounds: function (zoom) {
- if (this.infinite) { return null; }
-
- var b = this.projection.bounds,
- s = this.scale(zoom),
- min = this.transformation.transform(b.min, s),
- max = this.transformation.transform(b.max, s);
-
- return L.bounds(min, max);
+ _close: function () {
+ if (this._map) {
+ this._map.closeTooltip(this);
+ }
},
- // @method distance(latlng1: LatLng, latlng1: LatLng): Number
- // Returns the distance between two geographical coordinates.
-
- // @property code: String
- // Standard code name of the CRS passed into WMS services (e.g. `'EPSG:3857'`)
- //
- // @property wrapLng: Number[]
- // An array of two numbers defining whether the longitude (horizontal) coordinate
- // axis wraps around a given range and how. Defaults to `[-180, 180]` in most
- // geographical CRSs. If `undefined`, the longitude axis does not wrap around.
- //
- // @property wrapLat: Number[]
- // Like `wrapLng`, but for the latitude (vertical) axis.
-
- // wrapLng: [min, max],
- // wrapLat: [min, max],
-
- // @property infinite: Boolean
- // If true, the coordinate space will be unbounded (infinite in both axes)
- infinite: false,
-
- // @method wrapLatLng(latlng: LatLng): LatLng
- // Returns a `LatLng` where lat and lng has been wrapped according to the
- // CRS's `wrapLat` and `wrapLng` properties, if they are outside the CRS's bounds.
- wrapLatLng: function (latlng) {
- var lng = this.wrapLng ? L.Util.wrapNum(latlng.lng, this.wrapLng, true) : latlng.lng,
- lat = this.wrapLat ? L.Util.wrapNum(latlng.lat, this.wrapLat, true) : latlng.lat,
- alt = latlng.alt;
+ _initLayout: function () {
+ var prefix = 'leaflet-tooltip',
+ className = prefix + ' ' + (this.options.className || '') + ' leaflet-zoom-' + (this._zoomAnimated ? 'animated' : 'hide');
- return L.latLng(lat, lng, alt);
- }
-};
+ this._contentNode = this._container = L.DomUtil.create('div', className);
+ },
+ _updateLayout: function () {},
+ _adjustPan: function () {},
-/*
- * @namespace CRS
- * @crs L.CRS.Simple
- *
- * A simple CRS that maps longitude and latitude into `x` and `y` directly.
- * May be used for maps of flat surfaces (e.g. game maps). Note that the `y`
- * axis should still be inverted (going from bottom to top). `distance()` returns
- * simple euclidean distance.
- */
+ _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();
-L.CRS.Simple = L.extend({}, L.CRS, {
- projection: L.Projection.LonLat,
- transformation: new L.Transformation(1, 0, -1, 0),
+ 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]);
+ } else {
+ direction = 'left';
+ pos = pos.subtract(L.point(tooltipWidth + anchor.x - offset.x, tooltipHeight / 2 - anchor.y - offset.y));
+ }
- scale: function (zoom) {
- return Math.pow(2, zoom);
+ 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);
},
- zoom: function (scale) {
- return Math.log(scale) / Math.LN2;
+ _updatePosition: function () {
+ var pos = this._map.latLngToLayerPoint(this._latlng);
+ this._setPosition(pos);
},
- distance: function (latlng1, latlng2) {
- var dx = latlng2.lng - latlng1.lng,
- dy = latlng2.lat - latlng1.lat;
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
- return Math.sqrt(dx * dx + dy * dy);
+ if (this._container) {
+ L.DomUtil.setOpacity(this._container, opacity);
+ }
},
- infinite: true
-});
-
-
-
-/*
- * @namespace CRS
- * @crs L.CRS.Earth
- *
- * Serves as the base for CRS that are global such that they cover the earth.
- * Can only be used as the base for other CRS and cannot be used directly,
- * since it does not have a `code`, `projection` or `transformation`. `distance()` returns
- * meters.
- */
-
-L.CRS.Earth = L.extend({}, L.CRS, {
- wrapLng: [-180, 180],
-
- // Mean Earth Radius, as recommended for use by
- // the International Union of Geodesy and Geophysics,
- // see http://rosettacode.org/wiki/Haversine_formula
- R: 6371000,
-
- // distance between two geographical points using spherical law of cosines approximation
- distance: function (latlng1, latlng2) {
- var rad = Math.PI / 180,
- lat1 = latlng1.lat * rad,
- lat2 = latlng2.lat * rad,
- a = Math.sin(lat1) * Math.sin(lat2) +
- Math.cos(lat1) * Math.cos(lat2) * Math.cos((latlng2.lng - latlng1.lng) * rad);
+ _animateZoom: function (e) {
+ var pos = this._map._latLngToNewLayerPoint(this._latlng, e.zoom, e.center);
+ this._setPosition(pos);
+ },
- return this.R * Math.acos(Math.min(a, 1));
+ _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]);
}
-});
-
+});
-/*
- * @namespace CRS
- * @crs L.CRS.EPSG3857
- *
- * The most common CRS for online maps, used by almost all free and commercial
- * tile providers. Uses Spherical Mercator projection. Set in by default in
- * Map's `crs` option.
- */
+// @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);
+};
-L.CRS.EPSG3857 = L.extend({}, L.CRS.Earth, {
- code: 'EPSG:3857',
- projection: L.Projection.SphericalMercator,
+// @namespace Map
+// @section Methods for Layers and Controls
+L.Map.include({
- transformation: (function () {
- var scale = 0.5 / (Math.PI * L.Projection.SphericalMercator.R);
- return new L.Transformation(scale, 0.5, -scale, 0.5);
- }())
-});
+ // @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);
+ }
-L.CRS.EPSG900913 = L.extend({}, L.CRS.EPSG3857, {
- code: 'EPSG:900913'
-});
+ if (latlng) {
+ tooltip.setLatLng(latlng);
+ }
+ if (this.hasLayer(tooltip)) {
+ return this;
+ }
+ return this.addLayer(tooltip);
+ },
-/*
- * @namespace CRS
- * @crs L.CRS.EPSG4326
- *
- * A common CRS among GIS enthusiasts. Uses simple Equirectangular projection.
- */
+ // @method closeTooltip(tooltip?: Tooltip): this
+ // Closes the tooltip given as parameter.
+ closeTooltip: function (tooltip) {
+ if (tooltip) {
+ this.removeLayer(tooltip);
+ }
+ return this;
+ }
-L.CRS.EPSG4326 = L.extend({}, L.CRS.Earth, {
- code: 'EPSG:4326',
- projection: L.Projection.LonLat,
- transformation: new L.Transformation(1 / 180, 1, -1 / 180, 0.5)
});
/*
- * @class Map
- * @aka L.Map
- * @inherits Evented
- *
- * The central class of the API — it is used to create a map on a page and manipulate it.
+ * @namespace Layer
+ * @section Tooltip methods example
*
- * @example
+ * All layers share a set of methods convenient for binding tooltips to it.
*
* ```js
- * // initialize the map on the "map" div with a given center and zoom
- * var map = L.map('map', {
- * center: [51.505, -0.09],
- * zoom: 13
- * });
+ * var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map);
+ * layer.openTooltip();
+ * layer.closeTooltip();
* ```
- *
*/
-L.Map = L.Evented.extend({
-
- options: {
- // @section Map State Options
- // @option crs: CRS = L.CRS.EPSG3857
- // The [Coordinate Reference System](#crs) to use. Don't change this if you're not
- // sure what it means.
- crs: L.CRS.EPSG3857,
-
- // @option center: LatLng = undefined
- // Initial geographic center of the map
- center: undefined,
-
- // @option zoom: Number = undefined
- // Initial map zoom level
- zoom: undefined,
-
- // @option minZoom: Number = undefined
- // Minimum zoom level of the map. Overrides any `minZoom` option set on map layers.
- minZoom: undefined,
-
- // @option maxZoom: Number = undefined
- // Maximum zoom level of the map. Overrides any `maxZoom` option set on map layers.
- maxZoom: undefined,
-
- // @option layers: Layer[] = []
- // Array of layers that will be added to the map initially
- layers: [],
-
- // @option maxBounds: LatLngBounds = null
- // When this option is set, the map restricts the view to the given
- // geographical bounds, bouncing the user back when he tries to pan
- // outside the view. To set the restriction dynamically, use
- // [`setMaxBounds`](#map-setmaxbounds) method.
- maxBounds: undefined,
-
- // @option renderer: Renderer = *
- // The default method for drawing vector layers on the map. `L.SVG`
- // or `L.Canvas` by default depending on browser support.
- renderer: undefined,
-
+// @section Tooltip methods
+L.Layer.include({
- // @section Animation Options
- // @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.
- fadeAnimation: true,
+ // @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) {
- // @option markerZoomAnimation: Boolean = true
- // Whether markers animate their zoom with the zoom animation, if disabled
- // they will disappear for the length of the animation. By default it's
- // enabled in all browsers that support CSS3 Transitions except Android.
- markerZoomAnimation: true,
+ 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);
- // @option transform3DLimit: Number = 2^23
- // Defines the maximum size of a CSS translation transform. The default
- // value should not be changed unless a web browser positions layers in
- // the wrong place after doing a large `panBy`.
- transform3DLimit: 8388608, // Precision limit of a 32-bit float
+ }
- // @section Interaction Options
- // @option zoomSnap: Number = 1
- // Forces the map's zoom level to always be a multiple of this, particularly
- // right after a [`fitBounds()`](#map-fitbounds) or a pinch-zoom.
- // By default, the zoom level snaps to the nearest integer; lower values
- // (e.g. `0.5` or `0.1`) allow for greater granularity. A value of `0`
- // means the zoom level will not be snapped after `fitBounds` or a pinch-zoom.
- zoomSnap: 1,
+ this._initTooltipInteractions();
- // @option zoomDelta: Number = 1
- // Controls how much the map's zoom level will change after a
- // [`zoomIn()`](#map-zoomin), [`zoomOut()`](#map-zoomout), pressing `+`
- // or `-` on the keyboard, or using the [zoom controls](#control-zoom).
- // Values smaller than `1` (e.g. `0.5`) allow for greater granularity.
- zoomDelta: 1,
+ if (this._tooltip.options.permanent && this._map && this._map.hasLayer(this)) {
+ this.openTooltip();
+ }
- // @option trackResize: Boolean = true
- // Whether the map automatically handles browser window resize to update itself.
- trackResize: true
+ return this;
},
- initialize: function (id, options) { // (HTMLElement or String, Object)
- options = L.setOptions(this, options);
-
- this._initContainer(id);
- this._initLayout();
-
- // hack for https://github.com/Leaflet/Leaflet/issues/1980
- this._onResize = L.bind(this._onResize, this);
+ // @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;
+ },
- this._initEvents();
+ _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;
+ },
- if (options.maxBounds) {
- this.setMaxBounds(options.maxBounds);
+ // @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;
}
- if (options.zoom !== undefined) {
- this._zoom = this._limitZoom(options.zoom);
+ if (layer instanceof L.FeatureGroup) {
+ for (var id in this._layers) {
+ layer = this._layers[id];
+ break;
+ }
}
- if (options.center && options.zoom !== undefined) {
- this.setView(L.latLng(options.center), options.zoom, {reset: true});
+ if (!latlng) {
+ latlng = layer.getCenter ? layer.getCenter() : layer.getLatLng();
}
- this._handlers = [];
- this._layers = {};
- this._zoomBoundLayers = {};
- this._sizeChanged = true;
+ if (this._tooltip && this._map) {
- this.callInitHooks();
+ // set tooltip source to this layer
+ this._tooltip._source = layer;
- this._addLayers(this.options.layers);
- },
+ // update the tooltip (content, layout, ect...)
+ this._tooltip.update();
+ // open the tooltip on the map
+ this._map.openTooltip(this._tooltip, latlng);
- // @section Methods for modifying map state
+ // 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);
+ }
+ }
- // @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);
return this;
},
- // @method setZoom(zoom: Number, options: Zoom/pan options): this
- // Sets the zoom of the map.
- setZoom: function (zoom, options) {
- if (!this._loaded) {
- this._zoom = zoom;
- 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);
+ }
+ }
+ 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();
+ } else {
+ this.openTooltip(target);
+ }
}
- return this.setView(this.getCenter(), zoom, {zoom: options});
+ return this;
},
- // @method zoomIn(delta?: Number, options?: Zoom options): this
- // Increases the zoom of the map by `delta` ([`zoomDelta`](#map-zoomdelta) by default).
- zoomIn: function (delta, options) {
- delta = delta || (L.Browser.any3d ? this.options.zoomDelta : 1);
- return this.setZoom(this._zoom + delta, options);
+ // @method isTooltipOpen(): boolean
+ // Returns `true` if the tooltip bound to this layer is currently open.
+ isTooltipOpen: function () {
+ return this._tooltip.isOpen();
},
- // @method zoomOut(delta?: Number, options?: Zoom options): this
- // Decreases the zoom of the map by `delta` ([`zoomDelta`](#map-zoomdelta) by default).
- zoomOut: function (delta, options) {
- delta = delta || (L.Browser.any3d ? this.options.zoomDelta : 1);
- return this.setZoom(this._zoom - delta, options);
+ // @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;
},
- // @method setZoomAround(latlng: LatLng, zoom: Number, options: Zoom options): this
- // Zooms the map while keeping a specified geographical point on the map
- // stationary (e.g. used internally for scroll zoom and double-click zoom).
- // @alternative
- // @method setZoomAround(offset: Point, zoom: Number, options: Zoom options): this
- // Zooms the map while keeping a specified pixel on the map (relative to the top-left corner) stationary.
- setZoomAround: function (latlng, zoom, options) {
- var scale = this.getZoomScale(zoom),
- viewHalf = this.getSize().divideBy(2),
- containerPoint = latlng instanceof L.Point ? latlng : this.latLngToContainerPoint(latlng),
+ // @method getTooltip(): Tooltip
+ // Returns the tooltip bound to this layer.
+ getTooltip: function () {
+ return this._tooltip;
+ },
- centerOffset = containerPoint.subtract(viewHalf).multiplyBy(1 - 1 / scale),
- newCenter = this.containerPointToLatLng(viewHalf.add(centerOffset));
+ _openTooltip: function (e) {
+ var layer = e.layer || e.target;
- return this.setView(newCenter, zoom, {zoom: options});
+ if (!this._tooltip || !this._map) {
+ return;
+ }
+ this.openTooltip(layer, this._tooltip.options.sticky ? e.latlng : undefined);
},
- _getBoundsCenterZoom: function (bounds, options) {
+ _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);
+ }
+});
+
- options = options || {};
- bounds = bounds.getBounds ? bounds.getBounds() : L.latLngBounds(bounds);
- var paddingTL = L.point(options.paddingTopLeft || options.padding || [0, 0]),
- paddingBR = L.point(options.paddingBottomRight || options.padding || [0, 0]),
+/*
+ * Tooltip extension to L.Marker, adding tooltip-related methods.
+ */
+
+L.Marker.include({
+ _getTooltipAnchor: function () {
+ return this.options.icon.options.tooltipAnchor || [0, 0];
+ }
+});
+
+
+
+/*
+ * @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);
+ * ```
+ */
+
+L.LayerGroup = L.Layer.extend({
+
+ initialize: function (layers) {
+ this._layers = {};
+
+ var i, len;
+
+ if (layers) {
+ for (i = 0, len = layers.length; i < len; i++) {
+ this.addLayer(layers[i]);
+ }
+ }
+ },
+
+ // @method addLayer(layer: Layer): this
+ // Adds the given layer to the group.
+ addLayer: function (layer) {
+ var id = this.getLayerId(layer);
+
+ this._layers[id] = layer;
+
+ if (this._map) {
+ this._map.addLayer(layer);
+ }
+
+ return this;
+ },
+
+ // @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);
+
+ if (this._map && this._layers[id]) {
+ this._map.removeLayer(this._layers[id]);
+ }
+
+ delete this._layers[id];
+
+ return this;
+ },
+
+ // @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);
+ },
+
+ // @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;
+ },
+
+ // @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];
+
+ if (layer[methodName]) {
+ layer[methodName].apply(layer, args);
+ }
+ }
+
+ return this;
+ },
+
+ onAdd: function (map) {
+ for (var i in this._layers) {
+ map.addLayer(this._layers[i]);
+ }
+ },
+
+ 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;
+ },
+
+ // @method getLayer(id: Number): Layer
+ // Returns the layer with the given internal ID.
+ getLayer: function (id) {
+ return this._layers[id];
+ },
+
+ // @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;
+ },
+
+ // @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.layerGroup(layers: Layer[])
+// Create a layer group, optionally given an initial set of layers.
+L.layerGroup = function (layers) {
+ return new L.LayerGroup(layers);
+};
+
+
+
+/*
+ * @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
+ *
+ * @example
+ *
+ * ```js
+ * L.featureGroup([marker1, marker2, polyline])
+ * .bindPopup('Hello world!')
+ * .on('click', function() { alert('Clicked on a member of the group!'); })
+ * .addTo(map);
+ * ```
+ */
+
+L.FeatureGroup = L.LayerGroup.extend({
+
+ addLayer: function (layer) {
+ if (this.hasLayer(layer)) {
+ return this;
+ }
+
+ layer.addEventParent(this);
+
+ L.LayerGroup.prototype.addLayer.call(this, layer);
+
+ // @event layeradd: LayerEvent
+ // Fired when a layer is added to this `FeatureGroup`
+ return this.fire('layeradd', {layer: layer});
+ },
+
+ 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);
+
+ // @event layerremove: LayerEvent
+ // Fired when a layer is removed from this `FeatureGroup`
+ return this.fire('layerremove', {layer: layer});
+ },
+
+ // @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);
+ },
+
+ // @method bringToFront(): this
+ // Brings the layer group to the top of all other layers
+ bringToFront: function () {
+ return this.invoke('bringToFront');
+ },
+
+ // @method bringToBack(): this
+ // Brings the layer group to the top of all other layers
+ bringToBack: function () {
+ return this.invoke('bringToBack');
+ },
+
+ // @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();
+
+ for (var id in this._layers) {
+ var layer = this._layers[id];
+ bounds.extend(layer.getBounds ? layer.getBounds() : layer.getLatLng());
+ }
+ 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);
+};
- zoom = this.getBoundsZoom(bounds, false, paddingTL.add(paddingBR));
- zoom = (typeof options.maxZoom === 'number') ? Math.min(options.maxZoom, zoom) : zoom;
- var paddingOffset = paddingBR.subtract(paddingTL).divideBy(2),
+/*
+ * @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
+ */
- swPoint = this.project(bounds.getSouthWest(), zoom),
- nePoint = this.project(bounds.getNorthEast(), zoom),
- center = this.unproject(swPoint.add(nePoint).divideBy(2).add(paddingOffset), zoom);
+L.Renderer = L.Layer.extend({
- return {
- center: center,
- zoom: zoom
- };
+ // @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
},
- // @method fitBounds(bounds: LatLngBounds, options: fitBounds options): this
- // Sets a map view that contains the given geographical bounds with the
- // maximum zoom level possible.
- fitBounds: function (bounds, options) {
+ initialize: function (options) {
+ L.setOptions(this, options);
+ L.stamp(this);
+ },
- bounds = L.latLngBounds(bounds);
+ onAdd: function () {
+ if (!this._container) {
+ this._initContainer(); // defined by renderer implementations
- if (!bounds.isValid()) {
- throw new Error('Bounds are not valid.');
+ if (this._zoomAnimated) {
+ L.DomUtil.addClass(this._container, 'leaflet-zoom-animated');
+ }
}
- var target = this._getBoundsCenterZoom(bounds, options);
- return this.setView(target.center, target.zoom, options);
+ this.getPane().appendChild(this._container);
+ this._update();
},
- // @method fitWorld(options?: fitBounds options): this
- // Sets a map view that mostly contains the whole world with the maximum
- // zoom level possible.
- fitWorld: function (options) {
- return this.fitBounds([[-90, -180], [90, 180]], options);
+ onRemove: function () {
+ L.DomUtil.remove(this._container);
},
- // @method panTo(latlng: LatLng, options?: Pan options): this
- // Pans the map to a given center.
- panTo: function (center, options) { // (LatLng)
- return this.setView(center, this._zoom, {pan: options});
+ getEvents: function () {
+ var events = {
+ viewreset: this._reset,
+ zoom: this._onZoom,
+ moveend: this._update
+ };
+ if (this._zoomAnimated) {
+ events.zoomanim = this._onAnimZoom;
+ }
+ return events;
},
- // @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');
-
- this._rawPanBy(L.point(offset));
-
- this.fire('move');
- return this.fire('moveend');
+ _onAnimZoom: function (ev) {
+ this._updateTransform(ev.center, ev.zoom);
},
- // @method setMaxBounds(bounds: Bounds): this
- // Restricts the map view to the given bounds (see the [maxBounds](#map-maxbounds) option).
- setMaxBounds: function (bounds) {
- bounds = L.latLngBounds(bounds);
+ _onZoom: function () {
+ this._updateTransform(this._map.getCenter(), this._map.getZoom());
+ },
- if (!bounds.isValid()) {
- this.options.maxBounds = null;
- return this.off('moveend', this._panInsideMaxBounds);
- } else if (this.options.maxBounds) {
- this.off('moveend', this._panInsideMaxBounds);
- }
+ _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),
- this.options.maxBounds = bounds;
+ topLeftOffset = viewHalf.multiplyBy(-scale).add(position).add(viewHalf).subtract(centerOffset);
- if (this._loaded) {
- this._panInsideMaxBounds();
+ if (L.Browser.any3d) {
+ L.DomUtil.setTransform(this._container, topLeftOffset, scale);
+ } else {
+ L.DomUtil.setPosition(this._container, topLeftOffset);
}
+ },
- return this.on('moveend', this._panInsideMaxBounds);
+ _reset: function () {
+ this._update();
+ this._updateTransform(this._center, this._zoom);
},
- // @method setMinZoom(zoom: Number): this
- // Sets the lower limit for the available zoom levels (see the [minZoom](#map-minzoom) option).
- setMinZoom: function (zoom) {
- this.options.minZoom = 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();
- if (this._loaded && this.getZoom() < this.options.minZoom) {
- return this.setZoom(zoom);
- }
+ this._bounds = new L.Bounds(min, min.add(size.multiplyBy(1 + p * 2)).round());
+
+ this._center = this._map.getCenter();
+ this._zoom = this._map.getZoom();
+ }
+});
- return this;
- },
- // @method setMaxZoom(zoom: Number): this
- // Sets the upper limit for the available zoom levels (see the [maxZoom](#map-maxzoom) option).
- setMaxZoom: function (zoom) {
- this.options.maxZoom = zoom;
+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 (this._loaded && (this.getZoom() > this.options.maxZoom)) {
- return this.setZoom(zoom);
+ 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();
}
- return this;
+ if (!this.hasLayer(renderer)) {
+ this.addLayer(renderer);
+ }
+ return renderer;
},
- // @method panInsideBounds(bounds: LatLngBounds, options?: Pan options): this
- // Pans the map to the closest view that would lie inside the given bounds (if it's not already), controlling the animation using the options specific, if any.
- panInsideBounds: function (bounds, options) {
- this._enforcingBounds = true;
- var center = this.getCenter(),
- newCenter = this._limitCenter(center, this._zoom, L.latLngBounds(bounds));
-
- if (!center.equals(newCenter)) {
- this.panTo(newCenter, options);
+ _getPaneRenderer: function (name) {
+ if (name === 'overlayPane' || name === undefined) {
+ return false;
}
- this._enforcingBounds = false;
- return this;
- },
+ 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;
+ }
+});
- // @method invalidateSize(options: Zoom/Pan options): this
- // Checks if the map container size changed and updates the map if so —
- // call it after you've changed the map size dynamically, also animating
- // pan by default. If `options.pan` is `false`, panning will not occur.
- // If `options.debounceMoveend` is `true`, it will delay `moveend` event so
- // that it doesn't happen often even if the method is called many
- // times in a row.
- // @alternative
- // @method invalidateSize(animate: Boolean): this
- // Checks if the map container size changed and updates the map if so —
- // call it after you've changed the map size dynamically, also animating
- // pan by default.
- invalidateSize: function (options) {
- if (!this._loaded) { return this; }
- options = L.extend({
- animate: false,
- pan: true
- }, options === true ? {animate: true} : options);
+/*
+ * @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`.
+ */
- var oldSize = this.getSize();
- this._sizeChanged = true;
- this._lastCenter = null;
+L.Path = L.Layer.extend({
- var newSize = this.getSize(),
- oldCenter = oldSize.divideBy(2).round(),
- newCenter = newSize.divideBy(2).round(),
- offset = oldCenter.subtract(newCenter);
+ // @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,
- if (!offset.x && !offset.y) { return this; }
+ // @option color: String = '#3388ff'
+ // Stroke color
+ color: '#3388ff',
- if (options.animate && options.pan) {
- this.panBy(offset);
+ // @option weight: Number = 3
+ // Stroke width in pixels
+ weight: 3,
- } else {
- if (options.pan) {
- this._rawPanBy(offset);
- }
+ // @option opacity: Number = 1.0
+ // Stroke opacity
+ opacity: 1,
- this.fire('move');
+ // @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',
- if (options.debounceMoveend) {
- clearTimeout(this._sizeTimer);
- this._sizeTimer = setTimeout(L.bind(this.fire, this, 'moveend'), 200);
- } else {
- this.fire('moveend');
- }
- }
+ // @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',
- // @section Map state change events
- // @event resize: ResizeEvent
- // Fired when the map is resized.
- return this.fire('resize', {
- oldSize: oldSize,
- newSize: newSize
- });
- },
+ // @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,
- // @section Methods for modifying map state
- // @method stop(): this
- // Stops the currently running `panTo` or `flyTo` animation, if any.
- stop: function () {
- this.setZoom(this._limitZoom(this._zoom));
- if (!this.options.zoomSnap) {
- this.fire('viewreset');
- }
- return this._stop();
- },
+ // @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,
- // 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; }
+ // @option fillColor: String = *
+ // Fill color. Defaults to the value of the [`color`](#path-color) option
+ fillColor: null,
- var handler = this[name] = new HandlerClass(this);
+ // @option fillOpacity: Number = 0.2
+ // Fill opacity.
+ fillOpacity: 0.2,
- this._handlers.push(handler);
+ // @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',
- if (this.options[name]) {
- handler.enable();
- }
+ // className: '',
- return this;
+ // Option inherited from "Interactive layer" abstract class
+ interactive: true
},
- // @method remove(): this
- // Destroys the map and clears all related event listeners.
- remove: function () {
-
- this._initEvents(true);
-
- try {
- // throws error in IE6-8
- delete this._container._leaflet;
- } catch (e) {
- this._container._leaflet = undefined;
- }
-
- L.DomUtil.remove(this._mapPane);
+ beforeAdd: function (map) {
+ // Renderer is set here because we need to call renderer.getEvents
+ // before this.getEvents.
+ this._renderer = map.getRenderer(this);
+ },
- if (this._clearControlPos) {
- this._clearControlPos();
- }
+ onAdd: function () {
+ this._renderer._initPath(this);
+ this._reset();
+ this._renderer._addPath(this);
+ this._renderer.on('update', this._update, this);
+ },
- this._clearHandlers();
+ onRemove: function () {
+ this._renderer._removePath(this);
+ this._renderer.off('update', this._update, this);
+ },
- 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');
- }
+ getEvents: function () {
+ return {
+ zoomend: this._project,
+ viewreset: this._reset
+ };
+ },
- for (var i in this._layers) {
- this._layers[i].remove();
+ // @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;
},
- // @section Other Methods
- // @method createPane(name: String, container?: HTMLElement): HTMLElement
- // Creates a new [map pane](#map-pane) with the given name if it doesn't exist already,
- // then returns it. The pane is created as a children of `container`, or
- // as a children of the main map pane if not set.
- createPane: function (name, container) {
- var className = 'leaflet-pane' + (name ? ' leaflet-' + name.replace('Pane', '') + '-pane' : ''),
- pane = L.DomUtil.create('div', className, container || this._mapPane);
-
- if (name) {
- this._panes[name] = pane;
+ // @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 pane;
+ return this;
},
- // @section Methods for Getting Map State
-
- // @method getCenter(): LatLng
- // Returns the geographical center of the map view
- getCenter: function () {
- this._checkIfLoaded();
-
- if (this._lastCenter && !this._moved()) {
- return this._lastCenter;
+ // @method bringToFront(): this
+ // Brings the layer to the top of all path layers.
+ bringToFront: function () {
+ if (this._renderer) {
+ this._renderer._bringToFront(this);
}
- return this.layerPointToLatLng(this._getCenterLayerPoint());
+ return this;
},
- // @method getZoom(): Number
- // Returns the current zoom level of the map view
- getZoom: function () {
- return this._zoom;
+ // @method bringToBack(): this
+ // Brings the layer to the bottom of all path layers.
+ bringToBack: function () {
+ if (this._renderer) {
+ this._renderer._bringToBack(this);
+ }
+ return this;
},
- // @method getBounds(): LatLngBounds
- // Returns the geographical bounds visible in the current map view
- getBounds: function () {
- var bounds = this.getPixelBounds(),
- sw = this.unproject(bounds.getBottomLeft()),
- ne = this.unproject(bounds.getTopRight());
-
- return new L.LatLngBounds(sw, ne);
+ getElement: function () {
+ return this._path;
},
- // @method getMinZoom(): Number
- // Returns the minimum zoom level of the map (if set in the `minZoom` option of the map or of any layers), or `0` by default.
- getMinZoom: function () {
- return this.options.minZoom === undefined ? this._layersMinZoom || 0 : this.options.minZoom;
+ _reset: function () {
+ // defined in children classes
+ this._project();
+ this._update();
},
- // @method getMaxZoom(): Number
- // Returns the maximum zoom level of the map (if set in the `maxZoom` option of the map or of any layers).
- getMaxZoom: function () {
- return this.options.maxZoom === undefined ?
- (this._layersMaxZoom === undefined ? Infinity : this._layersMaxZoom) :
- this.options.maxZoom;
- },
+ _clickTolerance: function () {
+ // used when doing hit detection for Canvas layers
+ return (this.options.stroke ? this.options.weight / 2 : 0) + (L.Browser.touch ? 10 : 0);
+ }
+});
- // @method getBoundsZoom(bounds: LatLngBounds, inside?: Boolean): Number
- // Returns the maximum zoom level on which the given bounds fit to the map
- // view in its entirety. If `inside` (optional) is set to `true`, the method
- // instead returns the minimum zoom level on which the map view fits into
- // the given bounds in its entirety.
- getBoundsZoom: function (bounds, inside, padding) { // (LatLngBounds[, Boolean, Point]) -> Number
- bounds = L.latLngBounds(bounds);
- padding = L.point(padding || [0, 0]);
- var zoom = this.getZoom() || 0,
- min = this.getMinZoom(),
- max = this.getMaxZoom(),
- nw = bounds.getNorthWest(),
- se = bounds.getSouthEast(),
- size = this.getSize().subtract(padding),
- boundsSize = this.project(se, zoom).subtract(this.project(nw, zoom)),
- snap = L.Browser.any3d ? this.options.zoomSnap : 1;
- var scale = Math.min(size.x / boundsSize.x, size.y / boundsSize.y);
- zoom = this.getScaleZoom(scale, zoom);
+/*
+ * @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);
+ }
+};
- if (snap) {
- zoom = Math.round(zoom / (snap / 100)) * (snap / 100); // don't jump if within 1% of a snap level
- zoom = inside ? Math.ceil(zoom / snap) * snap : Math.floor(zoom / snap) * snap;
- }
- return Math.max(min, Math.min(max, zoom));
- },
- // @method getSize(): Point
- // Returns the current size of the map container (in pixels).
- getSize: function () {
- if (!this._size || this._sizeChanged) {
- this._size = new L.Point(
- this._container.clientWidth,
- this._container.clientHeight);
+/*
+ * @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]]
+ * ];
+ * ```
+ */
- this._sizeChanged = false;
- }
- return this._size.clone();
- },
+L.Polyline = L.Path.extend({
- // @method getPixelBounds(): Bounds
- // Returns the bounds of the current map view in projected pixel
- // coordinates (sometimes useful in layer and overlay implementations).
- getPixelBounds: function (center, zoom) {
- var topLeftPoint = this._getTopLeftPoint(center, zoom);
- return new L.Bounds(topLeftPoint, topLeftPoint.add(this.getSize()));
- },
+ // @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,
- // TODO: Check semantics - isn't the pixel origin the 0,0 coord relative to
- // the map pane? "left point of the map layer" can be confusing, specially
- // since there can be negative offsets.
- // @method getPixelOrigin(): Point
- // Returns the projected pixel coordinates of the top left point of
- // the map layer (useful in custom layer and overlay implementations).
- getPixelOrigin: function () {
- this._checkIfLoaded();
- return this._pixelOrigin;
+ // @option noClip: Boolean = false
+ // Disable polyline clipping.
+ noClip: false
},
- // @method getPixelWorldBounds(zoom?: Number): Bounds
- // Returns the world's bounds in pixel coordinates for zoom level `zoom`.
- // If `zoom` is omitted, the map's current zoom level is used.
- getPixelWorldBounds: function (zoom) {
- return this.options.crs.getProjectedBounds(zoom === undefined ? this.getZoom() : zoom);
+ initialize: function (latlngs, options) {
+ L.setOptions(this, options);
+ this._setLatLngs(latlngs);
},
- // @section Other Methods
-
- // @method getPane(pane: String|HTMLElement): HTMLElement
- // Returns a [map pane](#map-pane), given its name or its HTML element (its identity).
- getPane: function (pane) {
- return typeof pane === 'string' ? this._panes[pane] : pane;
+ // @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 getPanes(): Object
- // Returns a plain object containing the names of all [panes](#map-pane) as keys and
- // the panes as values.
- getPanes: function () {
- return this._panes;
+ // @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 getContainer: HTMLElement
- // Returns the HTML element that contains the map.
- getContainer: function () {
- return this._container;
+ // @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;
- // @section Conversion Methods
+ for (var j = 0, jLen = this._parts.length; j < jLen; j++) {
+ var points = this._parts[j];
- // @method getZoomScale(toZoom: Number, fromZoom: Number): Number
- // Returns the scale factor to be applied to a map transition from zoom level
- // `fromZoom` to `toZoom`. Used internally to help with zoom animations.
- getZoomScale: function (toZoom, fromZoom) {
- // TODO replace with universal implementation after refactoring projections
- var crs = this.options.crs;
- fromZoom = fromZoom === undefined ? this._zoom : fromZoom;
- return crs.scale(toZoom) / crs.scale(fromZoom);
- },
+ for (var i = 1, len = points.length; i < len; i++) {
+ p1 = points[i - 1];
+ p2 = points[i];
- // @method getScaleZoom(scale: Number, fromZoom: Number): Number
- // Returns the zoom level that the map would end up at, if it is at `fromZoom`
- // level and everything is scaled by a factor of `scale`. Inverse of
- // [`getZoomScale`](#map-getZoomScale).
- getScaleZoom: function (scale, fromZoom) {
- var crs = this.options.crs;
- fromZoom = fromZoom === undefined ? this._zoom : fromZoom;
- return crs.zoom(scale * crs.scale(fromZoom));
- },
+ var sqDist = closest(p, p1, p2, true);
- // @method project(latlng: LatLng, zoom: Number): Point
- // Projects a geographical coordinate `LatLng` according to the projection
- // of the map's CRS, then scales it according to `zoom` and the CRS's
- // `Transformation`. The result is pixel coordinate relative to
- // the CRS origin.
- project: function (latlng, zoom) {
- zoom = zoom === undefined ? this._zoom : zoom;
- return this.options.crs.latLngToPoint(L.latLng(latlng), zoom);
+ if (sqDist < minDistance) {
+ minDistance = sqDist;
+ minPoint = closest(p, p1, p2);
+ }
+ }
+ }
+ if (minPoint) {
+ minPoint.distance = Math.sqrt(minDistance);
+ }
+ return minPoint;
},
- // @method unproject(point: Point, zoom: Number): LatLng
- // Inverse of [`project`](#map-project).
- unproject: function (point, zoom) {
- zoom = zoom === undefined ? this._zoom : zoom;
- return this.options.crs.pointToLatLng(L.point(point), zoom);
- },
+ // @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()');
+ }
- // @method layerPointToLatLng(point: Point): LatLng
- // Given a pixel coordinate relative to the [origin pixel](#map-getpixelorigin),
- // returns the corresponding geographical coordinate (for the current zoom level).
- layerPointToLatLng: function (point) {
- var projectedPoint = L.point(point).add(this.getPixelOrigin());
- return this.unproject(projectedPoint);
- },
+ var i, halfDist, segDist, dist, p1, p2, ratio,
+ points = this._rings[0],
+ len = points.length;
- // @method latLngToLayerPoint(latlng: LatLng): Point
- // Given a geographical coordinate, returns the corresponding pixel coordinate
- // relative to the [origin pixel](#map-getpixelorigin).
- latLngToLayerPoint: function (latlng) {
- var projectedPoint = this.project(L.latLng(latlng))._round();
- return projectedPoint._subtract(this.getPixelOrigin());
- },
+ if (!len) { return null; }
- // @method wrapLatLng(latlng: LatLng): LatLng
- // Returns a `LatLng` where `lat` and `lng` has been wrapped according to the
- // map's CRS's `wrapLat` and `wrapLng` properties, if they are outside the
- // CRS's bounds.
- // By default this means longitude is wrapped around the dateline so its
- // value is between -180 and +180 degrees.
- wrapLatLng: function (latlng) {
- return this.options.crs.wrapLatLng(L.latLng(latlng));
- },
+ // polyline centroid algorithm; only uses the first ring if there are multiple
- // @method distance(latlng1: LatLng, latlng2: LatLng): Number
- // Returns the distance between two geographical coordinates according to
- // the map's CRS. By default this measures distance in meters.
- distance: function (latlng1, latlng2) {
- return this.options.crs.distance(L.latLng(latlng1), L.latLng(latlng2));
- },
+ for (i = 0, halfDist = 0; i < len - 1; i++) {
+ halfDist += points[i].distanceTo(points[i + 1]) / 2;
+ }
- // @method containerPointToLayerPoint(point: Point): Point
- // Given a pixel coordinate relative to the map container, returns the corresponding
- // pixel coordinate relative to the [origin pixel](#map-getpixelorigin).
- containerPointToLayerPoint: function (point) { // (Point)
- return L.point(point).subtract(this._getMapPanePos());
- },
+ // 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]);
+ }
- // @method layerPointToContainerPoint(point: Point): Point
- // Given a pixel coordinate relative to the [origin pixel](#map-getpixelorigin),
- // returns the corresponding pixel coordinate relative to the map container.
- layerPointToContainerPoint: function (point) { // (Point)
- return L.point(point).add(this._getMapPanePos());
- },
+ for (i = 0, dist = 0; i < len - 1; i++) {
+ p1 = points[i];
+ p2 = points[i + 1];
+ segDist = p1.distanceTo(p2);
+ dist += segDist;
- // @method containerPointToLatLng(point: Point): Point
- // Given a pixel coordinate relative to the map container, returns
- // the corresponding geographical coordinate (for the current zoom level).
- containerPointToLatLng: function (point) {
- var layerPoint = this.containerPointToLayerPoint(L.point(point));
- return this.layerPointToLatLng(layerPoint);
+ 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 latLngToContainerPoint(latlng: LatLng): Point
- // Given a geographical coordinate, returns the corresponding pixel coordinate
- // relative to the map container.
- latLngToContainerPoint: function (latlng) {
- return this.layerPointToContainerPoint(this.latLngToLayerPoint(L.latLng(latlng)));
+ // @method getBounds(): LatLngBounds
+ // Returns the `LatLngBounds` of the path.
+ getBounds: function () {
+ return this._bounds;
},
- // @method mouseEventToContainerPoint(ev: MouseEvent): Point
- // Given a MouseEvent object, returns the pixel coordinate relative to the
- // map container where the event took place.
- mouseEventToContainerPoint: function (e) {
- return L.DomEvent.getMousePosition(e, this._container);
+ // @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();
},
- // @method mouseEventToLayerPoint(ev: MouseEvent): Point
- // Given a MouseEvent object, returns the pixel coordinate relative to
- // the [origin pixel](#map-getpixelorigin) where the event took place.
- mouseEventToLayerPoint: function (e) {
- return this.containerPointToLayerPoint(this.mouseEventToContainerPoint(e));
+ _setLatLngs: function (latlngs) {
+ this._bounds = new L.LatLngBounds();
+ this._latlngs = this._convertLatLngs(latlngs);
},
- // @method mouseEventToLatLng(ev: MouseEvent): LatLng
- // Given a MouseEvent object, returns geographical coordinate where the
- // event took place.
- mouseEventToLatLng: function (e) { // (MouseEvent)
- return this.layerPointToLatLng(this.mouseEventToLayerPoint(e));
+ _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);
- // map initialization methods
-
- _initContainer: function (id) {
- var container = this._container = L.DomUtil.get(id);
-
- if (!container) {
- throw new Error('Map container not found.');
- } else if (container._leaflet) {
- throw new Error('Map container is already initialized.');
+ 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]);
+ }
}
- L.DomEvent.addListener(container, 'scroll', this._onScroll, this);
- container._leaflet = true;
+ return result;
},
- _initLayout: function () {
- var container = this._container;
-
- this._fadeAnimated = this.options.fadeAnimation && L.Browser.any3d;
-
- L.DomUtil.addClass(container, 'leaflet-container' +
- (L.Browser.touch ? ' leaflet-touch' : '') +
- (L.Browser.retina ? ' leaflet-retina' : '') +
- (L.Browser.ielt9 ? ' leaflet-oldie' : '') +
- (L.Browser.safari ? ' leaflet-safari' : '') +
- (this._fadeAnimated ? ' leaflet-fade-anim' : ''));
-
- var position = L.DomUtil.getStyle(container, 'position');
+ _project: function () {
+ var pxBounds = new L.Bounds();
+ this._rings = [];
+ this._projectLatlngs(this._latlngs, this._rings, pxBounds);
- if (position !== 'absolute' && position !== 'relative' && position !== 'fixed') {
- container.style.position = 'relative';
- }
+ var w = this._clickTolerance(),
+ p = new L.Point(w, w);
- this._initPanes();
-
- if (this._initControlPos) {
- this._initControlPos();
+ if (this._bounds.isValid() && pxBounds.isValid()) {
+ pxBounds.min._subtract(p);
+ pxBounds.max._add(p);
+ this._pxBounds = pxBounds;
}
},
- _initPanes: function () {
- var panes = this._panes = {};
- this._paneRenderers = {};
+ // 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;
- // @section
- //
- // Panes are DOM elements used to control the ordering of layers on the map. You
- // can access panes with [`map.getPane`](#map-getpane) or
- // [`map.getPanes`](#map-getpanes) methods. New panes can be created with the
- // [`map.createPane`](#map-createpane) method.
- //
- // Every map has the following default panes that differ only in zIndex.
- //
- // @pane mapPane: HTMLElement = 'auto'
- // Pane that contains all other map panes
-
- this._mapPane = this.createPane('mapPane', this._container);
- L.DomUtil.setPosition(this._mapPane, new L.Point(0, 0));
-
- // @pane tilePane: HTMLElement = 200
- // Pane for `GridLayer`s and `TileLayer`s
- this.createPane('tilePane');
- // @pane overlayPane: HTMLElement = 400
- // Pane for vector overlays (`Path`s), like `Polyline`s and `Polygon`s
- this.createPane('shadowPane');
- // @pane shadowPane: HTMLElement = 500
- // Pane for overlay shadows (e.g. `Marker` shadows)
- this.createPane('overlayPane');
- // @pane markerPane: HTMLElement = 600
- // Pane for `Icon`s of `Marker`s
- this.createPane('markerPane');
- // @pane tooltipPane: HTMLElement = 650
- // Pane for tooltip.
- this.createPane('tooltipPane');
- // @pane popupPane: HTMLElement = 700
- // Pane for `Popup`s.
- this.createPane('popupPane');
-
- if (!this.options.markerZoomAnimation) {
- L.DomUtil.addClass(panes.markerPane, 'leaflet-zoom-hide');
- L.DomUtil.addClass(panes.shadowPane, 'leaflet-zoom-hide');
- }
- },
-
-
- // private methods that modify map state
-
- // @section Map state change events
- _resetView: function (center, zoom) {
- L.DomUtil.setPosition(this._mapPane, new L.Point(0, 0));
-
- var loading = !this._loaded;
- this._loaded = true;
- zoom = this._limitZoom(zoom);
-
- this.fire('viewprereset');
-
- var zoomChanged = this._zoom !== zoom;
- this
- ._moveStart(zoomChanged)
- ._move(center, zoom)
- ._moveEnd(zoomChanged);
-
- // @event viewreset: Event
- // Fired when the map needs to redraw its content (this usually happens
- // on map zoom or load). Very useful for creating custom overlays.
- this.fire('viewreset');
-
- // @event load: Event
- // Fired when the map is initialized (when its center and zoom are set
- // for the first time).
- if (loading) {
- this.fire('load');
+ 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);
+ }
}
},
- _moveStart: function (zoomChanged) {
- // @event zoomstart: Event
- // Fired when the map zoom is about to change (e.g. before zoom animation).
- // @event movestart: Event
- // Fired when the view of the map starts changing (e.g. user starts dragging the map).
- if (zoomChanged) {
- this.fire('zoomstart');
- }
- return this.fire('movestart');
- },
+ // clip polyline by renderer bounds so that we have less to render for performance
+ _clipPoints: function () {
+ var bounds = this._renderer._bounds;
- _move: function (center, zoom, data) {
- if (zoom === undefined) {
- zoom = this._zoom;
+ this._parts = [];
+ if (!this._pxBounds || !this._pxBounds.intersects(bounds)) {
+ return;
}
- var zoomChanged = this._zoom !== zoom;
- this._zoom = zoom;
- this._lastCenter = center;
- this._pixelOrigin = this._getNewPixelOrigin(center);
-
- // @event zoom: Event
- // Fired repeteadly during any change in zoom level, including zoom
- // and fly animations.
- if (zoomChanged || (data && data.pinch)) { // Always fire 'zoom' if pinching because #3530
- this.fire('zoom', data);
+ if (this.options.noClip) {
+ this._parts = this._rings;
+ return;
}
- // @event move: Event
- // Fired repeteadly during any movement of the map, including pan and
- // fly animations.
- return this.fire('move', data);
- },
-
- _moveEnd: function (zoomChanged) {
- // @event zoomend: Event
- // Fired when the map has changed, after any animations.
- if (zoomChanged) {
- this.fire('zoomend');
- }
+ var parts = this._parts,
+ i, j, k, len, len2, segment, points;
- // @event moveend: Event
- // Fired when the center of the map stops changing (e.g. user stopped
- // dragging the map).
- return this.fire('moveend');
- },
+ for (i = 0, k = 0, len = this._rings.length; i < len; i++) {
+ points = this._rings[i];
- _stop: function () {
- L.Util.cancelAnimFrame(this._flyToFrame);
- if (this._panAnim) {
- this._panAnim.stop();
- }
- return this;
- },
+ for (j = 0, len2 = points.length; j < len2 - 1; j++) {
+ segment = L.LineUtil.clipSegment(points[j], points[j + 1], bounds, j, true);
- _rawPanBy: function (offset) {
- L.DomUtil.setPosition(this._mapPane, this._getMapPanePos().subtract(offset));
- },
+ if (!segment) { continue; }
- _getZoomSpan: function () {
- return this.getMaxZoom() - this.getMinZoom();
- },
+ parts[k] = parts[k] || [];
+ parts[k].push(segment[0]);
- _panInsideMaxBounds: function () {
- if (!this._enforcingBounds) {
- this.panInsideBounds(this.options.maxBounds);
+ // 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++;
+ }
+ }
}
},
- _checkIfLoaded: function () {
- if (!this._loaded) {
- throw new Error('Set map center and zoom first.');
+ // 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);
}
},
- // DOM event handling
-
- // @section Interaction events
- _initEvents: function (remove) {
- if (!L.DomEvent) { return; }
+ _update: function () {
+ if (!this._map) { return; }
- this._targets = {};
- this._targets[L.stamp(this._container)] = this;
+ this._clipPoints();
+ this._simplifyPoints();
+ this._updatePath();
+ },
- var onOff = remove ? 'off' : 'on';
+ _updatePath: function () {
+ this._renderer._updatePoly(this);
+ }
+});
- // @event click: MouseEvent
- // Fired when the user clicks (or taps) the map.
- // @event dblclick: MouseEvent
- // Fired when the user double-clicks (or double-taps) the map.
- // @event mousedown: MouseEvent
- // Fired when the user pushes the mouse button on the map.
- // @event mouseup: MouseEvent
- // Fired when the user releases the mouse button on the map.
- // @event mouseover: MouseEvent
- // Fired when the mouse enters the map.
- // @event mouseout: MouseEvent
- // Fired when the mouse leaves the map.
- // @event mousemove: MouseEvent
- // Fired while the mouse moves over the map.
- // @event contextmenu: MouseEvent
- // Fired when the user pushes the right mouse button on the map, prevents
- // default browser context menu from showing if there are listeners on
- // this event. Also fired on mobile when the user holds a single touch
- // for a second (also called long press).
- // @event keypress: Event
- // Fired when the user presses a key from the keyboard while the map is focused.
- L.DomEvent[onOff](this._container, 'click dblclick mousedown mouseup ' +
- 'mouseover mouseout mousemove contextmenu keypress', this._handleDOMEvent, 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);
+};
- if (this.options.trackResize) {
- L.DomEvent[onOff](window, 'resize', this._onResize, this);
- }
+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');
+};
- if (L.Browser.any3d && this.options.transform3DLimit) {
- this[onOff]('moveend', this._onMoveEnd);
- }
- },
- _onResize: function () {
- L.Util.cancelAnimFrame(this._resizeRequest);
- this._resizeRequest = L.Util.requestAnimFrame(
- function () { this.invalidateSize({debounceMoveend: true}); }, this);
- },
- _onScroll: function () {
- this._container.scrollTop = 0;
- this._container.scrollLeft = 0;
- },
+/*
+ * @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;
+};
- _onMoveEnd: function () {
- var pos = this._getMapPanePos();
- if (Math.max(Math.abs(pos.x), Math.abs(pos.y)) >= this.options.transform3DLimit) {
- // https://bugzilla.mozilla.org/show_bug.cgi?id=1203873 but Webkit also have
- // a pixel offset on very high values, see: http://jsfiddle.net/dg6r5hhb/
- this._resetView(this.getCenter(), this.getZoom());
- }
- },
-
- _findEventTargets: function (e, type) {
- var targets = [],
- target,
- isHover = type === 'mouseout' || type === 'mouseover',
- src = e.target || e.srcElement,
- dragging = false;
-
- while (src) {
- target = this._targets[L.stamp(src)];
- if (target && (type === 'click' || type === 'preclick') && !e._simulated && this._draggableMoved(target)) {
- // Prevent firing click after you just dragged an object.
- dragging = true;
- break;
- }
- if (target && target.listens(type, true)) {
- if (isHover && !L.DomEvent._isExternalTarget(src, e)) { break; }
- targets.push(target);
- if (isHover) { break; }
- }
- if (src === this._container) { break; }
- src = src.parentNode;
- }
- if (!targets.length && !dragging && !isHover && L.DomEvent._isExternalTarget(src, e)) {
- targets = [this];
- }
- return targets;
- },
- _handleDOMEvent: function (e) {
- if (!this._loaded || L.DomEvent._skipped(e)) { return; }
- var type = e.type === 'keypress' && e.keyCode === 13 ? 'click' : e.type;
+/*
+ * @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 (type === 'mousedown') {
- // prevents outline when clicking on keyboard-focusable element
- L.DomUtil.preventOutline(e.target || e.srcElement);
- }
+L.Polygon = L.Polyline.extend({
- this._fireDOMEvent(e, type);
+ options: {
+ fill: true
},
- _fireDOMEvent: function (e, type, targets) {
+ isEmpty: function () {
+ return !this._latlngs.length || !this._latlngs[0].length;
+ },
- if (e.type === 'click') {
- // Fire a synthetic 'preclick' event which propagates up (mainly for closing popups).
- // @event preclick: MouseEvent
- // Fired before mouse click on the map (sometimes useful when you
- // want something to happen on click before any existing click
- // handlers start running).
- var synth = L.Util.extend({}, e);
- synth.type = 'preclick';
- this._fireDOMEvent(synth, synth.type, targets);
+ 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()');
}
- if (e._stopped) { return; }
+ var i, j, p1, p2, f, area, x, y, center,
+ points = this._rings[0],
+ len = points.length;
- // Find the layer the event is propagating from and its parents.
- targets = (targets || []).concat(this._findEventTargets(e, type));
+ if (!len) { return null; }
- if (!targets.length) { return; }
+ // polygon centroid algorithm; only uses the first ring if there are multiple
- var target = targets[0];
- if (type === 'contextmenu' && target.listens(type, true)) {
- L.DomEvent.preventDefault(e);
- }
+ area = x = y = 0;
- var data = {
- originalEvent: e
- };
+ for (i = 0, j = len - 1; i < len; j = i++) {
+ p1 = points[i];
+ p2 = points[j];
- if (e.type !== 'keypress') {
- var isMarker = target instanceof L.Marker;
- data.containerPoint = isMarker ?
- this.latLngToContainerPoint(target.getLatLng()) : this.mouseEventToContainerPoint(e);
- data.layerPoint = this.containerPointToLayerPoint(data.containerPoint);
- data.latlng = isMarker ? target.getLatLng() : this.layerPointToLatLng(data.layerPoint);
+ f = p1.y * p2.x - p2.y * p1.x;
+ x += (p1.x + p2.x) * f;
+ y += (p1.y + p2.y) * f;
+ area += f * 3;
}
- for (var i = 0; i < targets.length; i++) {
- targets[i].fire(type, data, true);
- if (data.originalEvent._stopped ||
- (targets[i].options.nonBubblingEvents && L.Util.indexOf(targets[i].options.nonBubblingEvents, type) !== -1)) { return; }
+ 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);
},
- _draggableMoved: function (obj) {
- obj = obj.dragging && obj.dragging.enabled() ? obj : this;
- return (obj.dragging && obj.dragging.moved()) || (this.boxZoom && this.boxZoom.moved());
- },
+ _convertLatLngs: function (latlngs) {
+ var result = L.Polyline.prototype._convertLatLngs.call(this, latlngs),
+ len = result.length;
- _clearHandlers: function () {
- for (var i = 0, len = this._handlers.length; i < len; i++) {
- this._handlers[i].disable();
+ // 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;
},
- // @section Other Methods
-
- // @method whenReady(fn: Function, context?: Object): this
- // Runs the given function `fn` when the map gets initialized with
- // a view (center and zoom) and at least one layer, or immediately
- // if it's already initialized, optionally passing a function context.
- whenReady: function (callback, context) {
- if (this._loaded) {
- callback.call(context || this, {target: this});
- } else {
- this.on('load', callback, context);
+ _setLatLngs: function (latlngs) {
+ L.Polyline.prototype._setLatLngs.call(this, latlngs);
+ if (L.Polyline._flat(this._latlngs)) {
+ this._latlngs = [this._latlngs];
}
- return this;
- },
-
-
- // private methods for getting map state
-
- _getMapPanePos: function () {
- return L.DomUtil.getPosition(this._mapPane) || new L.Point(0, 0);
- },
-
- _moved: function () {
- var pos = this._getMapPanePos();
- return pos && !pos.equals([0, 0]);
- },
-
- _getTopLeftPoint: function (center, zoom) {
- var pixelOrigin = center && zoom !== undefined ?
- this._getNewPixelOrigin(center, zoom) :
- this.getPixelOrigin();
- return pixelOrigin.subtract(this._getMapPanePos());
- },
-
- _getNewPixelOrigin: function (center, zoom) {
- var viewHalf = this.getSize()._divideBy(2);
- return this.project(center, zoom)._subtract(viewHalf)._add(this._getMapPanePos())._round();
- },
-
- _latLngToNewLayerPoint: function (latlng, zoom, center) {
- var topLeft = this._getNewPixelOrigin(center, zoom);
- return this.project(latlng, zoom)._subtract(topLeft);
- },
-
- // layer point of the current center
- _getCenterLayerPoint: function () {
- return this.containerPointToLayerPoint(this.getSize()._divideBy(2));
},
- // offset of the specified place to the current center in pixels
- _getCenterOffset: function (latlng) {
- return this.latLngToLayerPoint(latlng).subtract(this._getCenterLayerPoint());
+ _defaultShape: function () {
+ return L.Polyline._flat(this._latlngs[0]) ? this._latlngs[0] : this._latlngs[0][0];
},
- // adjust center for view to get inside bounds
- _limitCenter: function (center, zoom, bounds) {
+ _clipPoints: function () {
+ // polygons need a different clipping algorithm so we redefine that
- if (!bounds) { return center; }
+ var bounds = this._renderer._bounds,
+ w = this.options.weight,
+ p = new L.Point(w, w);
- var centerPoint = this.project(center, zoom),
- viewHalf = this.getSize().divideBy(2),
- viewBounds = new L.Bounds(centerPoint.subtract(viewHalf), centerPoint.add(viewHalf)),
- offset = this._getBoundsOffset(viewBounds, bounds, zoom);
+ // increase clip padding by stroke width to avoid stroke on clip edges
+ bounds = new L.Bounds(bounds.min.subtract(p), bounds.max.add(p));
- // If offset is less than a pixel, ignore.
- // This prevents unstable projections from getting into
- // an infinite loop of tiny offsets.
- if (offset.round().equals([0, 0])) {
- return center;
+ this._parts = [];
+ if (!this._pxBounds || !this._pxBounds.intersects(bounds)) {
+ return;
}
- return this.unproject(centerPoint.add(offset), zoom);
- },
-
- // adjust offset for view to get inside bounds
- _limitOffset: function (offset, bounds) {
- if (!bounds) { return offset; }
-
- var viewBounds = this.getPixelBounds(),
- newBounds = new L.Bounds(viewBounds.min.add(offset), viewBounds.max.add(offset));
-
- return offset.add(this._getBoundsOffset(newBounds, bounds));
- },
-
- // returns offset needed for pxBounds to get inside maxBounds at a specified zoom
- _getBoundsOffset: function (pxBounds, maxBounds, zoom) {
- var projectedMaxBounds = L.bounds(
- this.project(maxBounds.getNorthEast(), zoom),
- this.project(maxBounds.getSouthWest(), zoom)
- ),
- minOffset = projectedMaxBounds.min.subtract(pxBounds.min),
- maxOffset = projectedMaxBounds.max.subtract(pxBounds.max),
-
- dx = this._rebound(minOffset.x, -maxOffset.x),
- dy = this._rebound(minOffset.y, -maxOffset.y);
-
- return new L.Point(dx, dy);
- },
+ if (this.options.noClip) {
+ this._parts = this._rings;
+ return;
+ }
- _rebound: function (left, right) {
- return left + right > 0 ?
- Math.round(left - right) / 2 :
- Math.max(0, Math.ceil(left)) - Math.max(0, Math.floor(right));
+ 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);
+ }
+ }
},
- _limitZoom: function (zoom) {
- var min = this.getMinZoom(),
- max = this.getMaxZoom(),
- snap = L.Browser.any3d ? this.options.zoomSnap : 1;
- if (snap) {
- zoom = Math.round(zoom / snap) * snap;
- }
- return Math.max(min, Math.min(max, zoom));
+ _updatePath: function () {
+ this._renderer._updatePoly(this, true);
}
});
-// @section
-// @factory L.map(id: String, options?: Map options)
-// Instantiates a map object given the DOM ID of a `
` element
-// and optionally an object literal with `Map options`.
-//
-// @alternative
-// @factory L.map(el: HTMLElement, options?: Map options)
-// Instantiates a map object given an instance of a `
` HTML element
-// and optionally an object literal with `Map options`.
-L.map = function (id, options) {
- return new L.Map(id, options);
+// @factory L.polygon(latlngs: LatLng[], options?: Polyline options)
+L.polygon = function (latlngs, options) {
+ return new L.Polygon(latlngs, options);
};
+/*
+ * L.Rectangle extends Polygon and creates a rectangle when passed a LatLngBounds object.
+ */
/*
- * @class Layer
- * @inherits Evented
- * @aka L.Layer
- * @aka ILayer
- *
- * A set of methods from the Layer base class that all Leaflet layers use.
- * Inherits all methods, options and events from `L.Evented`.
+ * @class Rectangle
+ * @aka L.Retangle
+ * @inherits Polygon
+ *
+ * A class for drawing rectangle overlays on a map. Extends `Polygon`.
*
* @example
*
* ```js
- * var layer = L.Marker(latlng).addTo(map);
- * layer.addTo(map);
- * layer.remove();
- * ```
+ * // define rectangle geographical bounds
+ * var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
*
- * @event add: Event
- * Fired after the layer is added to a map
+ * // create an orange rectangle
+ * L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
+ *
+ * // zoom the map to the rectangle bounds
+ * map.fitBounds(bounds);
+ * ```
*
- * @event remove: Event
- * Fired after the layer is removed from a map
*/
-L.Layer = L.Evented.extend({
+L.Rectangle = L.Polygon.extend({
+ initialize: function (latLngBounds, options) {
+ L.Polygon.prototype.initialize.call(this, this._boundsToLatLngs(latLngBounds), options);
+ },
- // Classes extending `L.Layer` will inherit the following options:
+ // @method setBounds(latLngBounds: LatLngBounds): this
+ // Redraws the rectangle with the passed bounds.
+ setBounds: function (latLngBounds) {
+ return this.setLatLngs(this._boundsToLatLngs(latLngBounds));
+ },
+
+ _boundsToLatLngs: function (latLngBounds) {
+ latLngBounds = L.latLngBounds(latLngBounds);
+ return [
+ latLngBounds.getSouthWest(),
+ latLngBounds.getNorthWest(),
+ latLngBounds.getNorthEast(),
+ latLngBounds.getSouthEast()
+ ];
+ }
+});
+
+
+// @factory L.rectangle(latLngBounds: LatLngBounds, options?: Polyline options)
+L.rectangle = function (latLngBounds, options) {
+ return new L.Rectangle(latLngBounds, options);
+};
+
+
+
+/*
+ * @class CircleMarker
+ * @aka L.CircleMarker
+ * @inherits Path
+ *
+ * A circle of a fixed size with radius specified in pixels. Extends `Path`.
+ */
+
+L.CircleMarker = L.Path.extend({
+
+ // @section
+ // @aka CircleMarker options
options: {
- // @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)
+ fill: true,
+
+ // @option radius: Number = 10
+ // Radius of the circle marker, in pixels
+ radius: 10
},
- /* @section
- * Classes extending `L.Layer` will inherit the following methods:
- *
- * @method addTo(map: Map): this
- * Adds the layer to the given map
- */
- addTo: function (map) {
- map.addLayer(this);
- return this;
+ initialize: function (latlng, options) {
+ L.setOptions(this, options);
+ this._latlng = L.latLng(latlng);
+ this._radius = this.options.radius;
},
- // @method remove: this
- // Removes the layer from the map it is currently active on.
- remove: function () {
- return this.removeFrom(this._map || this._mapToAdd);
+ // @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 removeFrom(map: Map): this
- // Removes the layer from the given map
- removeFrom: function (obj) {
- if (obj) {
- obj.removeLayer(this);
- }
- return this;
+ // @method getLatLng(): LatLng
+ // Returns the current geographical position of the circle marker
+ getLatLng: function () {
+ return this._latlng;
},
- // @method getPane(name? : String): HTMLElement
- // Returns the `HTMLElement` representing the named pane on the map. If `name` is omitted, returns the pane for this layer.
- getPane: function (name) {
- return this._map.getPane(name ? (this.options[name] || name) : this.options.pane);
+ // @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();
},
- addInteractiveTarget: function (targetEl) {
- this._map._targets[L.stamp(targetEl)] = this;
- return this;
+ // @method getRadius(): Number
+ // Returns the current radius of the circle
+ getRadius: function () {
+ return this._radius;
},
- removeInteractiveTarget: function (targetEl) {
- delete this._map._targets[L.stamp(targetEl)];
+ setStyle : function (options) {
+ var radius = options && options.radius || this._radius;
+ L.Path.prototype.setStyle.call(this, options);
+ this.setRadius(radius);
return this;
},
- _layerAdd: function (e) {
- var map = e.target;
-
- // check in case layer gets added and then removed before the map is ready
- if (!map.hasLayer(this)) { return; }
+ _project: function () {
+ this._point = this._map.latLngToLayerPoint(this._latlng);
+ this._updateBounds();
+ },
- this._map = map;
- this._zoomAnimated = map._zoomAnimated;
+ _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));
+ },
- if (this.getEvents) {
- var events = this.getEvents();
- map.on(events, this);
- this.once('remove', function () {
- map.off(events, this);
- }, this);
+ _update: function () {
+ if (this._map) {
+ this._updatePath();
}
+ },
- this.onAdd(map);
-
- if (this.getAttribution && this._map.attributionControl) {
- this._map.attributionControl.addAttribution(this.getAttribution());
- }
+ _updatePath: function () {
+ this._renderer._updateCircle(this);
+ },
- this.fire('add');
- map.fire('layeradd', {layer: this});
+ _empty: function () {
+ return this._radius && !this._renderer._bounds.intersects(this._pxBounds);
}
});
-/* @section Extension methods
- * @uninheritable
- *
- * Every layer should extend from `L.Layer` and (re-)implement the following methods.
- *
- * @method onAdd(map: Map): this
- * Should contain code that creates DOM elements for the layer, adds them to `map panes` where they should belong and puts listeners on relevant map events. Called on [`map.addLayer(layer)`](#map-addlayer).
- *
- * @method onRemove(map: Map): this
- * Should contain all clean up code that removes the layer's elements from the DOM and removes listeners previously added in [`onAdd`](#layer-onadd). Called on [`map.removeLayer(layer)`](#map-removelayer).
- *
- * @method getEvents(): Object
- * This optional method should return an object like `{ viewreset: this._reset }` for [`addEventListener`](#evented-addeventlistener). The event handlers in this object will be automatically added and removed from the map with your layer.
- *
- * @method getAttribution(): String
- * This optional method should return a string containing HTML to be shown on the `Attribution control` whenever the layer is visible.
- *
- * @method beforeAdd(map: Map): this
- * Optional method. Called on [`map.addLayer(layer)`](#map-addlayer), before the layer is added to the map, before events are initialized, without waiting until the map is in a usable state. Use for early initialization only.
- */
+
+// @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);
+};
-/* @namespace Map
- * @section Layer events
+
+/*
+ * @class Circle
+ * @aka L.Circle
+ * @inherits CircleMarker
*
- * @event layeradd: LayerEvent
- * Fired when a new layer is added to the map.
+ * A class for drawing circle overlays on a map. Extends `CircleMarker`.
*
- * @event layerremove: LayerEvent
- * Fired when some layer is removed from the map
+ * It's an approximation and starts to diverge from a real circle closer to poles (due to projection distortion).
*
- * @section Methods for Layers and Controls
+ * @example
+ *
+ * ```js
+ * L.circle([50.5, 30.5], {radius: 200}).addTo(map);
+ * ```
*/
-L.Map.include({
- // @method addLayer(layer: Layer): this
- // Adds the given layer to the map
- addLayer: function (layer) {
- var id = L.stamp(layer);
- if (this._layers[id]) { return this; }
- this._layers[id] = layer;
- layer._mapToAdd = this;
+L.Circle = L.CircleMarker.extend({
- if (layer.beforeAdd) {
- layer.beforeAdd(this);
+ 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);
- this.whenReady(layer._layerAdd, layer);
+ if (isNaN(this.options.radius)) { throw new Error('Circle radius cannot be NaN'); }
- return this;
+ // @section
+ // @aka Circle options
+ // @option radius: Number; Radius of the circle, in meters.
+ this._mRadius = this.options.radius;
},
- // @method removeLayer(layer: Layer): this
- // Removes the given layer from the map.
- removeLayer: function (layer) {
- var id = L.stamp(layer);
+ // @method setRadius(radius: Number): this
+ // Sets the radius of a circle. Units are in meters.
+ setRadius: function (radius) {
+ this._mRadius = radius;
+ return this.redraw();
+ },
- if (!this._layers[id]) { return this; }
+ // @method getRadius(): Number
+ // Returns the current radius of a circle. Units are in meters.
+ getRadius: function () {
+ return this._mRadius;
+ },
- if (this._loaded) {
- layer.onRemove(this);
- }
-
- if (layer.getAttribution && this.attributionControl) {
- this.attributionControl.removeAttribution(layer.getAttribution());
- }
-
- delete this._layers[id];
-
- if (this._loaded) {
- this.fire('layerremove', {layer: layer});
- layer.fire('remove');
- }
-
- layer._map = layer._mapToAdd = null;
-
- return this;
- },
-
- // @method hasLayer(layer: Layer): Boolean
- // Returns `true` if the given layer is currently added to the map
- hasLayer: function (layer) {
- return !!layer && (L.stamp(layer) in this._layers);
- },
-
- /* @method eachLayer(fn: Function, context?: Object): this
- * Iterates over the layers of the map, optionally specifying context of the iterator function.
- * ```
- * map.eachLayer(function(layer){
- * layer.bindPopup('Hello');
- * });
- * ```
- */
- eachLayer: function (method, context) {
- for (var i in this._layers) {
- method.call(context, this._layers[i]);
- }
- return this;
- },
-
- _addLayers: function (layers) {
- layers = layers ? (L.Util.isArray(layers) ? layers : [layers]) : [];
-
- for (var i = 0, len = layers.length; i < len; i++) {
- this.addLayer(layers[i]);
- }
- },
-
- _addZoomLimit: function (layer) {
- if (isNaN(layer.options.maxZoom) || !isNaN(layer.options.minZoom)) {
- this._zoomBoundLayers[L.stamp(layer)] = layer;
- this._updateZoomLevels();
- }
- },
-
- _removeZoomLimit: function (layer) {
- var id = L.stamp(layer);
-
- if (this._zoomBoundLayers[id]) {
- delete this._zoomBoundLayers[id];
- this._updateZoomLevels();
- }
- },
-
- _updateZoomLevels: function () {
- var minZoom = Infinity,
- maxZoom = -Infinity,
- oldZoomSpan = this._getZoomSpan();
-
- for (var i in this._zoomBoundLayers) {
- var options = this._zoomBoundLayers[i].options;
-
- minZoom = options.minZoom === undefined ? minZoom : Math.min(minZoom, options.minZoom);
- maxZoom = options.maxZoom === undefined ? maxZoom : Math.max(maxZoom, options.maxZoom);
- }
-
- this._layersMaxZoom = maxZoom === -Infinity ? undefined : maxZoom;
- this._layersMinZoom = minZoom === Infinity ? undefined : minZoom;
-
- // @section Map state change events
- // @event zoomlevelschange: Event
- // Fired when the number of zoomlevels on the map is changed due
- // to adding or removing a layer.
- if (oldZoomSpan !== this._getZoomSpan()) {
- this.fire('zoomlevelschange');
- }
- }
-});
-
-
-
-/*
- * @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.
- */
-
-L.Projection.Mercator = {
- R: 6378137,
- R_MINOR: 6356752.314245179,
-
- 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));
-
- return new L.Point(latlng.lng * d * r, y);
- },
-
- 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 = 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;
- }
-
- return new L.LatLng(phi * d, point.x * d / r);
- }
-};
-
-
-
-/*
- * @namespace CRS
- * @crs L.CRS.EPSG3395
- *
- * Rarely used by some commercial tile providers. Uses Elliptical Mercator projection.
- */
-
-L.CRS.EPSG3395 = L.extend({}, L.CRS.Earth, {
- code: 'EPSG:3395',
- projection: L.Projection.Mercator,
-
- transformation: (function () {
- var scale = 0.5 / (Math.PI * L.Projection.Mercator.R);
- return new L.Transformation(scale, 0.5, -scale, 0.5);
- }())
-});
-
-
-
-/*
- * @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 `