/*
- Leaflet, a JavaScript library for mobile-friendly interactive maps. http://leafletjs.com
- (c) 2010-2013, Vladimir Agafonkin
- (c) 2010-2011, CloudMade
+ Leaflet 1.0.0, a JS library for interactive maps. http://leafletjs.com
+ (c) 2010-2016 Vladimir Agafonkin, (c) 2010-2011 CloudMade
*/
(function (window, document, undefined) {
-var oldL = window.L,
- L = {};
+var L = {
+ version: "1.0.0"
+};
+
+function expose() {
+ var oldL = window.L;
+
+ L.noConflict = function () {
+ window.L = oldL;
+ return this;
+ };
-L.version = '0.7.7';
+ window.L = L;
+}
// define Leaflet for Node module pattern loaders, including Browserify
if (typeof module === 'object' && typeof module.exports === 'object') {
}
// define Leaflet as a global L variable, saving the original L to restore later if needed
+if (typeof window !== 'undefined') {
+ expose();
+}
-L.noConflict = function () {
- window.L = oldL;
- return this;
-};
-
-window.L = L;
/*
- * L.Util contains various utility functions used throughout Leaflet code.
+ * @namespace Util
+ *
+ * Various utility functions, used by Leaflet internally.
*/
L.Util = {
- extend: function (dest) { // (Object[, Object, ...]) ->
- var sources = Array.prototype.slice.call(arguments, 1),
- i, j, len, src;
- for (j = 0, len = sources.length; j < len; j++) {
- src = sources[j] || {};
+ // @function extend(dest: Object, src?: Object): Object
+ // Merges the properties of the `src` object (or multiple objects) into `dest` object and returns the latter. Has an `L.extend` shortcut.
+ extend: function (dest) {
+ var i, j, len, src;
+
+ for (j = 1, len = arguments.length; j < len; j++) {
+ src = arguments[j];
for (i in src) {
- if (src.hasOwnProperty(i)) {
- dest[i] = src[i];
- }
+ dest[i] = src[i];
}
}
return dest;
},
- bind: function (fn, obj) { // (Function, Object) -> Function
- var args = arguments.length > 2 ? Array.prototype.slice.call(arguments, 2) : null;
- return function () {
- return fn.apply(obj, args || arguments);
- };
- },
-
- stamp: (function () {
- var lastId = 0,
- key = '_leaflet_id';
- return function (obj) {
- obj[key] = obj[key] || ++lastId;
- return obj[key];
+ // @function create(proto: Object, properties?: Object): Object
+ // Compatibility polyfill for [Object.create](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/create)
+ create: Object.create || (function () {
+ function F() {}
+ return function (proto) {
+ F.prototype = proto;
+ return new F();
};
- }()),
+ })(),
- invokeEach: function (obj, method, context) {
- var i, args;
+ // @function bind(fn: Function, …): Function
+ // Returns a new function bound to the arguments passed, like [Function.prototype.bind](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function/bind).
+ // Has a `L.bind()` shortcut.
+ bind: function (fn, obj) {
+ var slice = Array.prototype.slice;
- if (typeof obj === 'object') {
- args = Array.prototype.slice.call(arguments, 3);
-
- for (i in obj) {
- method.apply(context, [i, obj[i]].concat(args));
- }
- return true;
+ if (fn.bind) {
+ return fn.bind.apply(fn, slice.call(arguments, 1));
}
- return false;
- },
-
- limitExecByInterval: function (fn, time, context) {
- var lock, execOnUnlock;
+ var args = slice.call(arguments, 2);
- return function wrapperFn() {
- var args = arguments;
+ return function () {
+ return fn.apply(obj, args.length ? args.concat(slice.call(arguments)) : arguments);
+ };
+ },
- if (lock) {
- execOnUnlock = true;
- return;
+ // @function stamp(obj: Object): Number
+ // Returns the unique ID of an object, assiging it one if it doesn't have it.
+ stamp: function (obj) {
+ /*eslint-disable */
+ obj._leaflet_id = obj._leaflet_id || ++L.Util.lastId;
+ return obj._leaflet_id;
+ /*eslint-enable */
+ },
+
+ // @property lastId: Number
+ // Last unique ID used by [`stamp()`](#util-stamp)
+ lastId: 0,
+
+ // @function throttle(fn: Function, time: Number, context: Object): Function
+ // Returns a function which executes function `fn` with the given scope `context`
+ // (so that the `this` keyword refers to `context` inside `fn`'s code). The function
+ // `fn` will be called no more than one time per given amount of `time`. The arguments
+ // received by the bound function will be any arguments passed when binding the
+ // function, followed by any arguments passed when invoking the bound function.
+ // Has an `L.bind` shortcut.
+ throttle: function (fn, time, context) {
+ var lock, args, wrapperFn, later;
+
+ later = function () {
+ // reset lock and call if queued
+ lock = false;
+ if (args) {
+ wrapperFn.apply(context, args);
+ args = false;
}
+ };
- lock = true;
-
- setTimeout(function () {
- lock = false;
-
- if (execOnUnlock) {
- wrapperFn.apply(context, args);
- execOnUnlock = false;
- }
- }, time);
+ wrapperFn = function () {
+ if (lock) {
+ // called too soon, queue to call later
+ args = arguments;
- fn.apply(context, args);
+ } else {
+ // call and lock until later
+ fn.apply(context, arguments);
+ setTimeout(later, time);
+ lock = true;
+ }
};
+
+ return wrapperFn;
},
- falseFn: function () {
- return false;
+ // @function wrapNum(num: Number, range: Number[], includeMax?: Boolean): Number
+ // Returns the number `num` modulo `range` in such a way so it lies within
+ // `range[0]` and `range[1]`. The returned value will be always smaller than
+ // `range[1]` unless `includeMax` is set to `true`.
+ wrapNum: function (x, range, includeMax) {
+ var max = range[1],
+ min = range[0],
+ d = max - min;
+ return x === max && includeMax ? x : ((x - min) % d + d) % d + min;
},
+ // @function falseFn(): Function
+ // Returns a function which always returns `false`.
+ falseFn: function () { return false; },
+
+ // @function formatNum(num: Number, digits?: Number): Number
+ // Returns the number `num` rounded to `digits` decimals, or to 5 decimals by default.
formatNum: function (num, digits) {
var pow = Math.pow(10, digits || 5);
return Math.round(num * pow) / pow;
},
+ // @function trim(str: String): String
+ // Compatibility polyfill for [String.prototype.trim](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String/Trim)
trim: function (str) {
return str.trim ? str.trim() : str.replace(/^\s+|\s+$/g, '');
},
+ // @function splitWords(str: String): String[]
+ // Trims and splits the string on whitespace and returns the array of parts.
splitWords: function (str) {
return L.Util.trim(str).split(/\s+/);
},
+ // @function setOptions(obj: Object, options: Object): Object
+ // Merges the given properties to the `options` of the `obj` object, returning the resulting options. See `Class options`. Has an `L.setOptions` shortcut.
setOptions: function (obj, options) {
- obj.options = L.extend({}, obj.options, options);
+ if (!obj.hasOwnProperty('options')) {
+ obj.options = obj.options ? L.Util.create(obj.options) : {};
+ }
+ for (var i in options) {
+ obj.options[i] = options[i];
+ }
return obj.options;
},
+ // @function getParamString(obj: Object, existingUrl?: String, uppercase?: Boolean): String
+ // Converts an object into a parameter URL string, e.g. `{a: "foo", b: "bar"}`
+ // translates to `'?a=foo&b=bar'`. If `existingUrl` is set, the parameters will
+ // be appended at the end. If `uppercase` is `true`, the parameter names will
+ // be uppercased (e.g. `'?A=foo&B=bar'`)
getParamString: function (obj, existingUrl, uppercase) {
var params = [];
for (var i in obj) {
}
return ((!existingUrl || existingUrl.indexOf('?') === -1) ? '?' : '&') + params.join('&');
},
+
+ // @function template(str: String, data: Object): String
+ // Simple templating facility, accepts a template string of the form `'Hello {a}, {b}'`
+ // and a data object like `{a: 'foo', b: 'bar'}`, returns evaluated string
+ // `('Hello foo, bar')`. You can also specify functions instead of strings for
+ // data values — they will be evaluated passing `data` as an argument.
template: function (str, data) {
- return str.replace(/\{ *([\w_]+) *\}/g, function (str, key) {
+ return str.replace(L.Util.templateRe, function (str, key) {
var value = data[key];
+
if (value === undefined) {
throw new Error('No value provided for variable ' + str);
+
} else if (typeof value === 'function') {
value = value(data);
}
});
},
+ templateRe: /\{ *([\w_\-]+) *\}/g,
+
+ // @function isArray(obj): Boolean
+ // Compatibility polyfill for [Array.isArray](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray)
isArray: Array.isArray || function (obj) {
return (Object.prototype.toString.call(obj) === '[object Array]');
},
+ // @function indexOf(array: Array, el: Object): Number
+ // Compatibility polyfill for [Array.prototype.indexOf](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf)
+ indexOf: function (array, el) {
+ for (var i = 0; i < array.length; i++) {
+ if (array[i] === el) { return i; }
+ }
+ return -1;
+ },
+
+ // @property emptyImageUrl: String
+ // Data URI string containing a base64-encoded empty GIF image.
+ // Used as a hack to free memory from unused images on WebKit-powered
+ // mobile devices (by setting image `src` to this string).
emptyImageUrl: 'data:image/gif;base64,R0lGODlhAQABAAD/ACwAAAAAAQABAAACADs='
};
(function () {
-
// inspired by http://paulirish.com/2011/requestanimationframe-for-smart-animating/
function getPrefixed(name) {
- var i, fn,
- prefixes = ['webkit', 'moz', 'o', 'ms'];
-
- for (i = 0; i < prefixes.length && !fn; i++) {
- fn = window[prefixes[i] + name];
- }
-
- return fn;
+ return window['webkit' + name] || window['moz' + name] || window['ms' + name];
}
var lastTime = 0;
+ // fallback for IE 7-8
function timeoutDefer(fn) {
var time = +new Date(),
timeToCall = Math.max(0, 16 - (time - lastTime));
return window.setTimeout(fn, timeToCall);
}
- var requestFn = window.requestAnimationFrame ||
- getPrefixed('RequestAnimationFrame') || timeoutDefer;
-
- var cancelFn = window.cancelAnimationFrame ||
- getPrefixed('CancelAnimationFrame') ||
- getPrefixed('CancelRequestAnimationFrame') ||
- function (id) { window.clearTimeout(id); };
+ var requestFn = window.requestAnimationFrame || getPrefixed('RequestAnimationFrame') || timeoutDefer,
+ cancelFn = window.cancelAnimationFrame || getPrefixed('CancelAnimationFrame') ||
+ getPrefixed('CancelRequestAnimationFrame') || function (id) { window.clearTimeout(id); };
- L.Util.requestAnimFrame = function (fn, context, immediate, element) {
- fn = L.bind(fn, context);
-
+ // @function requestAnimFrame(fn: Function, context?: Object, immediate?: Boolean): Number
+ // Schedules `fn` to be executed when the browser repaints. `fn` is bound to
+ // `context` if given. When `immediate` is set, `fn` is called immediately if
+ // the browser doesn't have native support for
+ // [`window.requestAnimationFrame`](https://developer.mozilla.org/docs/Web/API/window/requestAnimationFrame),
+ // otherwise it's delayed. Returns a request ID that can be used to cancel the request.
+ L.Util.requestAnimFrame = function (fn, context, immediate) {
if (immediate && requestFn === timeoutDefer) {
- fn();
+ fn.call(context);
} else {
- return requestFn.call(window, fn, element);
+ return requestFn.call(window, L.bind(fn, context));
}
};
+ // @function cancelAnimFrame(id: Number): undefined
+ // Cancels a previous `requestAnimFrame`. See also [window.cancelAnimationFrame](https://developer.mozilla.org/docs/Web/API/window/cancelAnimationFrame).
L.Util.cancelAnimFrame = function (id) {
if (id) {
cancelFn.call(window, id);
}
};
-
-}());
+})();
// shortcuts for most used utility functions
L.extend = L.Util.extend;
L.setOptions = L.Util.setOptions;
-/*
- * L.Class powers the OOP facilities of the library.
- * Thanks to John Resig and Dean Edwards for inspiration!
- */
+
+
+// @class Class
+// @aka L.Class
+
+// @section
+// @uninheritable
+
+// Thanks to John Resig and Dean Edwards for inspiration!
L.Class = function () {};
L.Class.extend = function (props) {
- // extended class with the new prototype
+ // @function extend(props: Object): Function
+ // [Extends the current class](#class-inheritance) given the properties to be included.
+ // Returns a Javascript function that is a class constructor (to be called with `new`).
var NewClass = function () {
// call the constructor
}
// call all constructor hooks
- if (this._initHooks) {
- this.callInitHooks();
- }
+ this.callInitHooks();
};
- // instantiate class without calling constructor
- var F = function () {};
- F.prototype = this.prototype;
+ var parentProto = NewClass.__super__ = this.prototype;
- var proto = new F();
+ var proto = L.Util.create(parentProto);
proto.constructor = NewClass;
NewClass.prototype = proto;
- //inherit parent's statics
+ // inherit parent's statics
for (var i in this) {
if (this.hasOwnProperty(i) && i !== 'prototype') {
NewClass[i] = this[i];
}
// merge options
- if (props.options && proto.options) {
- props.options = L.extend({}, proto.options, props.options);
+ if (proto.options) {
+ props.options = L.Util.extend(L.Util.create(proto.options), props.options);
}
// mix given properties into the prototype
proto._initHooks = [];
- var parent = this;
- // jshint camelcase: false
- NewClass.__super__ = parent.prototype;
-
// add method for calling all hooks
proto.callInitHooks = function () {
if (this._initHooksCalled) { return; }
- if (parent.prototype.callInitHooks) {
- parent.prototype.callInitHooks.call(this);
+ if (parentProto.callInitHooks) {
+ parentProto.callInitHooks.call(this);
}
this._initHooksCalled = true;
};
-// method for adding properties to prototype
+// @function include(properties: Object): this
+// [Includes a mixin](#class-includes) into the current class.
L.Class.include = function (props) {
L.extend(this.prototype, props);
+ return this;
};
-// merge new default options to the Class
+// @function mergeOptions(options: Object): this
+// [Merges `options`](#class-options) into the defaults of the class.
L.Class.mergeOptions = function (options) {
L.extend(this.prototype.options, options);
+ return this;
};
-// add a constructor hook
+// @function addInitHook(fn: Function): this
+// Adds a [constructor hook](#class-constructor-hooks) to the class.
L.Class.addInitHook = function (fn) { // (Function) || (String, args...)
var args = Array.prototype.slice.call(arguments, 1);
this.prototype._initHooks = this.prototype._initHooks || [];
this.prototype._initHooks.push(init);
+ return this;
};
+
/*
- * L.Mixin.Events is used to add custom events functionality to Leaflet classes.
+ * @class Evented
+ * @aka L.Evented
+ * @inherits Class
+ *
+ * A set of methods shared between event-powered classes (like `Map` and `Marker`). Generally, events allow you to execute some function when something happens with an object (e.g. the user clicks on the map, causing the map to fire `'click'` event).
+ *
+ * @example
+ *
+ * ```js
+ * map.on('click', function(e) {
+ * alert(e.latlng);
+ * } );
+ * ```
+ *
+ * Leaflet deals with event listeners by reference, so if you want to add a listener and then remove it, define it as a function:
+ *
+ * ```js
+ * function onClick(e) { ... }
+ *
+ * map.on('click', onClick);
+ * map.off('click', onClick);
+ * ```
*/
-var eventsKey = '_leaflet_events';
-
-L.Mixin = {};
-L.Mixin.Events = {
+L.Evented = L.Class.extend({
- addEventListener: function (types, fn, context) { // (String, Function[, Object]) or (Object[, Object])
+ /* @method on(type: String, fn: Function, context?: Object): this
+ * Adds a listener function (`fn`) to a particular event type of the object. You can optionally specify the context of the listener (object the this keyword will point to). You can also pass several space-separated types (e.g. `'click dblclick'`).
+ *
+ * @alternative
+ * @method on(eventMap: Object): this
+ * Adds a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}`
+ */
+ on: function (types, fn, context) {
// types can be a map of types/handlers
- if (L.Util.invokeEach(types, this.addEventListener, this, fn, context)) { return this; }
-
- var events = this[eventsKey] = this[eventsKey] || {},
- contextId = context && context !== this && L.stamp(context),
- i, len, event, type, indexKey, indexLenKey, typeIndex;
-
- // types can be a string of space-separated words
- types = L.Util.splitWords(types);
-
- for (i = 0, len = types.length; i < len; i++) {
- event = {
- action: fn,
- context: context || this
- };
- type = types[i];
+ if (typeof types === 'object') {
+ for (var type in types) {
+ // we don't process space-separated events here for performance;
+ // it's a hot path since Layer uses the on(obj) syntax
+ this._on(type, types[type], fn);
+ }
- if (contextId) {
- // store listeners of a particular context in a separate hash (if it has an id)
- // gives a major performance boost when removing thousands of map layers
+ } else {
+ // types can be a string of space-separated words
+ types = L.Util.splitWords(types);
- indexKey = type + '_idx';
- indexLenKey = indexKey + '_len';
+ for (var i = 0, len = types.length; i < len; i++) {
+ this._on(types[i], fn, context);
+ }
+ }
- typeIndex = events[indexKey] = events[indexKey] || {};
+ return this;
+ },
- if (!typeIndex[contextId]) {
- typeIndex[contextId] = [];
+ /* @method off(type: String, fn?: Function, context?: Object): this
+ * Removes a previously added listener function. If no function is specified, it will remove all the listeners of that particular event from the object. Note that if you passed a custom context to `on`, you must pass the same context to `off` in order to remove the listener.
+ *
+ * @alternative
+ * @method off(eventMap: Object): this
+ * Removes a set of type/listener pairs.
+ *
+ * @alternative
+ * @method off: this
+ * Removes all listeners to all events on the object.
+ */
+ off: function (types, fn, context) {
- // keep track of the number of keys in the index to quickly check if it's empty
- events[indexLenKey] = (events[indexLenKey] || 0) + 1;
- }
+ if (!types) {
+ // clear all listeners if called without arguments
+ delete this._events;
- typeIndex[contextId].push(event);
+ } else if (typeof types === 'object') {
+ for (var type in types) {
+ this._off(type, types[type], fn);
+ }
+ } else {
+ types = L.Util.splitWords(types);
- } else {
- events[type] = events[type] || [];
- events[type].push(event);
+ for (var i = 0, len = types.length; i < len; i++) {
+ this._off(types[i], fn, context);
}
}
return this;
},
- hasEventListeners: function (type) { // (String) -> Boolean
- var events = this[eventsKey];
- return !!events && ((type in events && events[type].length > 0) ||
- (type + '_idx' in events && events[type + '_idx_len'] > 0));
- },
-
- removeEventListener: function (types, fn, context) { // ([String, Function, Object]) or (Object[, Object])
+ // attach listener (without syntactic sugar now)
+ _on: function (type, fn, context) {
+ this._events = this._events || {};
- if (!this[eventsKey]) {
- return this;
+ /* get/init listeners for type */
+ var typeListeners = this._events[type];
+ if (!typeListeners) {
+ typeListeners = [];
+ this._events[type] = typeListeners;
}
- if (!types) {
- return this.clearAllEventListeners();
+ if (context === this) {
+ // Less memory footprint.
+ context = undefined;
}
+ var newListener = {fn: fn, ctx: context},
+ listeners = typeListeners;
- if (L.Util.invokeEach(types, this.removeEventListener, this, fn, context)) { return this; }
-
- var events = this[eventsKey],
- contextId = context && context !== this && L.stamp(context),
- i, len, type, listeners, j, indexKey, indexLenKey, typeIndex, removed;
+ // check if fn already there
+ for (var i = 0, len = listeners.length; i < len; i++) {
+ if (listeners[i].fn === fn && listeners[i].ctx === context) {
+ return;
+ }
+ }
- types = L.Util.splitWords(types);
+ listeners.push(newListener);
+ typeListeners.count++;
+ },
- for (i = 0, len = types.length; i < len; i++) {
- type = types[i];
- indexKey = type + '_idx';
- indexLenKey = indexKey + '_len';
+ _off: function (type, fn, context) {
+ var listeners,
+ i,
+ len;
- typeIndex = events[indexKey];
+ if (!this._events) { return; }
- if (!fn) {
- // clear all listeners for a type if function isn't specified
- delete events[type];
- delete events[indexKey];
- delete events[indexLenKey];
+ listeners = this._events[type];
- } else {
- listeners = contextId && typeIndex ? typeIndex[contextId] : events[type];
-
- if (listeners) {
- for (j = listeners.length - 1; j >= 0; j--) {
- if ((listeners[j].action === fn) && (!context || (listeners[j].context === context))) {
- removed = listeners.splice(j, 1);
- // set the old action to a no-op, because it is possible
- // that the listener is being iterated over as part of a dispatch
- removed[0].action = L.Util.falseFn;
- }
- }
+ if (!listeners) {
+ return;
+ }
- if (context && typeIndex && (listeners.length === 0)) {
- delete typeIndex[contextId];
- events[indexLenKey]--;
- }
- }
+ if (!fn) {
+ // Set all removed listeners to noop so they are not called if remove happens in fire
+ for (i = 0, len = listeners.length; i < len; i++) {
+ listeners[i].fn = L.Util.falseFn;
}
+ // clear all listeners for a type if function isn't specified
+ delete this._events[type];
+ return;
}
- return this;
- },
-
- clearAllEventListeners: function () {
- delete this[eventsKey];
- return this;
- },
-
- fireEvent: function (type, data) { // (String[, Object])
- if (!this.hasEventListeners(type)) {
- return this;
+ if (context === this) {
+ context = undefined;
}
- var event = L.Util.extend({}, data, { type: type, target: this });
+ if (listeners) {
- var events = this[eventsKey],
- listeners, i, len, typeIndex, contextId;
+ // find fn and remove it
+ for (i = 0, len = listeners.length; i < len; i++) {
+ var l = listeners[i];
+ if (l.ctx !== context) { continue; }
+ if (l.fn === fn) {
- if (events[type]) {
- // make sure adding/removing listeners inside other listeners won't cause infinite loop
- listeners = events[type].slice();
+ // set the removed listener to noop so that's not called if remove happens in fire
+ l.fn = L.Util.falseFn;
- for (i = 0, len = listeners.length; i < len; i++) {
- listeners[i].action.call(listeners[i].context, event);
+ if (this._firingCount) {
+ /* copy array in case events are being fired */
+ this._events[type] = listeners = listeners.slice();
+ }
+ listeners.splice(i, 1);
+
+ return;
+ }
}
}
+ },
+
+ // @method fire(type: String, data?: Object, propagate?: Boolean): this
+ // Fires an event of the specified type. You can optionally provide an data
+ // object — the first argument of the listener function will contain its
+ // properties. The event might can optionally be propagated to event parents.
+ fire: function (type, data, propagate) {
+ if (!this.listens(type, propagate)) { return this; }
- // fire event for the context-indexed listeners as well
- typeIndex = events[type + '_idx'];
+ var event = L.Util.extend({}, data, {type: type, target: this});
- for (contextId in typeIndex) {
- listeners = typeIndex[contextId].slice();
+ if (this._events) {
+ var listeners = this._events[type];
if (listeners) {
- for (i = 0, len = listeners.length; i < len; i++) {
- listeners[i].action.call(listeners[i].context, event);
+ this._firingCount = (this._firingCount + 1) || 1;
+ for (var i = 0, len = listeners.length; i < len; i++) {
+ var l = listeners[i];
+ l.fn.call(l.ctx || this, event);
}
+
+ this._firingCount--;
}
}
+ if (propagate) {
+ // propagate the event to parents (set with addEventParent)
+ this._propagateEvent(event);
+ }
+
return this;
},
- addOneTimeEventListener: function (types, fn, context) {
+ // @method listens(type: String): Boolean
+ // Returns `true` if a particular event type has any listeners attached to it.
+ listens: function (type, propagate) {
+ var listeners = this._events && this._events[type];
+ if (listeners && listeners.length) { return true; }
+
+ if (propagate) {
+ // also check parents for listeners if event propagates
+ for (var id in this._eventParents) {
+ if (this._eventParents[id].listens(type, propagate)) { return true; }
+ }
+ }
+ return false;
+ },
+
+ // @method once(…): this
+ // Behaves as [`on(…)`](#evented-on), except the listener will only get fired once and then removed.
+ once: function (types, fn, context) {
- if (L.Util.invokeEach(types, this.addOneTimeEventListener, this, fn, context)) { return this; }
+ if (typeof types === 'object') {
+ for (var type in types) {
+ this.once(type, types[type], fn);
+ }
+ return this;
+ }
var handler = L.bind(function () {
this
- .removeEventListener(types, fn, context)
- .removeEventListener(types, handler, context);
+ .off(types, fn, context)
+ .off(types, handler, context);
}, this);
+ // add a listener that's executed once and removed after that
return this
- .addEventListener(types, fn, context)
- .addEventListener(types, handler, context);
+ .on(types, fn, context)
+ .on(types, handler, context);
+ },
+
+ // @method addEventParent(obj: Evented): this
+ // Adds an event parent - an `Evented` that will receive propagated events
+ addEventParent: function (obj) {
+ this._eventParents = this._eventParents || {};
+ this._eventParents[L.stamp(obj)] = obj;
+ return this;
+ },
+
+ // @method removeEventParent(obj: Evented): this
+ // Removes an event parent, so it will stop receiving propagated events
+ removeEventParent: function (obj) {
+ if (this._eventParents) {
+ delete this._eventParents[L.stamp(obj)];
+ }
+ return this;
+ },
+
+ _propagateEvent: function (e) {
+ for (var id in this._eventParents) {
+ this._eventParents[id].fire(e.type, L.extend({layer: e.target}, e), true);
+ }
}
-};
+});
+
+var proto = L.Evented.prototype;
+
+// aliases; we should ditch those eventually
+
+// @method addEventListener(…): this
+// Alias to [`on(…)`](#evented-on)
+proto.addEventListener = proto.on;
+
+// @method removeEventListener(…): this
+// Alias to [`off(…)`](#evented-off)
+
+// @method clearAllEventListeners(…): this
+// Alias to [`off()`](#evented-off)
+proto.removeEventListener = proto.clearAllEventListeners = proto.off;
+
+// @method addOneTimeEventListener(…): this
+// Alias to [`once(…)`](#evented-once)
+proto.addOneTimeEventListener = proto.once;
+
+// @method fireEvent(…): this
+// Alias to [`fire(…)`](#evented-fire)
+proto.fireEvent = proto.fire;
+
+// @method hasEventListeners(…): Boolean
+// Alias to [`listens(…)`](#evented-listens)
+proto.hasEventListeners = proto.listens;
+
+L.Mixin = {Events: proto};
-L.Mixin.Events.on = L.Mixin.Events.addEventListener;
-L.Mixin.Events.off = L.Mixin.Events.removeEventListener;
-L.Mixin.Events.once = L.Mixin.Events.addOneTimeEventListener;
-L.Mixin.Events.fire = L.Mixin.Events.fireEvent;
/*
- * L.Browser handles different browser and feature detections for internal Leaflet use.
+ * @namespace Browser
+ * @aka L.Browser
+ *
+ * A namespace with static properties for browser/feature detection used by Leaflet internally.
+ *
+ * @example
+ *
+ * ```js
+ * if (L.Browser.ielt9) {
+ * alert('Upgrade your browser, dude!');
+ * }
+ * ```
*/
(function () {
- var ie = 'ActiveXObject' in window,
- ielt9 = ie && !document.addEventListener,
+ var ua = navigator.userAgent.toLowerCase(),
+ doc = document.documentElement,
+
+ ie = 'ActiveXObject' in window,
- // terrible browser detection to work around Safari / iOS / Android browser bugs
- ua = navigator.userAgent.toLowerCase(),
- webkit = ua.indexOf('webkit') !== -1,
- chrome = ua.indexOf('chrome') !== -1,
+ webkit = ua.indexOf('webkit') !== -1,
phantomjs = ua.indexOf('phantom') !== -1,
- android = ua.indexOf('android') !== -1,
android23 = ua.search('android [23]') !== -1,
- gecko = ua.indexOf('gecko') !== -1,
+ chrome = ua.indexOf('chrome') !== -1,
+ gecko = ua.indexOf('gecko') !== -1 && !webkit && !window.opera && !ie,
- mobile = typeof orientation !== undefined + '',
+ win = navigator.platform.indexOf('Win') === 0,
+
+ mobile = typeof orientation !== 'undefined' || ua.indexOf('mobile') !== -1,
msPointer = !window.PointerEvent && window.MSPointerEvent,
- pointer = (window.PointerEvent && window.navigator.pointerEnabled) ||
- msPointer,
- retina = ('devicePixelRatio' in window && window.devicePixelRatio > 1) ||
- ('matchMedia' in window && window.matchMedia('(min-resolution:144dpi)') &&
- window.matchMedia('(min-resolution:144dpi)').matches),
+ pointer = window.PointerEvent || msPointer,
- doc = document.documentElement,
ie3d = ie && ('transition' in doc.style),
webkit3d = ('WebKitCSSMatrix' in window) && ('m11' in new window.WebKitCSSMatrix()) && !android23,
gecko3d = 'MozPerspective' in doc.style,
- opera3d = 'OTransition' in doc.style,
- any3d = !window.L_DISABLE_3D && (ie3d || webkit3d || gecko3d || opera3d) && !phantomjs;
+ opera12 = 'OTransition' in doc.style;
- var touch = !window.L_NO_TOUCH && !phantomjs && (pointer || 'ontouchstart' in window ||
- (window.DocumentTouch && document instanceof window.DocumentTouch));
+
+ var touch = !window.L_NO_TOUCH && (pointer || 'ontouchstart' in window ||
+ (window.DocumentTouch && document instanceof window.DocumentTouch));
L.Browser = {
+
+ // @property ie: Boolean
+ // `true` for all Internet Explorer versions (not Edge).
ie: ie,
- ielt9: ielt9,
+
+ // @property ielt9: Boolean
+ // `true` for Internet Explorer versions less than 9.
+ ielt9: ie && !document.addEventListener,
+
+ // @property edge: Boolean
+ // `true` for the Edge web browser.
+ edge: 'msLaunchUri' in navigator && !('documentMode' in document),
+
+ // @property webkit: Boolean
+ // `true` for webkit-based browsers like Chrome and Safari (including mobile versions).
webkit: webkit,
- gecko: gecko && !webkit && !window.opera && !ie,
- android: android,
+ // @property gecko: Boolean
+ // `true` for gecko-based browsers like Firefox.
+ gecko: gecko,
+
+ // @property android: Boolean
+ // `true` for any browser running on an Android platform.
+ android: ua.indexOf('android') !== -1,
+
+ // @property android23: Boolean
+ // `true` for browsers running on Android 2 or Android 3.
android23: android23,
+ // @property chrome: Boolean
+ // `true` for the Chrome browser.
chrome: chrome,
+ // @property safari: Boolean
+ // `true` for the Safari browser.
+ safari: !chrome && ua.indexOf('safari') !== -1,
+
+
+ // @property win: Boolean
+ // `true` when the browser is running in a Windows platform
+ win: win,
+
+
+ // @property ie3d: Boolean
+ // `true` for all Internet Explorer versions supporting CSS transforms.
ie3d: ie3d,
+
+ // @property webkit3d: Boolean
+ // `true` for webkit-based browsers supporting CSS transforms.
webkit3d: webkit3d,
+
+ // @property gecko3d: Boolean
+ // `true` for gecko-based browsers supporting CSS transforms.
gecko3d: gecko3d,
- opera3d: opera3d,
- any3d: any3d,
+ // @property opera12: Boolean
+ // `true` for the Opera browser supporting CSS transforms (version 12 or later).
+ opera12: opera12,
+
+ // @property any3d: Boolean
+ // `true` for all browsers supporting CSS transforms.
+ any3d: !window.L_DISABLE_3D && (ie3d || webkit3d || gecko3d) && !opera12 && !phantomjs,
+
+
+ // @property mobile: Boolean
+ // `true` for all browsers running in a mobile device.
mobile: mobile,
+
+ // @property mobileWebkit: Boolean
+ // `true` for all webkit-based browsers in a mobile device.
mobileWebkit: mobile && webkit,
+
+ // @property mobileWebkit3d: Boolean
+ // `true` for all webkit-based browsers in a mobile device supporting CSS transforms.
mobileWebkit3d: mobile && webkit3d,
+
+ // @property mobileOpera: Boolean
+ // `true` for the Opera browser in a mobile device.
mobileOpera: mobile && window.opera,
- touch: touch,
- msPointer: msPointer,
- pointer: pointer,
+ // @property mobileGecko: Boolean
+ // `true` for gecko-based browsers running in a mobile device.
+ mobileGecko: mobile && gecko,
+
- retina: retina
+ // @property touch: Boolean
+ // `true` for all browsers supporting [touch events](https://developer.mozilla.org/docs/Web/API/Touch_events).
+ touch: !!touch,
+
+ // @property msPointer: Boolean
+ // `true` for browsers implementing the Microsoft touch events model (notably IE10).
+ msPointer: !!msPointer,
+
+ // @property pointer: Boolean
+ // `true` for all browsers supporting [pointer events](https://msdn.microsoft.com/en-us/library/dn433244%28v=vs.85%29.aspx).
+ pointer: !!pointer,
+
+
+ // @property retina: Boolean
+ // `true` for browsers on a high-resolution "retina" screen.
+ retina: (window.devicePixelRatio || (window.screen.deviceXDPI / window.screen.logicalXDPI)) > 1
};
}());
+
/*
- * L.Point represents a point with x and y coordinates.
+ * @class Point
+ * @aka L.Point
+ *
+ * Represents a point with `x` and `y` coordinates in pixels.
+ *
+ * @example
+ *
+ * ```js
+ * var point = L.point(200, 300);
+ * ```
+ *
+ * All Leaflet methods and options that accept `Point` objects also accept them in a simple Array form (unless noted otherwise), so these lines are equivalent:
+ *
+ * ```js
+ * map.panBy([200, 300]);
+ * map.panBy(L.point(200, 300));
+ * ```
*/
-L.Point = function (/*Number*/ x, /*Number*/ y, /*Boolean*/ round) {
+L.Point = function (x, y, round) {
this.x = (round ? Math.round(x) : x);
this.y = (round ? Math.round(y) : y);
};
L.Point.prototype = {
+ // @method clone(): Point
+ // Returns a copy of the current point.
clone: function () {
return new L.Point(this.x, this.y);
},
- // non-destructive, returns a new point
+ // @method add(otherPoint: Point): Point
+ // Returns the result of addition of the current and the given points.
add: function (point) {
+ // non-destructive, returns a new point
return this.clone()._add(L.point(point));
},
- // destructive, used directly for performance in situations where it's safe to modify existing point
_add: function (point) {
+ // destructive, used directly for performance in situations where it's safe to modify existing point
this.x += point.x;
this.y += point.y;
return this;
},
+ // @method subtract(otherPoint: Point): Point
+ // Returns the result of subtraction of the given point from the current.
subtract: function (point) {
return this.clone()._subtract(L.point(point));
},
return this;
},
+ // @method divideBy(num: Number): Point
+ // Returns the result of division of the current point by the given number.
divideBy: function (num) {
return this.clone()._divideBy(num);
},
return this;
},
+ // @method multiplyBy(num: Number): Point
+ // Returns the result of multiplication of the current point by the given number.
multiplyBy: function (num) {
return this.clone()._multiplyBy(num);
},
return this;
},
+ // @method scaleBy(scale: Point): Point
+ // Multiply each coordinate of the current point by each coordinate of
+ // `scale`. In linear algebra terms, multiply the point by the
+ // [scaling matrix](https://en.wikipedia.org/wiki/Scaling_%28geometry%29#Matrix_representation)
+ // defined by `scale`.
+ scaleBy: function (point) {
+ return new L.Point(this.x * point.x, this.y * point.y);
+ },
+
+ // @method unscaleBy(scale: Point): Point
+ // Inverse of `scaleBy`. Divide each coordinate of the current point by
+ // each coordinate of `scale`.
+ unscaleBy: function (point) {
+ return new L.Point(this.x / point.x, this.y / point.y);
+ },
+
+ // @method round(): Point
+ // Returns a copy of the current point with rounded coordinates.
round: function () {
return this.clone()._round();
},
return this;
},
+ // @method floor(): Point
+ // Returns a copy of the current point with floored coordinates (rounded down).
floor: function () {
return this.clone()._floor();
},
return this;
},
+ // @method ceil(): Point
+ // Returns a copy of the current point with ceiled coordinates (rounded up).
+ ceil: function () {
+ return this.clone()._ceil();
+ },
+
+ _ceil: function () {
+ this.x = Math.ceil(this.x);
+ this.y = Math.ceil(this.y);
+ return this;
+ },
+
+ // @method distanceTo(otherPoint: Point): Number
+ // Returns the cartesian distance between the current and the given points.
distanceTo: function (point) {
point = L.point(point);
return Math.sqrt(x * x + y * y);
},
+ // @method equals(otherPoint: Point): Boolean
+ // Returns `true` if the given point has the same coordinates.
equals: function (point) {
point = L.point(point);
point.y === this.y;
},
+ // @method contains(otherPoint: Point): Boolean
+ // Returns `true` if both coordinates of the given point are less than the corresponding current point coordinates (in absolute values).
contains: function (point) {
point = L.point(point);
Math.abs(point.y) <= Math.abs(this.y);
},
+ // @method toString(): String
+ // Returns a string representation of the point for debugging purposes.
toString: function () {
return 'Point(' +
L.Util.formatNum(this.x) + ', ' +
}
};
+// @factory L.point(x: Number, y: Number, round?: Boolean)
+// Creates a Point object with the given `x` and `y` coordinates. If optional `round` is set to true, rounds the `x` and `y` values.
+
+// @alternative
+// @factory L.point(coords: Number[])
+// Expects an array of the form `[x, y]` instead.
+
+// @alternative
+// @factory L.point(coords: Object)
+// Expects a plain object of the form `{x: Number, y: Number}` instead.
L.point = function (x, y, round) {
if (x instanceof L.Point) {
return x;
if (x === undefined || x === null) {
return x;
}
+ if (typeof x === 'object' && 'x' in x && 'y' in x) {
+ return new L.Point(x.x, x.y);
+ }
return new L.Point(x, y, round);
};
+
/*
- * L.Bounds represents a rectangular area on the screen in pixel coordinates.
+ * @class Bounds
+ * @aka L.Bounds
+ *
+ * Represents a rectangular area in pixel coordinates.
+ *
+ * @example
+ *
+ * ```js
+ * var p1 = L.point(10, 10),
+ * p2 = L.point(40, 60),
+ * bounds = L.bounds(p1, p2);
+ * ```
+ *
+ * All Leaflet methods that accept `Bounds` objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:
+ *
+ * ```js
+ * otherBounds.intersects([[10, 10], [40, 60]]);
+ * ```
*/
-L.Bounds = function (a, b) { //(Point, Point) or Point[]
+L.Bounds = function (a, b) {
if (!a) { return; }
var points = b ? [a, b] : a;
};
L.Bounds.prototype = {
- // extend the bounds to contain the given point
+ // @method extend(point: Point): this
+ // Extends the bounds to contain the given point.
extend: function (point) { // (Point)
point = L.point(point);
+ // @property min: Point
+ // The top left corner of the rectangle.
+ // @property max: Point
+ // The bottom right corner of the rectangle.
if (!this.min && !this.max) {
this.min = point.clone();
this.max = point.clone();
return this;
},
- getCenter: function (round) { // (Boolean) -> Point
+ // @method getCenter(round?: Boolean): Point
+ // Returns the center point of the bounds.
+ getCenter: function (round) {
return new L.Point(
(this.min.x + this.max.x) / 2,
(this.min.y + this.max.y) / 2, round);
},
- getBottomLeft: function () { // -> Point
+ // @method getBottomLeft(): Point
+ // Returns the bottom-left point of the bounds.
+ getBottomLeft: function () {
return new L.Point(this.min.x, this.max.y);
},
+ // @method getTopRight(): Point
+ // Returns the top-right point of the bounds.
getTopRight: function () { // -> Point
return new L.Point(this.max.x, this.min.y);
},
+ // @method getSize(): Point
+ // Returns the size of the given bounds
getSize: function () {
return this.max.subtract(this.min);
},
- contains: function (obj) { // (Bounds) or (Point) -> Boolean
+ // @method contains(otherBounds: Bounds): Boolean
+ // Returns `true` if the rectangle contains the given one.
+ // @alternative
+ // @method contains(point: Point): Boolean
+ // Returns `true` if the rectangle contains the given point.
+ contains: function (obj) {
var min, max;
if (typeof obj[0] === 'number' || obj instanceof L.Point) {
(max.y <= this.max.y);
},
+ // @method intersects(otherBounds: Bounds): 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) -> Boolean
bounds = L.bounds(bounds);
return xIntersects && yIntersects;
},
+ // @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) -> Boolean
+ bounds = L.bounds(bounds);
+
+ var min = this.min,
+ max = this.max,
+ min2 = bounds.min,
+ max2 = bounds.max,
+ xOverlaps = (max2.x > min.x) && (min2.x < max.x),
+ yOverlaps = (max2.y > min.y) && (min2.y < max.y);
+
+ return xOverlaps && yOverlaps;
+ },
+
isValid: function () {
return !!(this.min && this.max);
}
};
-L.bounds = function (a, b) { // (Bounds) or (Point, Point) or (Point[])
+
+// @factory L.bounds(topLeft: Point, bottomRight: Point)
+// Creates a Bounds object from two coordinates (usually top-left and bottom-right corners).
+// @alternative
+// @factory L.bounds(points: Point[])
+// Creates a Bounds object from the points it contains
+L.bounds = function (a, b) {
if (!a || a instanceof L.Bounds) {
return a;
}
};
+
/*
- * L.Transformation is an utility class to perform simple point transformations through a 2d-matrix.
+ * @class Transformation
+ * @aka L.Transformation
+ *
+ * Represents an affine transformation: a set of coefficients `a`, `b`, `c`, `d`
+ * for transforming a point of a form `(x, y)` into `(a*x + b, c*y + d)` and doing
+ * the reverse. Used by Leaflet in its projections code.
+ *
+ * @example
+ *
+ * ```js
+ * var transformation = new L.Transformation(2, 5, -1, 10),
+ * p = L.point(1, 2),
+ * p2 = transformation.transform(p), // L.point(7, 8)
+ * p3 = transformation.untransform(p2); // L.point(1, 2)
+ * ```
*/
+
+// factory new L.Transformation(a: Number, b: Number, c: Number, d: Number)
+// Creates a `Transformation` object with the given coefficients.
L.Transformation = function (a, b, c, d) {
this._a = a;
this._b = b;
};
L.Transformation.prototype = {
+ // @method transform(point: Point, scale?: Number): Point
+ // Returns a transformed point, optionally multiplied by the given scale.
+ // Only accepts real `L.Point` instances, not arrays.
transform: function (point, scale) { // (Point, Number) -> Point
return this._transform(point.clone(), scale);
},
return point;
},
+ // @method untransform(point: Point, scale?: Number): Point
+ // Returns the reverse transformation of the given point, optionally divided
+ // by the given scale. Only accepts real `L.Point` instances, not arrays.
untransform: function (point, scale) {
scale = scale || 1;
return new L.Point(
};
+
/*
- * L.DomUtil contains various utility functions for working with DOM.
+ * @namespace DomUtil
+ *
+ * Utility functions to work with the [DOM](https://developer.mozilla.org/docs/Web/API/Document_Object_Model)
+ * tree, used by Leaflet internally.
+ *
+ * Most functions expecting or returning a `HTMLElement` also work for
+ * SVG elements. The only difference is that classes refer to CSS classes
+ * in HTML and SVG classes in SVG.
*/
L.DomUtil = {
+
+ // @function get(id: String|HTMLElement): HTMLElement
+ // Returns an element given its DOM id, or returns the element itself
+ // if it was passed directly.
get: function (id) {
- return (typeof id === 'string' ? document.getElementById(id) : id);
+ return typeof id === 'string' ? document.getElementById(id) : id;
},
+ // @function getStyle(el: HTMLElement, styleAttrib: String): String
+ // Returns the value for a certain style attribute on an element,
+ // including computed values or values set through CSS.
getStyle: function (el, style) {
- var value = el.style[style];
-
- if (!value && el.currentStyle) {
- value = el.currentStyle[style];
- }
+ var value = el.style[style] || (el.currentStyle && el.currentStyle[style]);
if ((!value || value === 'auto') && document.defaultView) {
var css = document.defaultView.getComputedStyle(el, null);
return value === 'auto' ? null : value;
},
- getViewportOffset: function (element) {
-
- var top = 0,
- left = 0,
- el = element,
- docBody = document.body,
- docEl = document.documentElement,
- pos;
-
- do {
- top += el.offsetTop || 0;
- left += el.offsetLeft || 0;
-
- //add borders
- top += parseInt(L.DomUtil.getStyle(el, 'borderTopWidth'), 10) || 0;
- left += parseInt(L.DomUtil.getStyle(el, 'borderLeftWidth'), 10) || 0;
-
- pos = L.DomUtil.getStyle(el, 'position');
-
- if (el.offsetParent === docBody && pos === 'absolute') { break; }
-
- if (pos === 'fixed') {
- top += docBody.scrollTop || docEl.scrollTop || 0;
- left += docBody.scrollLeft || docEl.scrollLeft || 0;
- break;
- }
-
- if (pos === 'relative' && !el.offsetLeft) {
- var width = L.DomUtil.getStyle(el, 'width'),
- maxWidth = L.DomUtil.getStyle(el, 'max-width'),
- r = el.getBoundingClientRect();
-
- if (width !== 'none' || maxWidth !== 'none') {
- left += r.left + el.clientLeft;
- }
-
- //calculate full y offset since we're breaking out of the loop
- top += r.top + (docBody.scrollTop || docEl.scrollTop || 0);
-
- break;
- }
-
- el = el.offsetParent;
-
- } while (el);
-
- el = element;
-
- do {
- if (el === docBody) { break; }
+ // @function create(tagName: String, className?: String, container?: HTMLElement): HTMLElement
+ // Creates an HTML element with `tagName`, sets its class to `className`, and optionally appends it to `container` element.
+ create: function (tagName, className, container) {
- top -= el.scrollTop || 0;
- left -= el.scrollLeft || 0;
+ var el = document.createElement(tagName);
+ el.className = className || '';
- el = el.parentNode;
- } while (el);
+ if (container) {
+ container.appendChild(el);
+ }
- return new L.Point(left, top);
+ return el;
},
- documentIsLtr: function () {
- if (!L.DomUtil._docIsLtrCached) {
- L.DomUtil._docIsLtrCached = true;
- L.DomUtil._docIsLtr = L.DomUtil.getStyle(document.body, 'direction') === 'ltr';
+ // @function remove(el: HTMLElement)
+ // Removes `el` from its parent element
+ remove: function (el) {
+ var parent = el.parentNode;
+ if (parent) {
+ parent.removeChild(el);
}
- return L.DomUtil._docIsLtr;
},
- create: function (tagName, className, container) {
-
- var el = document.createElement(tagName);
- el.className = className;
-
- if (container) {
- container.appendChild(el);
+ // @function empty(el: HTMLElement)
+ // Removes all of `el`'s children elements from `el`
+ empty: function (el) {
+ while (el.firstChild) {
+ el.removeChild(el.firstChild);
}
+ },
- return el;
+ // @function toFront(el: HTMLElement)
+ // Makes `el` the last children of its parent, so it renders in front of the other children.
+ toFront: function (el) {
+ el.parentNode.appendChild(el);
},
+ // @function toBack(el: HTMLElement)
+ // Makes `el` the first children of its parent, so it renders back from the other children.
+ toBack: function (el) {
+ var parent = el.parentNode;
+ parent.insertBefore(el, parent.firstChild);
+ },
+
+ // @function hasClass(el: HTMLElement, name: String): Boolean
+ // Returns `true` if the element's class attribute contains `name`.
hasClass: function (el, name) {
if (el.classList !== undefined) {
return el.classList.contains(name);
}
- var className = L.DomUtil._getClass(el);
+ var className = L.DomUtil.getClass(el);
return className.length > 0 && new RegExp('(^|\\s)' + name + '(\\s|$)').test(className);
},
+ // @function addClass(el: HTMLElement, name: String)
+ // Adds `name` to the element's class attribute.
addClass: function (el, name) {
if (el.classList !== undefined) {
var classes = L.Util.splitWords(name);
el.classList.add(classes[i]);
}
} else if (!L.DomUtil.hasClass(el, name)) {
- var className = L.DomUtil._getClass(el);
- L.DomUtil._setClass(el, (className ? className + ' ' : '') + name);
+ var className = L.DomUtil.getClass(el);
+ L.DomUtil.setClass(el, (className ? className + ' ' : '') + name);
}
},
+ // @function removeClass(el: HTMLElement, name: String)
+ // Removes `name` from the element's class attribute.
removeClass: function (el, name) {
if (el.classList !== undefined) {
el.classList.remove(name);
} else {
- L.DomUtil._setClass(el, L.Util.trim((' ' + L.DomUtil._getClass(el) + ' ').replace(' ' + name + ' ', ' ')));
+ L.DomUtil.setClass(el, L.Util.trim((' ' + L.DomUtil.getClass(el) + ' ').replace(' ' + name + ' ', ' ')));
}
},
- _setClass: function (el, name) {
+ // @function setClass(el: HTMLElement, name: String)
+ // Sets the element's class.
+ setClass: function (el, name) {
if (el.className.baseVal === undefined) {
el.className = name;
} else {
}
},
- _getClass: function (el) {
+ // @function getClass(el: HTMLElement): String
+ // Returns the element's class.
+ getClass: function (el) {
return el.className.baseVal === undefined ? el.className : el.className.baseVal;
},
+ // @function setOpacity(el: HTMLElement, opacity: Number)
+ // Set the opacity of an element (including old IE support).
+ // `opacity` must be a number from `0` to `1`.
setOpacity: function (el, value) {
if ('opacity' in el.style) {
el.style.opacity = value;
} else if ('filter' in el.style) {
+ L.DomUtil._setOpacityIE(el, value);
+ }
+ },
- var filter = false,
- filterName = 'DXImageTransform.Microsoft.Alpha';
+ _setOpacityIE: function (el, value) {
+ var filter = false,
+ filterName = 'DXImageTransform.Microsoft.Alpha';
- // filters collection throws an error if we try to retrieve a filter that doesn't exist
- try {
- filter = el.filters.item(filterName);
- } catch (e) {
- // don't set opacity to 1 if we haven't already set an opacity,
- // it isn't needed and breaks transparent pngs.
- if (value === 1) { return; }
- }
+ // filters collection throws an error if we try to retrieve a filter that doesn't exist
+ try {
+ filter = el.filters.item(filterName);
+ } catch (e) {
+ // don't set opacity to 1 if we haven't already set an opacity,
+ // it isn't needed and breaks transparent pngs.
+ if (value === 1) { return; }
+ }
- value = Math.round(value * 100);
+ value = Math.round(value * 100);
- if (filter) {
- filter.Enabled = (value !== 100);
- filter.Opacity = value;
- } else {
- el.style.filter += ' progid:' + filterName + '(opacity=' + value + ')';
- }
+ if (filter) {
+ filter.Enabled = (value !== 100);
+ filter.Opacity = value;
+ } else {
+ el.style.filter += ' progid:' + filterName + '(opacity=' + value + ')';
}
},
+ // @function testProp(props: String[]): String|false
+ // Goes through the array of style names and returns the first name
+ // that is a valid style name for an element. If no such name is found,
+ // it returns false. Useful for vendor-prefixed styles like `transform`.
testProp: function (props) {
var style = document.documentElement.style;
return false;
},
- getTranslateString: function (point) {
- // on WebKit browsers (Chrome/Safari/iOS Safari/Android) using translate3d instead of translate
- // makes animation smoother as it ensures HW accel is used. Firefox 13 doesn't care
- // (same speed either way), Opera 12 doesn't support translate3d
-
- var is3d = L.Browser.webkit3d,
- open = 'translate' + (is3d ? '3d' : '') + '(',
- close = (is3d ? ',0' : '') + ')';
+ // @function setTransform(el: HTMLElement, offset: Point, scale?: Number)
+ // Resets the 3D CSS transform of `el` so it is translated by `offset` pixels
+ // and optionally scaled by `scale`. Does not have an effect if the
+ // browser doesn't support 3D CSS transforms.
+ setTransform: function (el, offset, scale) {
+ var pos = offset || new L.Point(0, 0);
- return open + point.x + 'px,' + point.y + 'px' + close;
+ el.style[L.DomUtil.TRANSFORM] =
+ (L.Browser.ie3d ?
+ 'translate(' + pos.x + 'px,' + pos.y + 'px)' :
+ 'translate3d(' + pos.x + 'px,' + pos.y + 'px,0)') +
+ (scale ? ' scale(' + scale + ')' : '');
},
- getScaleString: function (scale, origin) {
+ // @function setPosition(el: HTMLElement, position: Point)
+ // Sets the position of `el` to coordinates specified by `position`,
+ // using CSS translate or top/left positioning depending on the browser
+ // (used by Leaflet internally to position its layers).
+ setPosition: function (el, point) { // (HTMLElement, Point[, Boolean])
- var preTranslateStr = L.DomUtil.getTranslateString(origin.add(origin.multiplyBy(-1 * scale))),
- scaleStr = ' scale(' + scale + ') ';
-
- return preTranslateStr + scaleStr;
- },
-
- setPosition: function (el, point, disable3D) { // (HTMLElement, Point[, Boolean])
-
- // jshint camelcase: false
+ /*eslint-disable */
el._leaflet_pos = point;
+ /*eslint-enable */
- if (!disable3D && L.Browser.any3d) {
- el.style[L.DomUtil.TRANSFORM] = L.DomUtil.getTranslateString(point);
+ if (L.Browser.any3d) {
+ L.DomUtil.setTransform(el, point);
} else {
el.style.left = point.x + 'px';
el.style.top = point.y + 'px';
}
},
+ // @function getPosition(el: HTMLElement): Point
+ // Returns the coordinates of an element previously positioned with setPosition.
getPosition: function (el) {
// this method is only used for elements previously positioned using setPosition,
// so it's safe to cache the position for performance
- // jshint camelcase: false
- return el._leaflet_pos;
+ return el._leaflet_pos || new L.Point(0, 0);
}
};
-// prefix style property names
+(function () {
+ // prefix style property names
-L.DomUtil.TRANSFORM = L.DomUtil.testProp(
- ['transform', 'WebkitTransform', 'OTransform', 'MozTransform', 'msTransform']);
+ // @property TRANSFORM: String
+ // Vendor-prefixed fransform style name (e.g. `'webkitTransform'` for WebKit).
+ L.DomUtil.TRANSFORM = L.DomUtil.testProp(
+ ['transform', 'WebkitTransform', 'OTransform', 'MozTransform', 'msTransform']);
-// webkitTransition comes first because some browser versions that drop vendor prefix don't do
-// the same for the transitionend event, in particular the Android 4.1 stock browser
-L.DomUtil.TRANSITION = L.DomUtil.testProp(
- ['webkitTransition', 'transition', 'OTransition', 'MozTransition', 'msTransition']);
+ // webkitTransition comes first because some browser versions that drop vendor prefix don't do
+ // the same for the transitionend event, in particular the Android 4.1 stock browser
-L.DomUtil.TRANSITION_END =
- L.DomUtil.TRANSITION === 'webkitTransition' || L.DomUtil.TRANSITION === 'OTransition' ?
- L.DomUtil.TRANSITION + 'End' : 'transitionend';
+ // @property TRANSITION: String
+ // Vendor-prefixed transform style name.
+ var transition = L.DomUtil.TRANSITION = L.DomUtil.testProp(
+ ['webkitTransition', 'transition', 'OTransition', 'MozTransition', 'msTransition']);
-(function () {
- if ('onselectstart' in document) {
- L.extend(L.DomUtil, {
- disableTextSelection: function () {
- L.DomEvent.on(window, 'selectstart', L.DomEvent.preventDefault);
- },
-
- enableTextSelection: function () {
- L.DomEvent.off(window, 'selectstart', L.DomEvent.preventDefault);
- }
- });
- } else {
- var userSelectProperty = L.DomUtil.testProp(
- ['userSelect', 'WebkitUserSelect', 'OUserSelect', 'MozUserSelect', 'msUserSelect']);
-
- L.extend(L.DomUtil, {
- disableTextSelection: function () {
- if (userSelectProperty) {
- var style = document.documentElement.style;
- this._userSelect = style[userSelectProperty];
- style[userSelectProperty] = 'none';
- }
- },
-
- enableTextSelection: function () {
- if (userSelectProperty) {
- document.documentElement.style[userSelectProperty] = this._userSelect;
- delete this._userSelect;
- }
- }
- });
- }
-
- L.extend(L.DomUtil, {
- disableImageDrag: function () {
- L.DomEvent.on(window, 'dragstart', L.DomEvent.preventDefault);
- },
+ L.DomUtil.TRANSITION_END =
+ transition === 'webkitTransition' || transition === 'OTransition' ? transition + 'End' : 'transitionend';
- enableImageDrag: function () {
- L.DomEvent.off(window, 'dragstart', L.DomEvent.preventDefault);
- }
- });
+ // @function disableTextSelection()
+ // Prevents the user from generating `selectstart` DOM events, usually generated
+ // when the user drags the mouse through a page with text. Used internally
+ // by Leaflet to override the behaviour of any click-and-drag interaction on
+ // the map. Affects drag interactions on the whole document.
+
+ // @function enableTextSelection()
+ // Cancels the effects of a previous [`L.DomUtil.disableTextSelection`](#domutil-disabletextselection).
+ if ('onselectstart' in document) {
+ L.DomUtil.disableTextSelection = function () {
+ L.DomEvent.on(window, 'selectstart', L.DomEvent.preventDefault);
+ };
+ L.DomUtil.enableTextSelection = function () {
+ L.DomEvent.off(window, 'selectstart', L.DomEvent.preventDefault);
+ };
+
+ } else {
+ var userSelectProperty = L.DomUtil.testProp(
+ ['userSelect', 'WebkitUserSelect', 'OUserSelect', 'MozUserSelect', 'msUserSelect']);
+
+ L.DomUtil.disableTextSelection = function () {
+ if (userSelectProperty) {
+ var style = document.documentElement.style;
+ this._userSelect = style[userSelectProperty];
+ style[userSelectProperty] = 'none';
+ }
+ };
+ L.DomUtil.enableTextSelection = function () {
+ if (userSelectProperty) {
+ document.documentElement.style[userSelectProperty] = this._userSelect;
+ delete this._userSelect;
+ }
+ };
+ }
+
+ // @function disableImageDrag()
+ // As [`L.DomUtil.disableTextSelection`](#domutil-disabletextselection), but
+ // for `dragstart` DOM events, usually generated when the user drags an image.
+ L.DomUtil.disableImageDrag = function () {
+ L.DomEvent.on(window, 'dragstart', L.DomEvent.preventDefault);
+ };
+
+ // @function enableImageDrag()
+ // Cancels the effects of a previous [`L.DomUtil.disableImageDrag`](#domutil-disabletextselection).
+ L.DomUtil.enableImageDrag = function () {
+ L.DomEvent.off(window, 'dragstart', L.DomEvent.preventDefault);
+ };
+
+ // @function preventOutline(el: HTMLElement)
+ // Makes the [outline](https://developer.mozilla.org/docs/Web/CSS/outline)
+ // of the element `el` invisible. Used internally by Leaflet to prevent
+ // focusable elements from displaying an outline when the user performs a
+ // drag interaction on them.
+ L.DomUtil.preventOutline = function (element) {
+ while (element.tabIndex === -1) {
+ element = element.parentNode;
+ }
+ if (!element || !element.style) { return; }
+ L.DomUtil.restoreOutline();
+ this._outlineElement = element;
+ this._outlineStyle = element.style.outline;
+ element.style.outline = 'none';
+ L.DomEvent.on(window, 'keydown', L.DomUtil.restoreOutline, this);
+ };
+
+ // @function restoreOutline()
+ // Cancels the effects of a previous [`L.DomUtil.preventOutline`]().
+ L.DomUtil.restoreOutline = function () {
+ if (!this._outlineElement) { return; }
+ this._outlineElement.style.outline = this._outlineStyle;
+ delete this._outlineElement;
+ delete this._outlineStyle;
+ L.DomEvent.off(window, 'keydown', L.DomUtil.restoreOutline, this);
+ };
})();
-/*
- * L.LatLng represents a geographical point with latitude and longitude coordinates.
- */
-L.LatLng = function (lat, lng, alt) { // (Number, Number, Number)
- lat = parseFloat(lat);
- lng = parseFloat(lng);
+/* @class LatLng
+ * @aka L.LatLng
+ *
+ * Represents a geographical point with a certain latitude and longitude.
+ *
+ * @example
+ *
+ * ```
+ * var latlng = L.latLng(50.5, 30.5);
+ * ```
+ *
+ * All Leaflet methods that accept LatLng objects also accept them in a simple Array form and simple object form (unless noted otherwise), so these lines are equivalent:
+ *
+ * ```
+ * map.panTo([50, 30]);
+ * map.panTo({lon: 30, lat: 50});
+ * map.panTo({lat: 50, lng: 30});
+ * map.panTo(L.latLng(50, 30));
+ * ```
+ */
+L.LatLng = function (lat, lng, alt) {
if (isNaN(lat) || isNaN(lng)) {
throw new Error('Invalid LatLng object: (' + lat + ', ' + lng + ')');
}
- this.lat = lat;
- this.lng = lng;
+ // @property lat: Number
+ // Latitude in degrees
+ this.lat = +lat;
+
+ // @property lng: Number
+ // Longitude in degrees
+ this.lng = +lng;
+ // @property alt: Number
+ // Altitude in meters (optional)
if (alt !== undefined) {
- this.alt = parseFloat(alt);
+ this.alt = +alt;
}
};
-L.extend(L.LatLng, {
- DEG_TO_RAD: Math.PI / 180,
- RAD_TO_DEG: 180 / Math.PI,
- MAX_MARGIN: 1.0E-9 // max margin of error for the "equals" check
-});
-
L.LatLng.prototype = {
- equals: function (obj) { // (LatLng) -> Boolean
+ // @method equals(otherLatLng: LatLng, maxMargin?: Number): Boolean
+ // Returns `true` if the given `LatLng` point is at the same position (within a small margin of error). The margin of error can be overriden by setting `maxMargin` to a small number.
+ equals: function (obj, maxMargin) {
if (!obj) { return false; }
obj = L.latLng(obj);
Math.abs(this.lat - obj.lat),
Math.abs(this.lng - obj.lng));
- return margin <= L.LatLng.MAX_MARGIN;
+ return margin <= (maxMargin === undefined ? 1.0E-9 : maxMargin);
},
- toString: function (precision) { // (Number) -> String
+ // @method toString(): String
+ // Returns a string representation of the point (for debugging purposes).
+ toString: function (precision) {
return 'LatLng(' +
L.Util.formatNum(this.lat, precision) + ', ' +
L.Util.formatNum(this.lng, precision) + ')';
},
- // Haversine distance formula, see http://en.wikipedia.org/wiki/Haversine_formula
- // TODO move to projection code, LatLng shouldn't know about Earth
- distanceTo: function (other) { // (LatLng) -> Number
- other = L.latLng(other);
+ // @method distanceTo(otherLatLng: LatLng): Number
+ // Returns the distance (in meters) to the given `LatLng` calculated using the [Haversine formula](http://en.wikipedia.org/wiki/Haversine_formula).
+ distanceTo: function (other) {
+ return L.CRS.Earth.distance(this, L.latLng(other));
+ },
- var R = 6378137, // earth radius in meters
- d2r = L.LatLng.DEG_TO_RAD,
- dLat = (other.lat - this.lat) * d2r,
- dLon = (other.lng - this.lng) * d2r,
- lat1 = this.lat * d2r,
- lat2 = other.lat * d2r,
- sin1 = Math.sin(dLat / 2),
- sin2 = Math.sin(dLon / 2);
+ // @method wrap(): LatLng
+ // Returns a new `LatLng` object with the longitude wrapped so it's always between -180 and +180 degrees.
+ wrap: function () {
+ return L.CRS.Earth.wrapLatLng(this);
+ },
- var a = sin1 * sin1 + sin2 * sin2 * Math.cos(lat1) * Math.cos(lat2);
+ // @method toBounds(sizeInMeters: Number): LatLngBounds
+ // Returns a new `LatLngBounds` object in which each boundary is `sizeInMeters` meters apart from the `LatLng`.
+ toBounds: function (sizeInMeters) {
+ var latAccuracy = 180 * sizeInMeters / 40075017,
+ lngAccuracy = latAccuracy / Math.cos((Math.PI / 180) * this.lat);
- return R * 2 * Math.atan2(Math.sqrt(a), Math.sqrt(1 - a));
+ return L.latLngBounds(
+ [this.lat - latAccuracy, this.lng - lngAccuracy],
+ [this.lat + latAccuracy, this.lng + lngAccuracy]);
},
- wrap: function (a, b) { // (Number, Number) -> LatLng
- var lng = this.lng;
+ clone: function () {
+ return new L.LatLng(this.lat, this.lng, this.alt);
+ }
+};
- a = a || -180;
- b = b || 180;
- lng = (lng + b) % (b - a) + (lng < a || lng === b ? b : a);
- return new L.LatLng(this.lat, lng);
- }
-};
+// @factory L.latLng(latitude: Number, longitude: Number, altitude?: Number): LatLng
+// Creates an object representing a geographical point with the given latitude and longitude (and optionally altitude).
+
+// @alternative
+// @factory L.latLng(coords: Array): LatLng
+// Expects an array of the form `[Number, Number]` or `[Number, Number, Number]` instead.
-L.latLng = function (a, b) { // (LatLng) or ([Number, Number]) or (Number, Number)
+// @alternative
+// @factory L.latLng(coords: Object): LatLng
+// Expects an plain object of the form `{lat: Number, lng: Number}` or `{lat: Number, lng: Number, alt: Number}` instead.
+
+L.latLng = function (a, b, c) {
if (a instanceof L.LatLng) {
return a;
}
- if (L.Util.isArray(a)) {
- if (typeof a[0] === 'number' || typeof a[0] === 'string') {
+ if (L.Util.isArray(a) && typeof a[0] !== 'object') {
+ if (a.length === 3) {
return new L.LatLng(a[0], a[1], a[2]);
- } else {
- return null;
}
+ if (a.length === 2) {
+ return new L.LatLng(a[0], a[1]);
+ }
+ return null;
}
if (a === undefined || a === null) {
return a;
}
if (typeof a === 'object' && 'lat' in a) {
- return new L.LatLng(a.lat, 'lng' in a ? a.lng : a.lon);
+ return new L.LatLng(a.lat, 'lng' in a ? a.lng : a.lon, a.alt);
}
if (b === undefined) {
return null;
}
- return new L.LatLng(a, b);
+ return new L.LatLng(a, b, c);
};
/*
- * L.LatLngBounds represents a rectangular area on the map in geographical coordinates.
+ * @class LatLngBounds
+ * @aka L.LatLngBounds
+ *
+ * Represents a rectangular geographical area on a map.
+ *
+ * @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:
+ *
+ * ```js
+ * map.fitBounds([
+ * [40.712, -74.227],
+ * [40.774, -74.125]
+ * ]);
+ * ```
*/
L.LatLngBounds = function (southWest, northEast) { // (LatLng, LatLng) or (LatLng[])
};
L.LatLngBounds.prototype = {
- // extend the bounds to contain the given point or bounds
- extend: function (obj) { // (LatLng) or (LatLngBounds)
- if (!obj) { return this; }
- var latLng = L.latLng(obj);
- if (latLng !== null) {
- obj = latLng;
- } else {
- obj = L.latLngBounds(obj);
- }
+ // @method extend(latlng: LatLng): this
+ // Extend the bounds to contain the given 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;
if (obj instanceof L.LatLng) {
- if (!this._southWest && !this._northEast) {
- this._southWest = new L.LatLng(obj.lat, obj.lng);
- this._northEast = new L.LatLng(obj.lat, obj.lng);
- } else {
- this._southWest.lat = Math.min(obj.lat, this._southWest.lat);
- this._southWest.lng = Math.min(obj.lng, this._southWest.lng);
+ sw2 = obj;
+ ne2 = obj;
- this._northEast.lat = Math.max(obj.lat, this._northEast.lat);
- this._northEast.lng = Math.max(obj.lng, this._northEast.lng);
- }
} else if (obj instanceof L.LatLngBounds) {
- this.extend(obj._southWest);
- this.extend(obj._northEast);
+ sw2 = obj._southWest;
+ ne2 = obj._northEast;
+
+ if (!sw2 || !ne2) { return this; }
+
+ } else {
+ return obj ? this.extend(L.latLng(obj) || L.latLngBounds(obj)) : this;
+ }
+
+ 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);
}
+
return this;
},
- // extend the bounds by a percentage
- pad: function (bufferRatio) { // (Number) -> LatLngBounds
+ // @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,
new L.LatLng(ne.lat + heightBuffer, ne.lng + widthBuffer));
},
- getCenter: function () { // -> LatLng
+ // @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);
},
+ // @method getSouthWest(): LatLng
+ // Returns the south-west point of the bounds.
getSouthWest: function () {
return this._southWest;
},
+ // @method getNorthEast(): LatLng
+ // Returns the north-east point of the bounds.
getNorthEast: function () {
return this._northEast;
},
+ // @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;
},
+ // @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;
},
+ // @method contains(otherBounds: LatLngBounds): Boolean
+ // Returns `true` if the rectangle contains the given one.
+
+ // @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);
(sw2.lng >= sw.lng) && (ne2.lng <= ne.lng);
},
- intersects: function (bounds) { // (LatLngBounds)
+ // @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);
var sw = this._southWest,
return latIntersects && lngIntersects;
},
+ // @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);
+
+ var sw = this._southWest,
+ ne = this._northEast,
+ sw2 = bounds.getSouthWest(),
+ ne2 = bounds.getNorthEast(),
+
+ latOverlaps = (ne2.lat > sw.lat) && (sw2.lat < ne.lat),
+ lngOverlaps = (ne2.lng > sw.lng) && (sw2.lng < ne.lng);
+
+ return latOverlaps && lngOverlaps;
+ },
+
+ // @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(',');
},
- equals: function (bounds) { // (LatLngBounds)
+ // @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; }
bounds = L.latLngBounds(bounds);
this._northEast.equals(bounds.getNorthEast());
},
+ // @method isValid(): Boolean
+ // Returns `true` if the bounds are properly initialized.
isValid: function () {
return !!(this._southWest && this._northEast);
}
};
-//TODO International date line?
+// TODO International date line?
-L.latLngBounds = function (a, b) { // (LatLngBounds) or (LatLng, LatLng)
- if (!a || a instanceof L.LatLngBounds) {
+// @factory L.latLngBounds(southWest: LatLng, northEast: LatLng)
+// Creates a `LatLngBounds` object by defining south-west and north-east corners of the rectangle.
+
+// @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);
};
+
/*
- * L.Projection contains various geographical projections used by CRS classes.
+ * @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.
*/
L.Projection = {};
+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])
+};
+
+
/*
- * Spherical Mercator is the most popular map projection, used by EPSG:3857 CRS used by default.
+ * @namespace Projection
+ * @projection L.Projection.SphericalMercator
+ *
+ * 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.
*/
L.Projection.SphericalMercator = {
+
+ R: 6378137,
MAX_LATITUDE: 85.0511287798,
- project: function (latlng) { // (LatLng) -> Point
- var d = L.LatLng.DEG_TO_RAD,
+ project: function (latlng) {
+ var d = Math.PI / 180,
max = this.MAX_LATITUDE,
lat = Math.max(Math.min(max, latlng.lat), -max),
- x = latlng.lng * d,
- y = lat * d;
+ sin = Math.sin(lat * d);
- y = Math.log(Math.tan((Math.PI / 4) + (y / 2)));
-
- return new L.Point(x, y);
+ return new L.Point(
+ this.R * latlng.lng * d,
+ this.R * Math.log((1 + sin) / (1 - sin)) / 2);
},
- unproject: function (point) { // (Point, Boolean) -> LatLng
- var d = L.LatLng.RAD_TO_DEG,
- lng = point.x * d,
- lat = (2 * Math.atan(Math.exp(point.y)) - (Math.PI / 2)) * d;
-
- return new L.LatLng(lat, lng);
- }
-};
-
-
-/*
- * Simple equirectangular (Plate Carree) projection, used by CRS like EPSG:4326 and Simple.
- */
+ unproject: function (point) {
+ var d = 180 / Math.PI;
-L.Projection.LonLat = {
- project: function (latlng) {
- return new L.Point(latlng.lng, latlng.lat);
+ return new L.LatLng(
+ (2 * Math.atan(Math.exp(point.y / this.R)) - (Math.PI / 2)) * d,
+ point.x * d / this.R);
},
- unproject: function (point) {
- return new L.LatLng(point.y, point.x);
- }
+ bounds: (function () {
+ var d = 6378137 * Math.PI;
+ return L.bounds([-d, -d], [d, d]);
+ })()
};
+
/*
- * L.CRS is a base object for all defined CRS (Coordinate Reference Systems) in Leaflet.
+ * @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.
*/
L.CRS = {
- latLngToPoint: function (latlng, zoom) { // (LatLng, Number) -> Point
+ // @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);
return this.transformation._transform(projectedPoint, scale);
},
- pointToLatLng: function (point, zoom) { // (Point, Number[, Boolean]) -> LatLng
+ // @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);
return this.projection.unproject(untransformedPoint);
},
+ // @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);
},
+ // @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);
+ },
+
+ // @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);
},
- getSize: function (zoom) {
- var s = this.scale(zoom);
- return L.point(s, s);
+ // @method zoom(scale: Number): Number
+ // Inverse of `scale()`, returns the zoom level corresponding to a scale
+ // factor of `scale`.
+ zoom: function (scale) {
+ return Math.log(scale / 256) / Math.LN2;
+ },
+
+ // @method getProjectedBounds(zoom: Number): 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);
+ },
+
+ // @method distance(latlng1: LatLng, latlng2: 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;
+
+ return L.latLng(lat, lng, alt);
}
};
+
/*
- * A simple CRS that can be used for flat non-Earth maps like panoramas or game maps.
+ * @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.
*/
L.CRS.Simple = L.extend({}, L.CRS, {
scale: function (zoom) {
return Math.pow(2, zoom);
+ },
+
+ zoom: function (scale) {
+ return Math.log(scale) / Math.LN2;
+ },
+
+ distance: function (latlng1, latlng2) {
+ var dx = latlng2.lng - latlng1.lng,
+ dy = latlng2.lat - latlng1.lat;
+
+ return Math.sqrt(dx * dx + dy * dy);
+ },
+
+ 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);
+
+ return this.R * Math.acos(Math.min(a, 1));
}
});
+
/*
- * L.CRS.EPSG3857 (Spherical Mercator) is the most common CRS for web mapping
- * and is used by Leaflet by default.
+ * @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.
*/
-L.CRS.EPSG3857 = L.extend({}, L.CRS, {
+L.CRS.EPSG3857 = L.extend({}, L.CRS.Earth, {
code: 'EPSG:3857',
-
projection: L.Projection.SphericalMercator,
- transformation: new L.Transformation(0.5 / Math.PI, 0.5, -0.5 / Math.PI, 0.5),
- project: function (latlng) { // (LatLng) -> Point
- var projectedPoint = this.projection.project(latlng),
- earthRadius = 6378137;
- return projectedPoint.multiplyBy(earthRadius);
- }
+ transformation: (function () {
+ var scale = 0.5 / (Math.PI * L.Projection.SphericalMercator.R);
+ return new L.Transformation(scale, 0.5, -scale, 0.5);
+ }())
});
L.CRS.EPSG900913 = L.extend({}, L.CRS.EPSG3857, {
});
+
/*
- * L.CRS.EPSG4326 is a CRS popular among advanced GIS specialists.
+ * @namespace CRS
+ * @crs L.CRS.EPSG4326
+ *
+ * A common CRS among GIS enthusiasts. Uses simple Equirectangular projection.
*/
-L.CRS.EPSG4326 = L.extend({}, L.CRS, {
+L.CRS.EPSG4326 = L.extend({}, L.CRS.Earth, {
code: 'EPSG:4326',
-
projection: L.Projection.LonLat,
- transformation: new L.Transformation(1 / 360, 0.5, -1 / 360, 0.5)
+ transformation: new L.Transformation(1 / 180, 1, -1 / 180, 0.5)
});
+
/*
- * L.Map is the central class of the API - it is used to create a map.
+ * @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.
+ *
+ * @example
+ *
+ * ```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
+ * });
+ * ```
+ *
*/
-L.Map = L.Class.extend({
-
- includes: L.Mixin.Events,
+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,
- /*
- center: LatLng,
- zoom: Number,
- layers: Array,
- */
-
- fadeAnimation: L.DomUtil.TRANSITION && !L.Browser.android23,
- trackResize: true,
- markerZoomAnimation: L.DomUtil.TRANSITION && L.Browser.any3d
+ // @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 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,
+
+ // @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,
+
+ // @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,
+
+ // @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,
+
+ // @option trackResize: Boolean = true
+ // Whether the map automatically handles browser window resize to update itself.
+ trackResize: true
},
initialize: function (id, options) { // (HTMLElement or String, Object)
options = L.setOptions(this, options);
-
this._initContainer(id);
this._initLayout();
this.setMaxBounds(options.maxBounds);
}
+ if (options.zoom !== undefined) {
+ this._zoom = this._limitZoom(options.zoom);
+ }
+
if (options.center && options.zoom !== undefined) {
this.setView(L.latLng(options.center), options.zoom, {reset: true});
}
this._handlers = [];
-
this._layers = {};
this._zoomBoundLayers = {};
- this._tileLayersNum = 0;
+ this._sizeChanged = true;
this.callInitHooks();
- this._addLayers(options.layers);
+ this._addLayers(this.options.layers);
},
- // public methods that modify map state
+ // @section Methods for modifying map state
- // replaced by animation-powered implementation in Map.PanAnimation.js
+ // @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), this._limitZoom(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 = this._limitZoom(zoom);
+ this._zoom = zoom;
return this;
}
return this.setView(this.getCenter(), zoom, {zoom: options});
},
+ // @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) {
- return this.setZoom(this._zoom + (delta || 1), options);
+ delta = delta || (L.Browser.any3d ? this.options.zoomDelta : 1);
+ return this.setZoom(this._zoom + delta, options);
},
+ // @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) {
- return this.setZoom(this._zoom - (delta || 1), options);
+ delta = delta || (L.Browser.any3d ? this.options.zoomDelta : 1);
+ return this.setZoom(this._zoom - delta, options);
},
+ // @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),
return this.setView(newCenter, zoom, {zoom: options});
},
- fitBounds: function (bounds, options) {
+ _getBoundsCenterZoom: function (bounds, options) {
options = options || {};
bounds = bounds.getBounds ? bounds.getBounds() : L.latLngBounds(bounds);
zoom = this.getBoundsZoom(bounds, false, paddingTL.add(paddingBR));
- zoom = (options.maxZoom) ? Math.min(options.maxZoom, zoom) : zoom;
+ zoom = (typeof options.maxZoom === 'number') ? Math.min(options.maxZoom, zoom) : zoom;
var paddingOffset = paddingBR.subtract(paddingTL).divideBy(2),
nePoint = this.project(bounds.getNorthEast(), zoom),
center = this.unproject(swPoint.add(nePoint).divideBy(2).add(paddingOffset), zoom);
- return this.setView(center, zoom, options);
+ return {
+ center: center,
+ zoom: zoom
+ };
+ },
+
+ // @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) {
+
+ bounds = L.latLngBounds(bounds);
+
+ if (!bounds.isValid()) {
+ throw new Error('Bounds are not valid.');
+ }
+
+ var target = this._getBoundsCenterZoom(bounds, options);
+ return this.setView(target.center, target.zoom, options);
},
+ // @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);
},
+ // @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});
},
+ // @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');
return this.fire('moveend');
},
+ // @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);
- this.options.maxBounds = bounds;
-
- if (!bounds) {
- return this.off('moveend', this._panInsideMaxBounds, this);
+ if (!bounds.isValid()) {
+ this.options.maxBounds = null;
+ return this.off('moveend', this._panInsideMaxBounds);
+ } else if (this.options.maxBounds) {
+ this.off('moveend', this._panInsideMaxBounds);
}
+ this.options.maxBounds = bounds;
+
if (this._loaded) {
this._panInsideMaxBounds();
}
- return this.on('moveend', this._panInsideMaxBounds, this);
- },
-
- panInsideBounds: function (bounds, options) {
- var center = this.getCenter(),
- newCenter = this._limitCenter(center, this._zoom, bounds);
-
- if (center.equals(newCenter)) { return this; }
-
- return this.panTo(newCenter, options);
+ return this.on('moveend', this._panInsideMaxBounds);
},
- addLayer: function (layer) {
- // TODO method is too big, refactor
-
- var id = L.stamp(layer);
-
- if (this._layers[id]) { return this; }
-
- this._layers[id] = layer;
-
- // TODO getMaxZoom, getMinZoom in ILayer (instead of options)
- if (layer.options && (!isNaN(layer.options.maxZoom) || !isNaN(layer.options.minZoom))) {
- this._zoomBoundLayers[id] = layer;
- this._updateZoomLevels();
- }
-
- // TODO looks ugly, refactor!!!
- if (this.options.zoomAnimation && L.TileLayer && (layer instanceof L.TileLayer)) {
- this._tileLayersNum++;
- this._tileLayersToLoad++;
- layer.on('load', this._onTileLayerLoad, this);
- }
+ // @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;
- if (this._loaded) {
- this._layerAdd(layer);
+ if (this._loaded && this.getZoom() < this.options.minZoom) {
+ return this.setZoom(zoom);
}
return this;
},
- removeLayer: function (layer) {
- var id = L.stamp(layer);
-
- if (!this._layers[id]) { return this; }
-
- if (this._loaded) {
- layer.onRemove(this);
- }
-
- delete this._layers[id];
-
- if (this._loaded) {
- this.fire('layerremove', {layer: layer});
- }
-
- if (this._zoomBoundLayers[id]) {
- delete this._zoomBoundLayers[id];
- this._updateZoomLevels();
- }
+ // @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;
- // TODO looks ugly, refactor
- if (this.options.zoomAnimation && L.TileLayer && (layer instanceof L.TileLayer)) {
- this._tileLayersNum--;
- this._tileLayersToLoad--;
- layer.off('load', this._onTileLayerLoad, this);
+ if (this._loaded && (this.getZoom() > this.options.maxZoom)) {
+ return this.setZoom(zoom);
}
return this;
},
- hasLayer: function (layer) {
- if (!layer) { return false; }
-
- return (L.stamp(layer) in this._layers);
- },
+ // @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));
- eachLayer: function (method, context) {
- for (var i in this._layers) {
- method.call(context, this._layers[i]);
+ if (!center.equals(newCenter)) {
+ this.panTo(newCenter, options);
}
+
+ this._enforcingBounds = false;
return this;
},
+ // @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; }
var oldSize = this.getSize();
this._sizeChanged = true;
- this._initialCenter = null;
+ this._lastCenter = null;
var newSize = this.getSize(),
oldCenter = oldSize.divideBy(2).round(),
}
}
+ // @section Map state change events
+ // @event resize: ResizeEvent
+ // Fired when the map is resized.
return this.fire('resize', {
oldSize: oldSize,
newSize: newSize
});
},
+ // @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();
+ },
+
+
// 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; }
return this;
},
+ // @method remove(): this
+ // Destroys the map and clears all related event listeners.
remove: function () {
- if (this._loaded) {
- this.fire('unload');
- }
- this._initEvents('off');
+ this._initEvents(true);
+
+ if (this._containerId !== this._container._leaflet_id) {
+ throw new Error('Map container is being reused by another instance');
+ }
try {
// throws error in IE6-8
- delete this._container._leaflet;
+ delete this._container._leaflet_id;
+ delete this._containerId;
} catch (e) {
- this._container._leaflet = undefined;
+ /*eslint-disable */
+ this._container._leaflet_id = undefined;
+ /*eslint-enable */
+ this._containerId = undefined;
}
- this._clearPanes();
+ L.DomUtil.remove(this._mapPane);
+
if (this._clearControlPos) {
this._clearControlPos();
}
this._clearHandlers();
+ if (this._loaded) {
+ // @section Map state change events
+ // @event unload: Event
+ // Fired when the map is destroyed with [remove](#map-remove) method.
+ this.fire('unload');
+ }
+
+ for (var i in this._layers) {
+ this._layers[i].remove();
+ }
+
return this;
},
+ // @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);
- // public methods for getting map state
+ if (name) {
+ this._panes[name] = pane;
+ }
+ return pane;
+ },
- getCenter: function () { // (Boolean) -> LatLng
+ // @section Methods for Getting Map State
+
+ // @method getCenter(): LatLng
+ // Returns the geographical center of the map view
+ getCenter: function () {
this._checkIfLoaded();
- if (this._initialCenter && !this._moved()) {
- return this._initialCenter;
+ if (this._lastCenter && !this._moved()) {
+ return this._lastCenter;
}
return this.layerPointToLatLng(this._getCenterLayerPoint());
},
+ // @method getZoom(): Number
+ // Returns the current zoom level of the map view
getZoom: function () {
return this._zoom;
},
+ // @method getBounds(): LatLngBounds
+ // Returns the geographical bounds visible in the current map view
getBounds: function () {
var bounds = this.getPixelBounds(),
sw = this.unproject(bounds.getBottomLeft()),
return new L.LatLngBounds(sw, ne);
},
+ // @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 === undefined ? 0 : this._layersMinZoom) :
- this.options.minZoom;
+ return this.options.minZoom === undefined ? this._layersMinZoom || 0 : this.options.minZoom;
},
+ // @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;
},
+ // @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.getMinZoom() - (inside ? 1 : 0),
- maxZoom = this.getMaxZoom(),
- size = this.getSize(),
-
+ 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;
- zoomNotFound = true,
- boundsSize;
-
- padding = L.point(padding || [0, 0]);
-
- do {
- zoom++;
- boundsSize = this.project(se, zoom).subtract(this.project(nw, zoom)).add(padding);
- zoomNotFound = !inside ? size.contains(boundsSize) : boundsSize.x < size.x || boundsSize.y < size.y;
-
- } while (zoomNotFound && zoom <= maxZoom);
+ var scale = Math.min(size.x / boundsSize.x, size.y / boundsSize.y);
+ zoom = this.getScaleZoom(scale, zoom);
- if (zoomNotFound && inside) {
- return null;
+ 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 inside ? zoom : zoom - 1;
+ 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(
return this._size.clone();
},
- getPixelBounds: function () {
- var topLeftPoint = this._getTopLeftPoint();
+ // @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()));
},
+ // 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._initialTopLeftPoint;
+ return this._pixelOrigin;
},
- getPanes: function () {
- return this._panes;
+ // @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);
},
- getContainer: function () {
- return this._container;
+ // @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 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 getContainer: HTMLElement
+ // Returns the HTML element that contains the map.
+ getContainer: function () {
+ return this._container;
},
- // TODO replace with universal implementation after refactoring projections
+ // @section Conversion Methods
- getZoomScale: function (toZoom) {
+ // @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;
- return crs.scale(toZoom) / crs.scale(this._zoom);
+ fromZoom = fromZoom === undefined ? this._zoom : fromZoom;
+ return crs.scale(toZoom) / crs.scale(fromZoom);
},
- getScaleZoom: function (scale) {
- return this._zoom + (Math.log(scale) / Math.LN2);
+ // @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;
+ var zoom = crs.zoom(scale * crs.scale(fromZoom));
+ return isNaN(zoom) ? Infinity : zoom;
},
-
- // conversion methods
-
- project: function (latlng, zoom) { // (LatLng[, Number]) -> Point
+ // @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);
},
- unproject: function (point, zoom) { // (Point[, Number]) -> LatLng
+ // @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);
},
- layerPointToLatLng: function (point) { // (Point)
+ // @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);
},
- latLngToLayerPoint: function (latlng) { // (LatLng)
+ // @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());
},
+ // @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));
+ },
+
+ // @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));
+ },
+
+ // @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());
},
+ // @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());
},
+ // @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);
},
+ // @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)));
},
- mouseEventToContainerPoint: function (e) { // (MouseEvent)
+ // @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);
},
- mouseEventToLayerPoint: function (e) { // (MouseEvent)
+ // @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));
},
+ // @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));
},
if (!container) {
throw new Error('Map container not found.');
- } else if (container._leaflet) {
+ } else if (container._leaflet_id) {
throw new Error('Map container is already initialized.');
}
- container._leaflet = true;
+ L.DomEvent.addListener(container, 'scroll', this._onScroll, this);
+ this._containerId = L.Util.stamp(container);
},
_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' : '') +
- (this.options.fadeAnimation ? ' leaflet-fade-anim' : ''));
+ (L.Browser.safari ? ' leaflet-safari' : '') +
+ (this._fadeAnimated ? ' leaflet-fade-anim' : ''));
var position = L.DomUtil.getStyle(container, 'position');
_initPanes: function () {
var panes = this._panes = {};
-
- this._mapPane = panes.mapPane = this._createPane('leaflet-map-pane', this._container);
-
- this._tilePane = panes.tilePane = this._createPane('leaflet-tile-pane', this._mapPane);
- panes.objectsPane = this._createPane('leaflet-objects-pane', this._mapPane);
- panes.shadowPane = this._createPane('leaflet-shadow-pane');
- panes.overlayPane = this._createPane('leaflet-overlay-pane');
- panes.markerPane = this._createPane('leaflet-marker-pane');
- panes.popupPane = this._createPane('leaflet-popup-pane');
-
- var zoomHide = ' leaflet-zoom-hide';
+ this._paneRenderers = {};
+
+ // @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, zoomHide);
- L.DomUtil.addClass(panes.shadowPane, zoomHide);
- L.DomUtil.addClass(panes.popupPane, zoomHide);
- }
- },
-
- _createPane: function (className, container) {
- return L.DomUtil.create('div', className, container || this._panes.objectsPane);
- },
-
- _clearPanes: function () {
- this._container.removeChild(this._mapPane);
- },
-
- _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]);
+ L.DomUtil.addClass(panes.markerPane, 'leaflet-zoom-hide');
+ L.DomUtil.addClass(panes.shadowPane, 'leaflet-zoom-hide');
}
},
// private methods that modify map state
- _resetView: function (center, zoom, preserveMapOffset, afterZoomAnim) {
+ // @section Map state change events
+ _resetView: function (center, zoom) {
+ L.DomUtil.setPosition(this._mapPane, new L.Point(0, 0));
- var zoomChanged = (this._zoom !== zoom);
+ var loading = !this._loaded;
+ this._loaded = true;
+ zoom = this._limitZoom(zoom);
- if (!afterZoomAnim) {
- this.fire('movestart');
+ this.fire('viewprereset');
- if (zoomChanged) {
- this.fire('zoomstart');
- }
+ 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');
}
+ },
- this._zoom = zoom;
- this._initialCenter = center;
-
- this._initialTopLeftPoint = this._getNewTopLeftPoint(center);
-
- if (!preserveMapOffset) {
- L.DomUtil.setPosition(this._mapPane, new L.Point(0, 0));
- } else {
- this._initialTopLeftPoint._add(this._getMapPanePos());
+ _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');
+ },
- this._tileLayersToLoad = this._tileLayersNum;
-
- var loading = !this._loaded;
- this._loaded = true;
+ _move: function (center, zoom, data) {
+ if (zoom === undefined) {
+ zoom = this._zoom;
+ }
+ var zoomChanged = this._zoom !== zoom;
- this.fire('viewreset', {hard: !preserveMapOffset});
+ this._zoom = zoom;
+ this._lastCenter = center;
+ this._pixelOrigin = this._getNewPixelOrigin(center);
- if (loading) {
- this.fire('load');
- this.eachLayer(this._layerAdd, this);
+ // @event zoom: Event
+ // Fired repeatedly 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);
}
- this.fire('move');
+ // @event move: Event
+ // Fired repeatedly during any movement of the map, including pan and
+ // fly animations.
+ return this.fire('move', data);
+ },
- if (zoomChanged || afterZoomAnim) {
+ _moveEnd: function (zoomChanged) {
+ // @event zoomend: Event
+ // Fired when the map has changed, after any animations.
+ if (zoomChanged) {
this.fire('zoomend');
}
- this.fire('moveend', {hard: !preserveMapOffset});
+ // @event moveend: Event
+ // Fired when the center of the map stops changing (e.g. user stopped
+ // dragging the map).
+ return this.fire('moveend');
+ },
+
+ _stop: function () {
+ L.Util.cancelAnimFrame(this._flyToFrame);
+ if (this._panAnim) {
+ this._panAnim.stop();
+ }
+ return this;
},
_rawPanBy: function (offset) {
return this.getMaxZoom() - this.getMinZoom();
},
- _updateZoomLevels: function () {
- var i,
- minZoom = Infinity,
- maxZoom = -Infinity,
- oldZoomSpan = this._getZoomSpan();
-
- for (i in this._zoomBoundLayers) {
- var layer = this._zoomBoundLayers[i];
- if (!isNaN(layer.options.minZoom)) {
- minZoom = Math.min(minZoom, layer.options.minZoom);
- }
- if (!isNaN(layer.options.maxZoom)) {
- maxZoom = Math.max(maxZoom, layer.options.maxZoom);
- }
- }
-
- if (i === undefined) { // we have no tilelayers
- this._layersMaxZoom = this._layersMinZoom = undefined;
- } else {
- this._layersMaxZoom = maxZoom;
- this._layersMinZoom = minZoom;
- }
-
- if (oldZoomSpan !== this._getZoomSpan()) {
- this.fire('zoomlevelschange');
- }
- },
-
_panInsideMaxBounds: function () {
- this.panInsideBounds(this.options.maxBounds);
+ if (!this._enforcingBounds) {
+ this.panInsideBounds(this.options.maxBounds);
+ }
},
_checkIfLoaded: function () {
}
},
- // map events
+ // DOM event handling
- _initEvents: function (onOff) {
+ // @section Interaction events
+ _initEvents: function (remove) {
if (!L.DomEvent) { return; }
- onOff = onOff || 'on';
-
- L.DomEvent[onOff](this._container, 'click', this._onMouseClick, this);
-
- var events = ['dblclick', 'mousedown', 'mouseup', 'mouseenter',
- 'mouseleave', 'mousemove', 'contextmenu'],
- i, len;
-
- for (i = 0, len = events.length; i < len; i++) {
- L.DomEvent[onOff](this._container, events[i], this._fireMouseEvent, this);
- }
+ this._targets = {};
+ this._targets[L.stamp(this._container)] = this;
+
+ var onOff = remove ? 'off' : 'on';
+
+ // @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: KeyboardEvent
+ // 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);
if (this.options.trackResize) {
L.DomEvent[onOff](window, 'resize', this._onResize, this);
}
+
+ 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, false, this._container);
+ function () { this.invalidateSize({debounceMoveend: true}); }, this);
+ },
+
+ _onScroll: function () {
+ this._container.scrollTop = 0;
+ this._container.scrollLeft = 0;
+ },
+
+ _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());
+ }
},
- _onMouseClick: function (e) {
- if (!this._loaded || (!e._simulated &&
- ((this.dragging && this.dragging.moved()) ||
- (this.boxZoom && this.boxZoom.moved()))) ||
- L.DomEvent._skipped(e)) { return; }
+ _findEventTargets: function (e, type) {
+ var targets = [],
+ target,
+ isHover = type === 'mouseout' || type === 'mouseover',
+ src = e.target || e.srcElement,
+ dragging = false;
- this.fire('preclick');
- this._fireMouseEvent(e);
+ 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;
},
- _fireMouseEvent: function (e) {
+ _handleDOMEvent: function (e) {
if (!this._loaded || L.DomEvent._skipped(e)) { return; }
- var type = e.type;
+ var type = e.type === 'keypress' && e.keyCode === 13 ? 'click' : e.type;
+
+ if (type === 'mousedown') {
+ // prevents outline when clicking on keyboard-focusable element
+ L.DomUtil.preventOutline(e.target || e.srcElement);
+ }
- type = (type === 'mouseenter' ? 'mouseover' : (type === 'mouseleave' ? 'mouseout' : type));
+ this._fireDOMEvent(e, type);
+ },
- if (!this.hasEventListeners(type)) { return; }
+ _fireDOMEvent: function (e, type, targets) {
- if (type === 'contextmenu') {
- L.DomEvent.preventDefault(e);
+ 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);
}
- var containerPoint = this.mouseEventToContainerPoint(e),
- layerPoint = this.containerPointToLayerPoint(containerPoint),
- latlng = this.layerPointToLatLng(layerPoint);
+ if (e._stopped) { return; }
- this.fire(type, {
- latlng: latlng,
- layerPoint: layerPoint,
- containerPoint: containerPoint,
+ // Find the layer the event is propagating from and its parents.
+ targets = (targets || []).concat(this._findEventTargets(e, type));
+
+ if (!targets.length) { return; }
+
+ var target = targets[0];
+ if (type === 'contextmenu' && target.listens(type, true)) {
+ L.DomEvent.preventDefault(e);
+ }
+
+ var data = {
originalEvent: e
- });
- },
+ };
+
+ 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);
+ }
- _onTileLayerLoad: function () {
- this._tileLayersToLoad--;
- if (this._tileLayersNum && !this._tileLayersToLoad) {
- this.fire('tilelayersload');
+ 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; }
}
},
+ _draggableMoved: function (obj) {
+ obj = obj.dragging && obj.dragging.enabled() ? obj : this;
+ return (obj.dragging && obj.dragging.moved()) || (this.boxZoom && this.boxZoom.moved());
+ },
+
_clearHandlers: function () {
for (var i = 0, len = this._handlers.length; i < len; i++) {
this._handlers[i].disable();
}
},
+ // @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, this);
+ callback.call(context || this, {target: this});
} else {
this.on('load', callback, context);
}
return this;
},
- _layerAdd: function (layer) {
- layer.onAdd(this);
- this.fire('layeradd', {layer: layer});
- },
-
// private methods for getting map state
_getMapPanePos: function () {
- return L.DomUtil.getPosition(this._mapPane);
+ return L.DomUtil.getPosition(this._mapPane) || new L.Point(0, 0);
},
_moved: function () {
return pos && !pos.equals([0, 0]);
},
- _getTopLeftPoint: function () {
- return this.getPixelOrigin().subtract(this._getMapPanePos());
+ _getTopLeftPoint: function (center, zoom) {
+ var pixelOrigin = center && zoom !== undefined ?
+ this._getNewPixelOrigin(center, zoom) :
+ this.getPixelOrigin();
+ return pixelOrigin.subtract(this._getMapPanePos());
},
- _getNewTopLeftPoint: function (center, zoom) {
+ _getNewPixelOrigin: function (center, zoom) {
var viewHalf = this.getSize()._divideBy(2);
- // TODO round on display, not calculation to increase precision?
- return this.project(center, zoom)._subtract(viewHalf)._round();
+ return this.project(center, zoom)._subtract(viewHalf)._add(this._getMapPanePos())._round();
},
- _latLngToNewLayerPoint: function (latlng, newZoom, newCenter) {
- var topLeft = this._getNewTopLeftPoint(newCenter, newZoom).add(this._getMapPanePos());
- return this.project(latlng, newZoom)._subtract(topLeft);
+ _latLngToNewLayerPoint: function (latlng, zoom, center) {
+ var topLeft = this._getNewPixelOrigin(center, zoom);
+ return this.project(latlng, zoom)._subtract(topLeft);
},
// layer point of the current center
viewBounds = new L.Bounds(centerPoint.subtract(viewHalf), centerPoint.add(viewHalf)),
offset = this._getBoundsOffset(viewBounds, bounds, zoom);
+ // 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;
+ }
+
return this.unproject(centerPoint.add(offset), zoom);
},
// returns offset needed for pxBounds to get inside maxBounds at a specified zoom
_getBoundsOffset: function (pxBounds, maxBounds, zoom) {
- var nwOffset = this.project(maxBounds.getNorthWest(), zoom).subtract(pxBounds.min),
- seOffset = this.project(maxBounds.getSouthEast(), zoom).subtract(pxBounds.max),
+ 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(nwOffset.x, -seOffset.x),
- dy = this._rebound(nwOffset.y, -seOffset.y);
+ dx = this._rebound(minOffset.x, -maxOffset.x),
+ dy = this._rebound(minOffset.y, -maxOffset.y);
return new L.Point(dx, dy);
},
_limitZoom: function (zoom) {
var min = this.getMinZoom(),
- max = this.getMaxZoom();
-
+ 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));
}
});
+// @section
+
+// @factory L.map(id: String, options?: Map options)
+// Instantiates a map object given the DOM ID of a `<div>` 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 `<div>` HTML element
+// and optionally an object literal with `Map options`.
L.map = function (id, options) {
return new L.Map(id, options);
};
-/*
- * Mercator projection that takes into account that the Earth is not a perfect sphere.
- * Less popular than spherical mercator; used by projections like EPSG:3395.
- */
-
-L.Projection.Mercator = {
- MAX_LATITUDE: 85.0840591556,
-
- R_MINOR: 6356752.314245179,
- R_MAJOR: 6378137,
-
- project: function (latlng) { // (LatLng) -> Point
- var d = L.LatLng.DEG_TO_RAD,
- max = this.MAX_LATITUDE,
- lat = Math.max(Math.min(max, latlng.lat), -max),
- r = this.R_MAJOR,
- r2 = this.R_MINOR,
- x = latlng.lng * d * r,
- y = lat * d,
- tmp = r2 / r,
- eccent = Math.sqrt(1.0 - tmp * tmp),
- con = eccent * Math.sin(y);
-
- con = Math.pow((1 - con) / (1 + con), eccent * 0.5);
-
- var ts = Math.tan(0.5 * ((Math.PI * 0.5) - y)) / con;
- y = -r * Math.log(ts);
-
- return new L.Point(x, y);
- },
-
- unproject: function (point) { // (Point, Boolean) -> LatLng
- var d = L.LatLng.RAD_TO_DEG,
- r = this.R_MAJOR,
- r2 = this.R_MINOR,
- lng = point.x * d / r,
- tmp = r2 / r,
- eccent = Math.sqrt(1 - (tmp * tmp)),
- ts = Math.exp(- point.y / r),
- phi = (Math.PI / 2) - 2 * Math.atan(ts),
- numIter = 15,
- tol = 1e-7,
- i = numIter,
- dphi = 0.1,
- con;
-
- while ((Math.abs(dphi) > tol) && (--i > 0)) {
- con = eccent * Math.sin(phi);
- dphi = (Math.PI / 2) - 2 * Math.atan(ts *
- Math.pow((1.0 - con) / (1.0 + con), 0.5 * eccent)) - phi;
- phi += dphi;
- }
-
- return new L.LatLng(phi * d, lng);
- }
-};
-
-L.CRS.EPSG3395 = L.extend({}, L.CRS, {
- code: 'EPSG:3395',
+/*
+ * @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`.
+ *
+ * @example
+ *
+ * ```js
+ * var layer = L.Marker(latlng).addTo(map);
+ * layer.addTo(map);
+ * layer.remove();
+ * ```
+ *
+ * @event add: Event
+ * Fired after the layer is added to a map
+ *
+ * @event remove: Event
+ * Fired after the layer is removed from a map
+ */
- projection: L.Projection.Mercator,
- transformation: (function () {
- var m = L.Projection.Mercator,
- r = m.R_MAJOR,
- scale = 0.5 / (Math.PI * r);
+L.Layer = L.Evented.extend({
- return new L.Transformation(scale, 0.5, -scale, 0.5);
- }())
-});
+ // Classes extending `L.Layer` will inherit the following 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)
+ },
+
+ /* @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;
+ },
+ // @method remove: this
+ // Removes the layer from the map it is currently active on.
+ remove: function () {
+ return this.removeFrom(this._map || this._mapToAdd);
+ },
-/*
- * L.TileLayer is used for standard xyz-numbered tile layers.
- */
+ // @method removeFrom(map: Map): this
+ // Removes the layer from the given map
+ removeFrom: function (obj) {
+ if (obj) {
+ obj.removeLayer(this);
+ }
+ return this;
+ },
-L.TileLayer = L.Class.extend({
- includes: L.Mixin.Events,
+ // @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);
+ },
- options: {
- minZoom: 0,
- maxZoom: 18,
- tileSize: 256,
- subdomains: 'abc',
- errorTileUrl: '',
- attribution: '',
- zoomOffset: 0,
- opacity: 1,
- /*
- maxNativeZoom: null,
- zIndex: null,
- tms: false,
- continuousWorld: false,
- noWrap: false,
- zoomReverse: false,
- detectRetina: false,
- reuseTiles: false,
- bounds: false,
- */
- unloadInvisibleTiles: L.Browser.mobile,
- updateWhenIdle: L.Browser.mobile
+ addInteractiveTarget: function (targetEl) {
+ this._map._targets[L.stamp(targetEl)] = this;
+ return this;
},
- initialize: function (url, options) {
- options = L.setOptions(this, options);
+ removeInteractiveTarget: function (targetEl) {
+ delete this._map._targets[L.stamp(targetEl)];
+ return this;
+ },
- // detecting retina displays, adjusting tileSize and zoom levels
- if (options.detectRetina && L.Browser.retina && options.maxZoom > 0) {
+ _layerAdd: function (e) {
+ var map = e.target;
- options.tileSize = Math.floor(options.tileSize / 2);
- options.zoomOffset++;
+ // check in case layer gets added and then removed before the map is ready
+ if (!map.hasLayer(this)) { return; }
- if (options.minZoom > 0) {
- options.minZoom--;
- }
- this.options.maxZoom--;
- }
+ this._map = map;
+ this._zoomAnimated = map._zoomAnimated;
- if (options.bounds) {
- options.bounds = L.latLngBounds(options.bounds);
+ if (this.getEvents) {
+ var events = this.getEvents();
+ map.on(events, this);
+ this.once('remove', function () {
+ map.off(events, this);
+ }, this);
}
- this._url = url;
-
- var subdomains = this.options.subdomains;
+ this.onAdd(map);
- if (typeof subdomains === 'string') {
- this.options.subdomains = subdomains.split('');
+ if (this.getAttribution && this._map.attributionControl) {
+ this._map.attributionControl.addAttribution(this.getAttribution());
}
- },
- onAdd: function (map) {
- this._map = map;
- this._animated = map._zoomAnimated;
+ this.fire('add');
+ map.fire('layeradd', {layer: this});
+ }
+});
- // create a container div for tiles
- this._initContainer();
+/* @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.
+ */
- // set up events
- map.on({
- 'viewreset': this._reset,
- 'moveend': this._update
- }, this);
- if (this._animated) {
- map.on({
- 'zoomanim': this._animateZoom,
- 'zoomend': this._endZoomAnim
- }, this);
- }
+/* @namespace Map
+ * @section Layer events
+ *
+ * @event layeradd: LayerEvent
+ * Fired when a new layer is added to the map.
+ *
+ * @event layerremove: LayerEvent
+ * Fired when some layer is removed from the map
+ *
+ * @section Methods for Layers and Controls
+ */
+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;
- if (!this.options.updateWhenIdle) {
- this._limitedUpdate = L.Util.limitExecByInterval(this._update, 150, this);
- map.on('move', this._limitedUpdate, this);
+ layer._mapToAdd = this;
+
+ if (layer.beforeAdd) {
+ layer.beforeAdd(this);
}
- this._reset();
- this._update();
- },
+ this.whenReady(layer._layerAdd, layer);
- addTo: function (map) {
- map.addLayer(this);
return this;
},
- onRemove: function (map) {
- this._container.parentNode.removeChild(this._container);
+ // @method removeLayer(layer: Layer): this
+ // Removes the given layer from the map.
+ removeLayer: function (layer) {
+ var id = L.stamp(layer);
- map.off({
- 'viewreset': this._reset,
- 'moveend': this._update
- }, this);
+ if (!this._layers[id]) { return this; }
- if (this._animated) {
- map.off({
- 'zoomanim': this._animateZoom,
- 'zoomend': this._endZoomAnim
- }, this);
+ if (this._loaded) {
+ layer.onRemove(this);
}
- if (!this.options.updateWhenIdle) {
- map.off('move', this._limitedUpdate, this);
+ if (layer.getAttribution && this.attributionControl) {
+ this.attributionControl.removeAttribution(layer.getAttribution());
}
- this._container = null;
- this._map = null;
- },
-
- bringToFront: function () {
- var pane = this._map._panes.tilePane;
+ delete this._layers[id];
- if (this._container) {
- pane.appendChild(this._container);
- this._setAutoZIndex(pane, Math.max);
+ if (this._loaded) {
+ this.fire('layerremove', {layer: layer});
+ layer.fire('remove');
}
+ layer._map = layer._mapToAdd = null;
+
return this;
},
- bringToBack: function () {
- var pane = this._map._panes.tilePane;
+ // @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);
+ },
- if (this._container) {
- pane.insertBefore(this._container, pane.firstChild);
- this._setAutoZIndex(pane, Math.min);
+ /* @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;
},
- getAttribution: function () {
- return this.options.attribution;
- },
+ _addLayers: function (layers) {
+ layers = layers ? (L.Util.isArray(layers) ? layers : [layers]) : [];
- getContainer: function () {
- return this._container;
+ for (var i = 0, len = layers.length; i < len; i++) {
+ this.addLayer(layers[i]);
+ }
},
- setOpacity: function (opacity) {
- this.options.opacity = opacity;
-
- if (this._map) {
- this._updateOpacity();
+ _addZoomLimit: function (layer) {
+ if (isNaN(layer.options.maxZoom) || !isNaN(layer.options.minZoom)) {
+ this._zoomBoundLayers[L.stamp(layer)] = layer;
+ this._updateZoomLevels();
}
-
- return this;
},
- setZIndex: function (zIndex) {
- this.options.zIndex = zIndex;
- this._updateZIndex();
+ _removeZoomLimit: function (layer) {
+ var id = L.stamp(layer);
- return this;
+ if (this._zoomBoundLayers[id]) {
+ delete this._zoomBoundLayers[id];
+ this._updateZoomLevels();
+ }
},
- setUrl: function (url, noRedraw) {
- this._url = url;
+ _updateZoomLevels: function () {
+ var minZoom = Infinity,
+ maxZoom = -Infinity,
+ oldZoomSpan = this._getZoomSpan();
- if (!noRedraw) {
- this.redraw();
+ 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);
}
- return this;
- },
+ this._layersMaxZoom = maxZoom === -Infinity ? undefined : maxZoom;
+ this._layersMinZoom = minZoom === Infinity ? undefined : minZoom;
- redraw: function () {
- if (this._map) {
- this._reset({hard: true});
- this._update();
+ // @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');
}
- return this;
- },
+ }
+});
+
- _updateZIndex: function () {
- if (this._container && this.options.zIndex !== undefined) {
- this._container.style.zIndex = this.options.zIndex;
- }
- },
- _setAutoZIndex: function (pane, compare) {
+/*
+ * @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.
+ */
- var layers = pane.children,
- edgeZIndex = -compare(Infinity, -Infinity), // -Infinity for max, Infinity for min
- zIndex, i, len;
+L.Projection.Mercator = {
+ R: 6378137,
+ R_MINOR: 6356752.314245179,
- for (i = 0, len = layers.length; i < len; i++) {
+ bounds: L.bounds([-20037508.34279, -15496570.73972], [20037508.34279, 18764656.23138]),
- if (layers[i] !== this._container) {
- zIndex = parseInt(layers[i].style.zIndex, 10);
+ 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);
- if (!isNaN(zIndex)) {
- edgeZIndex = compare(edgeZIndex, zIndex);
- }
- }
- }
+ 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));
- this.options.zIndex = this._container.style.zIndex =
- (isFinite(edgeZIndex) ? edgeZIndex : 0) + compare(1, -1);
+ return new L.Point(latlng.lng * d * r, y);
},
- _updateOpacity: function () {
- var i,
- tiles = this._tiles;
-
- if (L.Browser.ielt9) {
- for (i in tiles) {
- L.DomUtil.setOpacity(tiles[i], this.options.opacity);
- }
- } else {
- L.DomUtil.setOpacity(this._container, this.options.opacity);
+ 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;
}
- },
- _initContainer: function () {
- var tilePane = this._map._panes.tilePane;
+ return new L.LatLng(phi * d, point.x * d / r);
+ }
+};
- if (!this._container) {
- this._container = L.DomUtil.create('div', 'leaflet-layer');
- this._updateZIndex();
- if (this._animated) {
- var className = 'leaflet-tile-container';
+/*
+ * @namespace CRS
+ * @crs L.CRS.EPSG3395
+ *
+ * Rarely used by some commercial tile providers. Uses Elliptical Mercator projection.
+ */
- this._bgBuffer = L.DomUtil.create('div', className, this._container);
- this._tileContainer = L.DomUtil.create('div', className, this._container);
+L.CRS.EPSG3395 = L.extend({}, L.CRS.Earth, {
+ code: 'EPSG:3395',
+ projection: L.Projection.Mercator,
- } else {
- this._tileContainer = this._container;
- }
+ transformation: (function () {
+ var scale = 0.5 / (Math.PI * L.Projection.Mercator.R);
+ return new L.Transformation(scale, 0.5, -scale, 0.5);
+ }())
+});
- tilePane.appendChild(this._container);
- if (this.options.opacity < 1) {
- this._updateOpacity();
- }
- }
- },
- _reset: function (e) {
- for (var key in this._tiles) {
- this.fire('tileunload', {tile: this._tiles[key]});
- }
+/*
+ * @class GridLayer
+ * @inherits Layer
+ * @aka L.GridLayer
+ *
+ * Generic class for handling a tiled grid of HTML elements. This is the base class for all tile layers and replaces `TileLayer.Canvas`.
+ * GridLayer can be extended to create a tiled grid of HTML elements like `<canvas>`, `<img>` or `<div>`. GridLayer will handle creating and animating these DOM elements for you.
+ *
+ *
+ * @section Synchronous usage
+ * @example
+ *
+ * To create a custom layer, extend GridLayer and implement the `createTile()` method, which will be passed a `Point` object with the `x`, `y`, and `z` (zoom level) coordinates to draw your tile.
+ *
+ * ```js
+ * var CanvasLayer = L.GridLayer.extend({
+ * createTile: function(coords){
+ * // create a <canvas> element for drawing
+ * var tile = L.DomUtil.create('canvas', 'leaflet-tile');
+ *
+ * // setup tile width and height according to the options
+ * var size = this.getTileSize();
+ * tile.width = size.x;
+ * tile.height = size.y;
+ *
+ * // get a canvas context and draw something on it using coords.x, coords.y and coords.z
+ * var ctx = tile.getContext('2d');
+ *
+ * // return the tile so it can be rendered on screen
+ * return tile;
+ * }
+ * });
+ * ```
+ *
+ * @section Asynchronous usage
+ * @example
+ *
+ * Tile creation can also be asynchronous, this is useful when using a third-party drawing library. Once the tile is finished drawing it can be passed to the `done()` callback.
+ *
+ * ```js
+ * var CanvasLayer = L.GridLayer.extend({
+ * createTile: function(coords, done){
+ * var error;
+ *
+ * // create a <canvas> element for drawing
+ * var tile = L.DomUtil.create('canvas', 'leaflet-tile');
+ *
+ * // setup tile width and height according to the options
+ * var size = this.getTileSize();
+ * tile.width = size.x;
+ * tile.height = size.y;
+ *
+ * // draw something asynchronously and pass the tile to the done() callback
+ * setTimeout(function() {
+ * done(error, tile);
+ * }, 1000);
+ *
+ * return tile;
+ * }
+ * });
+ * ```
+ *
+ * @section
+ */
- this._tiles = {};
- this._tilesToLoad = 0;
- if (this.options.reuseTiles) {
- this._unusedTiles = [];
- }
+L.GridLayer = L.Layer.extend({
- this._tileContainer.innerHTML = '';
+ // @section
+ // @aka GridLayer options
+ options: {
+ // @option tileSize: Number|Point = 256
+ // Width and height of tiles in the grid. Use a number if width and height are equal, or `L.point(width, height)` otherwise.
+ tileSize: 256,
- if (this._animated && e && e.hard) {
- this._clearBgBuffer();
- }
+ // @option opacity: Number = 1.0
+ // Opacity of the tiles. Can be used in the `createTile()` function.
+ opacity: 1,
- this._initContainer();
- },
+ // @option updateWhenIdle: Boolean = depends
+ // If `false`, new tiles are loaded during panning, otherwise only after it (for better performance). `true` by default on mobile browsers, otherwise `false`.
+ updateWhenIdle: L.Browser.mobile,
- _getTileSize: function () {
- var map = this._map,
- zoom = map.getZoom() + this.options.zoomOffset,
- zoomN = this.options.maxNativeZoom,
- tileSize = this.options.tileSize;
+ // @option updateWhenZooming: Boolean = true
+ // By default, a smooth zoom animation (during a [touch zoom](#map-touchzoom) or a [`flyTo()`](#map-flyto)) will update grid layers every integer zoom level. Setting this option to `false` will update the grid layer only when the smooth animation ends.
+ updateWhenZooming: true,
- if (zoomN && zoom > zoomN) {
- tileSize = Math.round(map.getZoomScale(zoom) / map.getZoomScale(zoomN) * tileSize);
- }
+ // @option updateInterval: Number = 200
+ // Tiles will not update more than once every `updateInterval` milliseconds when panning.
+ updateInterval: 200,
- return tileSize;
- },
+ // @option attribution: String = null
+ // String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ attribution: null,
- _update: function () {
+ // @option zIndex: Number = 1
+ // The explicit zIndex of the tile layer.
+ zIndex: 1,
- if (!this._map) { return; }
+ // @option bounds: LatLngBounds = undefined
+ // If set, tiles will only be loaded inside the set `LatLngBounds`.
+ bounds: null,
- var map = this._map,
- bounds = map.getPixelBounds(),
- zoom = map.getZoom(),
- tileSize = this._getTileSize();
+ // @option minZoom: Number = 0
+ // The minimum zoom level that tiles will be loaded at. By default the entire map.
+ minZoom: 0,
- if (zoom > this.options.maxZoom || zoom < this.options.minZoom) {
- return;
- }
+ // @option maxZoom: Number = undefined
+ // The maximum zoom level that tiles will be loaded at.
+ maxZoom: undefined,
- var tileBounds = L.bounds(
- bounds.min.divideBy(tileSize)._floor(),
- bounds.max.divideBy(tileSize)._floor());
+ // @option noWrap: Boolean = false
+ // Whether the layer is wrapped around the antimeridian. If `true`, the
+ // GridLayer will only be displayed once at low zoom levels. Has no
+ // effect when the [map CRS](#map-crs) doesn't wrap around.
+ noWrap: false,
- this._addTilesFromCenterOut(tileBounds);
+ // @option pane: String = 'tilePane'
+ // `Map pane` where the grid layer will be added.
+ pane: 'tilePane',
- if (this.options.unloadInvisibleTiles || this.options.reuseTiles) {
- this._removeOtherTiles(tileBounds);
- }
- },
+ // @option className: String = ''
+ // A custom class name to assign to the tile layer. Empty by default.
+ className: '',
- _addTilesFromCenterOut: function (bounds) {
- var queue = [],
- center = bounds.getCenter();
+ // @option keepBuffer: Number = 2
+ // When panning the map, keep this many rows and columns of tiles before unloading them.
+ keepBuffer: 2
+ },
- var j, i, point;
+ initialize: function (options) {
+ L.setOptions(this, options);
+ },
- for (j = bounds.min.y; j <= bounds.max.y; j++) {
- for (i = bounds.min.x; i <= bounds.max.x; i++) {
- point = new L.Point(i, j);
+ onAdd: function () {
+ this._initContainer();
- if (this._tileShouldBeLoaded(point)) {
- queue.push(point);
- }
- }
- }
+ this._levels = {};
+ this._tiles = {};
- var tilesToLoad = queue.length;
+ this._resetView();
+ this._update();
+ },
- if (tilesToLoad === 0) { return; }
+ beforeAdd: function (map) {
+ map._addZoomLimit(this);
+ },
- // load tiles in order of their distance to center
- queue.sort(function (a, b) {
- return a.distanceTo(center) - b.distanceTo(center);
- });
+ onRemove: function (map) {
+ this._removeAllTiles();
+ L.DomUtil.remove(this._container);
+ map._removeZoomLimit(this);
+ this._container = null;
+ this._tileZoom = null;
+ },
- var fragment = document.createDocumentFragment();
+ // @method bringToFront: this
+ // Brings the tile layer to the top of all tile layers.
+ bringToFront: function () {
+ if (this._map) {
+ L.DomUtil.toFront(this._container);
+ this._setAutoZIndex(Math.max);
+ }
+ return this;
+ },
- // if its the first batch of tiles to load
- if (!this._tilesToLoad) {
- this.fire('loading');
+ // @method bringToBack: this
+ // Brings the tile layer to the bottom of all tile layers.
+ bringToBack: function () {
+ if (this._map) {
+ L.DomUtil.toBack(this._container);
+ this._setAutoZIndex(Math.min);
}
+ return this;
+ },
- this._tilesToLoad += tilesToLoad;
+ // @method getAttribution: String
+ // Used by the `attribution control`, returns the [attribution option](#gridlayer-attribution).
+ getAttribution: function () {
+ return this.options.attribution;
+ },
- for (i = 0; i < tilesToLoad; i++) {
- this._addTile(queue[i], fragment);
- }
+ // @method getContainer: HTMLElement
+ // Returns the HTML element that contains the tiles for this layer.
+ getContainer: function () {
+ return this._container;
+ },
- this._tileContainer.appendChild(fragment);
+ // @method setOpacity(opacity: Number): this
+ // Changes the [opacity](#gridlayer-opacity) of the grid layer.
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
+ this._updateOpacity();
+ return this;
},
- _tileShouldBeLoaded: function (tilePoint) {
- if ((tilePoint.x + ':' + tilePoint.y) in this._tiles) {
- return false; // already loaded
- }
+ // @method setZIndex(zIndex: Number): this
+ // Changes the [zIndex](#gridlayer-zindex) of the grid layer.
+ setZIndex: function (zIndex) {
+ this.options.zIndex = zIndex;
+ this._updateZIndex();
- var options = this.options;
+ return this;
+ },
- if (!options.continuousWorld) {
- var limit = this._getWrapTileNum();
+ // @method isLoading: Boolean
+ // Returns `true` if any tile in the grid layer has not finished loading.
+ isLoading: function () {
+ return this._loading;
+ },
- // don't load if exceeds world bounds
- if ((options.noWrap && (tilePoint.x < 0 || tilePoint.x >= limit.x)) ||
- tilePoint.y < 0 || tilePoint.y >= limit.y) { return false; }
+ // @method redraw: this
+ // Causes the layer to clear all the tiles and request them again.
+ redraw: function () {
+ if (this._map) {
+ this._removeAllTiles();
+ this._update();
}
+ return this;
+ },
- if (options.bounds) {
- var tileSize = this._getTileSize(),
- nwPoint = tilePoint.multiplyBy(tileSize),
- sePoint = nwPoint.add([tileSize, tileSize]),
- nw = this._map.unproject(nwPoint),
- se = this._map.unproject(sePoint);
+ getEvents: function () {
+ var events = {
+ viewprereset: this._invalidateAll,
+ viewreset: this._resetView,
+ zoom: this._resetView,
+ moveend: this._onMoveEnd
+ };
- // TODO temporary hack, will be removed after refactoring projections
- // https://github.com/Leaflet/Leaflet/issues/1618
- if (!options.continuousWorld && !options.noWrap) {
- nw = nw.wrap();
- se = se.wrap();
+ if (!this.options.updateWhenIdle) {
+ // update tiles on move, but not more often than once per given interval
+ if (!this._onMove) {
+ this._onMove = L.Util.throttle(this._onMoveEnd, this.options.updateInterval, this);
}
- if (!options.bounds.intersects([nw, se])) { return false; }
+ events.move = this._onMove;
}
- return true;
+ if (this._zoomAnimated) {
+ events.zoomanim = this._animateZoom;
+ }
+
+ return events;
},
- _removeOtherTiles: function (bounds) {
- var kArr, x, y, key;
+ // @section Extension methods
+ // Layers extending `GridLayer` shall reimplement the following method.
+ // @method createTile(coords: Object, done?: Function): HTMLElement
+ // Called only internally, must be overriden by classes extending `GridLayer`.
+ // Returns the `HTMLElement` corresponding to the given `coords`. If the `done` callback
+ // is specified, it must be called when the tile has finished loading and drawing.
+ createTile: function () {
+ return document.createElement('div');
+ },
- for (key in this._tiles) {
- kArr = key.split(':');
- x = parseInt(kArr[0], 10);
- y = parseInt(kArr[1], 10);
+ // @section
+ // @method getTileSize: Point
+ // Normalizes the [tileSize option](#gridlayer-tilesize) into a point. Used by the `createTile()` method.
+ getTileSize: function () {
+ var s = this.options.tileSize;
+ return s instanceof L.Point ? s : new L.Point(s, s);
+ },
- // remove tile if it's out of bounds
- if (x < bounds.min.x || x > bounds.max.x || y < bounds.min.y || y > bounds.max.y) {
- this._removeTile(key);
- }
+ _updateZIndex: function () {
+ if (this._container && this.options.zIndex !== undefined && this.options.zIndex !== null) {
+ this._container.style.zIndex = this.options.zIndex;
}
},
- _removeTile: function (key) {
- var tile = this._tiles[key];
+ _setAutoZIndex: function (compare) {
+ // go through all other layers of the same pane, set zIndex to max + 1 (front) or min - 1 (back)
- this.fire('tileunload', {tile: tile, url: tile.src});
+ var layers = this.getPane().children,
+ edgeZIndex = -compare(-Infinity, Infinity); // -Infinity for max, Infinity for min
- if (this.options.reuseTiles) {
- L.DomUtil.removeClass(tile, 'leaflet-tile-loaded');
- this._unusedTiles.push(tile);
+ for (var i = 0, len = layers.length, zIndex; i < len; i++) {
- } else if (tile.parentNode === this._tileContainer) {
- this._tileContainer.removeChild(tile);
- }
+ zIndex = layers[i].style.zIndex;
- // for https://github.com/CloudMade/Leaflet/issues/137
- if (!L.Browser.android) {
- tile.onload = null;
- tile.src = L.Util.emptyImageUrl;
+ if (layers[i] !== this._container && zIndex) {
+ edgeZIndex = compare(edgeZIndex, +zIndex);
+ }
}
- delete this._tiles[key];
+ if (isFinite(edgeZIndex)) {
+ this.options.zIndex = edgeZIndex + compare(-1, 1);
+ this._updateZIndex();
+ }
},
- _addTile: function (tilePoint, container) {
- var tilePos = this._getTilePos(tilePoint);
+ _updateOpacity: function () {
+ if (!this._map) { return; }
+
+ // IE doesn't inherit filter opacity properly, so we're forced to set it on tiles
+ if (L.Browser.ielt9) { return; }
- // get unused tile - or create a new tile
- var tile = this._getTile();
+ L.DomUtil.setOpacity(this._container, this.options.opacity);
- /*
- Chrome 20 layouts much faster with top/left (verify with timeline, frames)
- Android 4 browser has display issues with top/left and requires transform instead
- (other browsers don't currently care) - see debug/hacks/jitter.html for an example
- */
- L.DomUtil.setPosition(tile, tilePos, L.Browser.chrome);
+ var now = +new Date(),
+ nextFrame = false,
+ willPrune = false;
+
+ for (var key in this._tiles) {
+ var tile = this._tiles[key];
+ if (!tile.current || !tile.loaded) { continue; }
+
+ var fade = Math.min(1, (now - tile.loaded) / 200);
- this._tiles[tilePoint.x + ':' + tilePoint.y] = tile;
+ L.DomUtil.setOpacity(tile.el, fade);
+ if (fade < 1) {
+ nextFrame = true;
+ } else {
+ if (tile.active) { willPrune = true; }
+ tile.active = true;
+ }
+ }
- this._loadTile(tile, tilePoint);
+ if (willPrune && !this._noPrune) { this._pruneTiles(); }
- if (tile.parentNode !== this._tileContainer) {
- container.appendChild(tile);
+ if (nextFrame) {
+ L.Util.cancelAnimFrame(this._fadeFrame);
+ this._fadeFrame = L.Util.requestAnimFrame(this._updateOpacity, this);
}
},
- _getZoomForUrl: function () {
+ _initContainer: function () {
+ if (this._container) { return; }
- var options = this.options,
- zoom = this._map.getZoom();
+ this._container = L.DomUtil.create('div', 'leaflet-layer ' + (this.options.className || ''));
+ this._updateZIndex();
- if (options.zoomReverse) {
- zoom = options.maxZoom - zoom;
+ if (this.options.opacity < 1) {
+ this._updateOpacity();
}
- zoom += options.zoomOffset;
-
- return options.maxNativeZoom ? Math.min(zoom, options.maxNativeZoom) : zoom;
+ this.getPane().appendChild(this._container);
},
- _getTilePos: function (tilePoint) {
- var origin = this._map.getPixelOrigin(),
- tileSize = this._getTileSize();
+ _updateLevels: function () {
- return tilePoint.multiplyBy(tileSize).subtract(origin);
- },
+ var zoom = this._tileZoom,
+ maxZoom = this.options.maxZoom;
- // image-specific code (override to implement e.g. Canvas or SVG tile layer)
+ if (zoom === undefined) { return undefined; }
- getTileUrl: function (tilePoint) {
- return L.Util.template(this._url, L.extend({
- s: this._getSubdomain(tilePoint),
- z: tilePoint.z,
- x: tilePoint.x,
- y: tilePoint.y
- }, this.options));
- },
+ for (var z in this._levels) {
+ if (this._levels[z].el.children.length || z === zoom) {
+ this._levels[z].el.style.zIndex = maxZoom - Math.abs(zoom - z);
+ } else {
+ L.DomUtil.remove(this._levels[z].el);
+ this._removeTilesAtZoom(z);
+ delete this._levels[z];
+ }
+ }
- _getWrapTileNum: function () {
- var crs = this._map.options.crs,
- size = crs.getSize(this._map.getZoom());
- return size.divideBy(this._getTileSize())._floor();
+ var level = this._levels[zoom],
+ map = this._map;
+
+ if (!level) {
+ level = this._levels[zoom] = {};
+
+ level.el = L.DomUtil.create('div', 'leaflet-tile-container leaflet-zoom-animated', this._container);
+ level.el.style.zIndex = maxZoom;
+
+ level.origin = map.project(map.unproject(map.getPixelOrigin()), zoom).round();
+ level.zoom = zoom;
+
+ this._setZoomTransform(level, map.getCenter(), map.getZoom());
+
+ // force the browser to consider the newly added element for transition
+ L.Util.falseFn(level.el.offsetWidth);
+ }
+
+ this._level = level;
+
+ return level;
},
- _adjustTilePoint: function (tilePoint) {
+ _pruneTiles: function () {
+ if (!this._map) {
+ return;
+ }
+
+ var key, tile;
- var limit = this._getWrapTileNum();
+ var zoom = this._map.getZoom();
+ if (zoom > this.options.maxZoom ||
+ zoom < this.options.minZoom) {
+ this._removeAllTiles();
+ return;
+ }
- // wrap tile coordinates
- if (!this.options.continuousWorld && !this.options.noWrap) {
- tilePoint.x = ((tilePoint.x % limit.x) + limit.x) % limit.x;
+ for (key in this._tiles) {
+ tile = this._tiles[key];
+ tile.retain = tile.current;
}
- if (this.options.tms) {
- tilePoint.y = limit.y - tilePoint.y - 1;
+ for (key in this._tiles) {
+ tile = this._tiles[key];
+ if (tile.current && !tile.active) {
+ var coords = tile.coords;
+ if (!this._retainParent(coords.x, coords.y, coords.z, coords.z - 5)) {
+ this._retainChildren(coords.x, coords.y, coords.z, coords.z + 2);
+ }
+ }
}
- tilePoint.z = this._getZoomForUrl();
+ for (key in this._tiles) {
+ if (!this._tiles[key].retain) {
+ this._removeTile(key);
+ }
+ }
},
- _getSubdomain: function (tilePoint) {
- var index = Math.abs(tilePoint.x + tilePoint.y) % this.options.subdomains.length;
- return this.options.subdomains[index];
+ _removeTilesAtZoom: function (zoom) {
+ for (var key in this._tiles) {
+ if (this._tiles[key].coords.z !== zoom) {
+ continue;
+ }
+ this._removeTile(key);
+ }
+ },
+
+ _removeAllTiles: function () {
+ for (var key in this._tiles) {
+ this._removeTile(key);
+ }
},
- _getTile: function () {
- if (this.options.reuseTiles && this._unusedTiles.length > 0) {
- var tile = this._unusedTiles.pop();
- this._resetTile(tile);
- return tile;
+ _invalidateAll: function () {
+ for (var z in this._levels) {
+ L.DomUtil.remove(this._levels[z].el);
+ delete this._levels[z];
}
- return this._createTile();
+ this._removeAllTiles();
+
+ this._tileZoom = null;
},
- // Override if data stored on a tile needs to be cleaned up before reuse
- _resetTile: function (/*tile*/) {},
+ _retainParent: function (x, y, z, minZoom) {
+ var x2 = Math.floor(x / 2),
+ y2 = Math.floor(y / 2),
+ z2 = z - 1,
+ coords2 = new L.Point(+x2, +y2);
+ coords2.z = +z2;
- _createTile: function () {
- var tile = L.DomUtil.create('img', 'leaflet-tile');
- tile.style.width = tile.style.height = this._getTileSize() + 'px';
- tile.galleryimg = 'no';
+ var key = this._tileCoordsToKey(coords2),
+ tile = this._tiles[key];
- tile.onselectstart = tile.onmousemove = L.Util.falseFn;
+ if (tile && tile.active) {
+ tile.retain = true;
+ return true;
- if (L.Browser.ielt9 && this.options.opacity !== undefined) {
- L.DomUtil.setOpacity(tile, this.options.opacity);
+ } else if (tile && tile.loaded) {
+ tile.retain = true;
}
- // without this hack, tiles disappear after zoom on Chrome for Android
- // https://github.com/Leaflet/Leaflet/issues/2078
- if (L.Browser.mobileWebkit3d) {
- tile.style.WebkitBackfaceVisibility = 'hidden';
+
+ if (z2 > minZoom) {
+ return this._retainParent(x2, y2, z2, minZoom);
}
- return tile;
+
+ return false;
},
- _loadTile: function (tile, tilePoint) {
- tile._layer = this;
- tile.onload = this._tileOnLoad;
- tile.onerror = this._tileOnError;
+ _retainChildren: function (x, y, z, maxZoom) {
- this._adjustTilePoint(tilePoint);
- tile.src = this.getTileUrl(tilePoint);
+ for (var i = 2 * x; i < 2 * x + 2; i++) {
+ for (var j = 2 * y; j < 2 * y + 2; j++) {
- this.fire('tileloadstart', {
- tile: tile,
- url: tile.src
- });
- },
+ var coords = new L.Point(i, j);
+ coords.z = z + 1;
- _tileLoaded: function () {
- this._tilesToLoad--;
+ var key = this._tileCoordsToKey(coords),
+ tile = this._tiles[key];
- if (this._animated) {
- L.DomUtil.addClass(this._tileContainer, 'leaflet-zoom-animated');
- }
+ if (tile && tile.active) {
+ tile.retain = true;
+ continue;
- if (!this._tilesToLoad) {
- this.fire('load');
+ } else if (tile && tile.loaded) {
+ tile.retain = true;
+ }
- if (this._animated) {
- // clear scaled tiles after all new tiles are loaded (for performance)
- clearTimeout(this._clearBgBufferTimer);
- this._clearBgBufferTimer = setTimeout(L.bind(this._clearBgBuffer, this), 500);
+ if (z + 1 < maxZoom) {
+ this._retainChildren(i, j, z + 1, maxZoom);
+ }
}
}
},
- _tileOnLoad: function () {
- var layer = this._layer;
+ _resetView: function (e) {
+ var animating = e && (e.pinch || e.flyTo);
+ this._setView(this._map.getCenter(), this._map.getZoom(), animating, animating);
+ },
- //Only if we are loading an actual image
- if (this.src !== L.Util.emptyImageUrl) {
- L.DomUtil.addClass(this, 'leaflet-tile-loaded');
+ _animateZoom: function (e) {
+ this._setView(e.center, e.zoom, true, e.noUpdate);
+ },
- layer.fire('tileload', {
- tile: this,
- url: this.src
- });
+ _setView: function (center, zoom, noPrune, noUpdate) {
+ var tileZoom = Math.round(zoom);
+ if ((this.options.maxZoom !== undefined && tileZoom > this.options.maxZoom) ||
+ (this.options.minZoom !== undefined && tileZoom < this.options.minZoom)) {
+ tileZoom = undefined;
}
- layer._tileLoaded();
- },
+ var tileZoomChanged = this.options.updateWhenZooming && (tileZoom !== this._tileZoom);
- _tileOnError: function () {
- var layer = this._layer;
+ if (!noUpdate || tileZoomChanged) {
- layer.fire('tileerror', {
- tile: this,
- url: this.src
- });
+ this._tileZoom = tileZoom;
- var newUrl = layer.options.errorTileUrl;
- if (newUrl) {
- this.src = newUrl;
- }
+ if (this._abortLoading) {
+ this._abortLoading();
+ }
- layer._tileLoaded();
- }
-});
-
-L.tileLayer = function (url, options) {
- return new L.TileLayer(url, options);
-};
+ this._updateLevels();
+ this._resetGrid();
+ if (tileZoom !== undefined) {
+ this._update(center);
+ }
-/*
- * L.TileLayer.WMS is used for putting WMS tile layers on the map.
- */
+ if (!noPrune) {
+ this._pruneTiles();
+ }
-L.TileLayer.WMS = L.TileLayer.extend({
+ // Flag to prevent _updateOpacity from pruning tiles during
+ // a zoom anim or a pinch gesture
+ this._noPrune = !!noPrune;
+ }
- defaultWmsParams: {
- service: 'WMS',
- request: 'GetMap',
- version: '1.1.1',
- layers: '',
- styles: '',
- format: 'image/jpeg',
- transparent: false
+ this._setZoomTransforms(center, zoom);
},
- initialize: function (url, options) { // (String, Object)
-
- this._url = url;
+ _setZoomTransforms: function (center, zoom) {
+ for (var i in this._levels) {
+ this._setZoomTransform(this._levels[i], center, zoom);
+ }
+ },
- var wmsParams = L.extend({}, this.defaultWmsParams),
- tileSize = options.tileSize || this.options.tileSize;
+ _setZoomTransform: function (level, center, zoom) {
+ var scale = this._map.getZoomScale(zoom, level.zoom),
+ translate = level.origin.multiplyBy(scale)
+ .subtract(this._map._getNewPixelOrigin(center, zoom)).round();
- if (options.detectRetina && L.Browser.retina) {
- wmsParams.width = wmsParams.height = tileSize * 2;
+ if (L.Browser.any3d) {
+ L.DomUtil.setTransform(level.el, translate, scale);
} else {
- wmsParams.width = wmsParams.height = tileSize;
+ L.DomUtil.setPosition(level.el, translate);
}
+ },
- for (var i in options) {
- // all keys that are not TileLayer options go to WMS params
- if (!this.options.hasOwnProperty(i) && i !== 'crs') {
- wmsParams[i] = options[i];
- }
- }
+ _resetGrid: function () {
+ var map = this._map,
+ crs = map.options.crs,
+ tileSize = this._tileSize = this.getTileSize(),
+ tileZoom = this._tileZoom;
- this.wmsParams = wmsParams;
+ var bounds = this._map.getPixelWorldBounds(this._tileZoom);
+ if (bounds) {
+ this._globalTileRange = this._pxBoundsToTileRange(bounds);
+ }
- L.setOptions(this, options);
+ this._wrapX = crs.wrapLng && !this.options.noWrap && [
+ Math.floor(map.project([0, crs.wrapLng[0]], tileZoom).x / tileSize.x),
+ Math.ceil(map.project([0, crs.wrapLng[1]], tileZoom).x / tileSize.y)
+ ];
+ this._wrapY = crs.wrapLat && !this.options.noWrap && [
+ Math.floor(map.project([crs.wrapLat[0], 0], tileZoom).y / tileSize.x),
+ Math.ceil(map.project([crs.wrapLat[1], 0], tileZoom).y / tileSize.y)
+ ];
},
- onAdd: function (map) {
-
- this._crs = this.options.crs || map.options.crs;
+ _onMoveEnd: function () {
+ if (!this._map || this._map._animatingZoom) { return; }
- this._wmsVersion = parseFloat(this.wmsParams.version);
+ this._update();
+ },
- var projectionKey = this._wmsVersion >= 1.3 ? 'crs' : 'srs';
- this.wmsParams[projectionKey] = this._crs.code;
+ _getTiledPixelBounds: function (center) {
+ var map = this._map,
+ mapZoom = map._animatingZoom ? Math.max(map._animateToZoom, map.getZoom()) : map.getZoom(),
+ scale = map.getZoomScale(mapZoom, this._tileZoom),
+ pixelCenter = map.project(center, this._tileZoom).floor(),
+ halfSize = map.getSize().divideBy(scale * 2);
- L.TileLayer.prototype.onAdd.call(this, map);
+ return new L.Bounds(pixelCenter.subtract(halfSize), pixelCenter.add(halfSize));
},
- getTileUrl: function (tilePoint) { // (Point, Number) -> String
-
- var map = this._map,
- tileSize = this.options.tileSize,
+ // Private method to load tiles in the grid's active zoom level according to map bounds
+ _update: function (center) {
+ var map = this._map;
+ if (!map) { return; }
+ var zoom = map.getZoom();
- nwPoint = tilePoint.multiplyBy(tileSize),
- sePoint = nwPoint.add([tileSize, tileSize]),
+ if (center === undefined) { center = map.getCenter(); }
+ if (this._tileZoom === undefined) { return; } // if out of minzoom/maxzoom
- nw = this._crs.project(map.unproject(nwPoint, tilePoint.z)),
- se = this._crs.project(map.unproject(sePoint, tilePoint.z)),
- bbox = this._wmsVersion >= 1.3 && this._crs === L.CRS.EPSG4326 ?
- [se.y, nw.x, nw.y, se.x].join(',') :
- [nw.x, se.y, se.x, nw.y].join(','),
+ var pixelBounds = this._getTiledPixelBounds(center),
+ tileRange = this._pxBoundsToTileRange(pixelBounds),
+ tileCenter = tileRange.getCenter(),
+ queue = [],
+ margin = this.options.keepBuffer,
+ noPruneRange = new L.Bounds(tileRange.getBottomLeft().subtract([margin, -margin]),
+ tileRange.getTopRight().add([margin, -margin]));
- url = L.Util.template(this._url, {s: this._getSubdomain(tilePoint)});
+ for (var key in this._tiles) {
+ var c = this._tiles[key].coords;
+ if (c.z !== this._tileZoom || !noPruneRange.contains(L.point(c.x, c.y))) {
+ this._tiles[key].current = false;
+ }
+ }
- return url + L.Util.getParamString(this.wmsParams, url, true) + '&BBOX=' + bbox;
- },
+ // _update just loads more tiles. If the tile zoom level differs too much
+ // from the map's, let _setView reset levels and prune old tiles.
+ if (Math.abs(zoom - this._tileZoom) > 1) { this._setView(center, zoom); return; }
- setParams: function (params, noRedraw) {
+ // create a queue of coordinates to load tiles from
+ for (var j = tileRange.min.y; j <= tileRange.max.y; j++) {
+ for (var i = tileRange.min.x; i <= tileRange.max.x; i++) {
+ var coords = new L.Point(i, j);
+ coords.z = this._tileZoom;
- L.extend(this.wmsParams, params);
+ if (!this._isValidTile(coords)) { continue; }
- if (!noRedraw) {
- this.redraw();
+ var tile = this._tiles[this._tileCoordsToKey(coords)];
+ if (tile) {
+ tile.current = true;
+ } else {
+ queue.push(coords);
+ }
+ }
}
- return this;
- }
-});
+ // sort tile queue to load tiles in order of their distance to center
+ queue.sort(function (a, b) {
+ return a.distanceTo(tileCenter) - b.distanceTo(tileCenter);
+ });
-L.tileLayer.wms = function (url, options) {
- return new L.TileLayer.WMS(url, options);
-};
+ if (queue.length !== 0) {
+ // if its the first batch of tiles to load
+ if (!this._loading) {
+ this._loading = true;
+ // @event loading: Event
+ // Fired when the grid layer starts loading tiles.
+ this.fire('loading');
+ }
+ // create DOM fragment to append tiles in one batch
+ var fragment = document.createDocumentFragment();
-/*
- * L.TileLayer.Canvas is a class that you can use as a base for creating
- * dynamically drawn Canvas-based tile layers.
- */
+ for (i = 0; i < queue.length; i++) {
+ this._addTile(queue[i], fragment);
+ }
-L.TileLayer.Canvas = L.TileLayer.extend({
- options: {
- async: false
+ this._level.el.appendChild(fragment);
+ }
},
- initialize: function (options) {
- L.setOptions(this, options);
- },
+ _isValidTile: function (coords) {
+ var crs = this._map.options.crs;
- redraw: function () {
- if (this._map) {
- this._reset({hard: true});
- this._update();
+ if (!crs.infinite) {
+ // don't load tile if it's out of bounds and not wrapped
+ var bounds = this._globalTileRange;
+ if ((!crs.wrapLng && (coords.x < bounds.min.x || coords.x > bounds.max.x)) ||
+ (!crs.wrapLat && (coords.y < bounds.min.y || coords.y > bounds.max.y))) { return false; }
}
- for (var i in this._tiles) {
- this._redrawTile(this._tiles[i]);
- }
- return this;
- },
+ if (!this.options.bounds) { return true; }
- _redrawTile: function (tile) {
- this.drawTile(tile, tile._tilePoint, this._map._zoom);
+ // don't load tile if it doesn't intersect the bounds in options
+ var tileBounds = this._tileCoordsToBounds(coords);
+ return L.latLngBounds(this.options.bounds).overlaps(tileBounds);
},
- _createTile: function () {
- var tile = L.DomUtil.create('canvas', 'leaflet-tile');
- tile.width = tile.height = this.options.tileSize;
- tile.onselectstart = tile.onmousemove = L.Util.falseFn;
- return tile;
+ _keyToBounds: function (key) {
+ return this._tileCoordsToBounds(this._keyToTileCoords(key));
},
- _loadTile: function (tile, tilePoint) {
- tile._layer = this;
- tile._tilePoint = tilePoint;
+ // converts tile coordinates to its geographical bounds
+ _tileCoordsToBounds: function (coords) {
+
+ var map = this._map,
+ tileSize = this.getTileSize(),
+
+ nwPoint = coords.scaleBy(tileSize),
+ sePoint = nwPoint.add(tileSize),
- this._redrawTile(tile);
+ nw = map.unproject(nwPoint, coords.z),
+ se = map.unproject(sePoint, coords.z);
- if (!this.options.async) {
- this.tileDrawn(tile);
+ if (!this.options.noWrap) {
+ nw = map.wrapLatLng(nw);
+ se = map.wrapLatLng(se);
}
- },
- drawTile: function (/*tile, tilePoint*/) {
- // override with rendering code
+ return new L.LatLngBounds(nw, se);
},
- tileDrawn: function (tile) {
- this._tileOnLoad.call(tile);
- }
-});
-
+ // converts tile coordinates to key for the tile cache
+ _tileCoordsToKey: function (coords) {
+ return coords.x + ':' + coords.y + ':' + coords.z;
+ },
-L.tileLayer.canvas = function (options) {
- return new L.TileLayer.Canvas(options);
-};
+ // converts tile cache key to coordinates
+ _keyToTileCoords: function (key) {
+ var k = key.split(':'),
+ coords = new L.Point(+k[0], +k[1]);
+ coords.z = +k[2];
+ return coords;
+ },
+ _removeTile: function (key) {
+ var tile = this._tiles[key];
+ if (!tile) { return; }
-/*
- * L.ImageOverlay is used to overlay images over the map (to specific geographical bounds).
- */
+ L.DomUtil.remove(tile.el);
-L.ImageOverlay = L.Class.extend({
- includes: L.Mixin.Events,
+ delete this._tiles[key];
- options: {
- opacity: 1
+ // @event tileunload: TileEvent
+ // Fired when a tile is removed (e.g. when a tile goes off the screen).
+ this.fire('tileunload', {
+ tile: tile.el,
+ coords: this._keyToTileCoords(key)
+ });
},
- initialize: function (url, bounds, options) { // (String, LatLngBounds, Object)
- this._url = url;
- this._bounds = L.latLngBounds(bounds);
+ _initTile: function (tile) {
+ L.DomUtil.addClass(tile, 'leaflet-tile');
- L.setOptions(this, options);
- },
+ var tileSize = this.getTileSize();
+ tile.style.width = tileSize.x + 'px';
+ tile.style.height = tileSize.y + 'px';
- onAdd: function (map) {
- this._map = map;
+ tile.onselectstart = L.Util.falseFn;
+ tile.onmousemove = L.Util.falseFn;
- if (!this._image) {
- this._initImage();
+ // update opacity on tiles in IE7-8 because of filter inheritance problems
+ if (L.Browser.ielt9 && this.options.opacity < 1) {
+ L.DomUtil.setOpacity(tile, this.options.opacity);
}
- map._panes.overlayPane.appendChild(this._image);
-
- map.on('viewreset', this._reset, this);
-
- if (map.options.zoomAnimation && L.Browser.any3d) {
- map.on('zoomanim', this._animateZoom, this);
+ // without this hack, tiles disappear after zoom on Chrome for Android
+ // https://github.com/Leaflet/Leaflet/issues/2078
+ if (L.Browser.android && !L.Browser.android23) {
+ tile.style.WebkitBackfaceVisibility = 'hidden';
}
-
- this._reset();
},
- onRemove: function (map) {
- map.getPanes().overlayPane.removeChild(this._image);
+ _addTile: function (coords, container) {
+ var tilePos = this._getTilePos(coords),
+ key = this._tileCoordsToKey(coords);
- map.off('viewreset', this._reset, this);
+ var tile = this.createTile(this._wrapCoords(coords), L.bind(this._tileReady, this, coords));
- if (map.options.zoomAnimation) {
- map.off('zoomanim', this._animateZoom, this);
+ this._initTile(tile);
+
+ // if createTile is defined with a second argument ("done" callback),
+ // we know that tile is async and will be ready later; otherwise
+ if (this.createTile.length < 2) {
+ // mark tile as ready, but delay one frame for opacity animation to happen
+ L.Util.requestAnimFrame(L.bind(this._tileReady, this, coords, null, tile));
}
- },
- addTo: function (map) {
- map.addLayer(this);
- return this;
- },
+ L.DomUtil.setPosition(tile, tilePos);
- setOpacity: function (opacity) {
- this.options.opacity = opacity;
- this._updateOpacity();
- return this;
- },
+ // save tile in cache
+ this._tiles[key] = {
+ el: tile,
+ coords: coords,
+ current: true
+ };
- // TODO remove bringToFront/bringToBack duplication from TileLayer/Path
- bringToFront: function () {
- if (this._image) {
- this._map._panes.overlayPane.appendChild(this._image);
- }
- return this;
+ container.appendChild(tile);
+ // @event tileloadstart: TileEvent
+ // Fired when a tile is requested and starts loading.
+ this.fire('tileloadstart', {
+ tile: tile,
+ coords: coords
+ });
},
- bringToBack: function () {
- var pane = this._map._panes.overlayPane;
- if (this._image) {
- pane.insertBefore(this._image, pane.firstChild);
- }
- return this;
- },
+ _tileReady: function (coords, err, tile) {
+ if (!this._map) { return; }
- setUrl: function (url) {
- this._url = url;
- this._image.src = this._url;
- },
+ if (err) {
+ // @event tileerror: TileErrorEvent
+ // Fired when there is an error loading a tile.
+ this.fire('tileerror', {
+ error: err,
+ tile: tile,
+ coords: coords
+ });
+ }
- getAttribution: function () {
- return this.options.attribution;
- },
+ var key = this._tileCoordsToKey(coords);
- _initImage: function () {
- this._image = L.DomUtil.create('img', 'leaflet-image-layer');
+ tile = this._tiles[key];
+ if (!tile) { return; }
- if (this._map.options.zoomAnimation && L.Browser.any3d) {
- L.DomUtil.addClass(this._image, 'leaflet-zoom-animated');
+ tile.loaded = +new Date();
+ if (this._map._fadeAnimated) {
+ L.DomUtil.setOpacity(tile.el, 0);
+ L.Util.cancelAnimFrame(this._fadeFrame);
+ this._fadeFrame = L.Util.requestAnimFrame(this._updateOpacity, this);
} else {
- L.DomUtil.addClass(this._image, 'leaflet-zoom-hide');
+ tile.active = true;
+ this._pruneTiles();
}
- this._updateOpacity();
+ L.DomUtil.addClass(tile.el, 'leaflet-tile-loaded');
- //TODO createImage util method to remove duplication
- L.extend(this._image, {
- galleryimg: 'no',
- onselectstart: L.Util.falseFn,
- onmousemove: L.Util.falseFn,
- onload: L.bind(this._onImageLoad, this),
- src: this._url
+ // @event tileload: TileEvent
+ // Fired when a tile loads.
+ this.fire('tileload', {
+ tile: tile.el,
+ coords: coords
});
- },
-
- _animateZoom: function (e) {
- var map = this._map,
- image = this._image,
- scale = map.getZoomScale(e.zoom),
- nw = this._bounds.getNorthWest(),
- se = this._bounds.getSouthEast(),
- topLeft = map._latLngToNewLayerPoint(nw, e.zoom, e.center),
- size = map._latLngToNewLayerPoint(se, e.zoom, e.center)._subtract(topLeft),
- origin = topLeft._add(size._multiplyBy((1 / 2) * (1 - 1 / scale)));
+ if (this._noTilesToLoad()) {
+ this._loading = false;
+ // @event load: Event
+ // Fired when the grid layer loaded all visible tiles.
+ this.fire('load');
- image.style[L.DomUtil.TRANSFORM] =
- L.DomUtil.getTranslateString(origin) + ' scale(' + scale + ') ';
+ if (L.Browser.ielt9 || !this._map._fadeAnimated) {
+ L.Util.requestAnimFrame(this._pruneTiles, this);
+ } else {
+ // Wait a bit more than 0.2 secs (the duration of the tile fade-in)
+ // to trigger a pruning.
+ setTimeout(L.bind(this._pruneTiles, this), 250);
+ }
+ }
},
- _reset: function () {
- var image = this._image,
- topLeft = this._map.latLngToLayerPoint(this._bounds.getNorthWest()),
- size = this._map.latLngToLayerPoint(this._bounds.getSouthEast())._subtract(topLeft);
-
- L.DomUtil.setPosition(image, topLeft);
+ _getTilePos: function (coords) {
+ return coords.scaleBy(this.getTileSize()).subtract(this._level.origin);
+ },
- image.style.width = size.x + 'px';
- image.style.height = size.y + 'px';
+ _wrapCoords: function (coords) {
+ var newCoords = new L.Point(
+ this._wrapX ? L.Util.wrapNum(coords.x, this._wrapX) : coords.x,
+ this._wrapY ? L.Util.wrapNum(coords.y, this._wrapY) : coords.y);
+ newCoords.z = coords.z;
+ return newCoords;
},
- _onImageLoad: function () {
- this.fire('load');
+ _pxBoundsToTileRange: function (bounds) {
+ var tileSize = this.getTileSize();
+ return new L.Bounds(
+ bounds.min.unscaleBy(tileSize).floor(),
+ bounds.max.unscaleBy(tileSize).ceil().subtract([1, 1]));
},
- _updateOpacity: function () {
- L.DomUtil.setOpacity(this._image, this.options.opacity);
+ _noTilesToLoad: function () {
+ for (var key in this._tiles) {
+ if (!this._tiles[key].loaded) { return false; }
+ }
+ return true;
}
});
-L.imageOverlay = function (url, bounds, options) {
- return new L.ImageOverlay(url, bounds, options);
+// @factory L.gridLayer(options?: GridLayer options)
+// Creates a new instance of GridLayer with the supplied options.
+L.gridLayer = function (options) {
+ return new L.GridLayer(options);
};
+
/*
- * L.Icon is an image-based icon class that you can use with L.Marker for custom markers.
+ * @class TileLayer
+ * @inherits GridLayer
+ * @aka L.TileLayer
+ * Used to load and display tile layers on the map. Extends `GridLayer`.
+ *
+ * @example
+ *
+ * ```js
+ * L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);
+ * ```
+ *
+ * @section URL template
+ * @example
+ *
+ * A string of the following form:
+ *
+ * ```
+ * 'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
+ * ```
+ *
+ * `{s}` means one of the available subdomains (used sequentially to help with browser parallel requests per domain limitation; subdomain values are specified in options; `a`, `b` or `c` by default, can be omitted), `{z}` — zoom level, `{x}` and `{y}` — tile coordinates. `{r}` can be used to add @2x to the URL to load retina tiles.
+ *
+ * You can use custom keys in the template, which will be [evaluated](#util-template) from TileLayer options, like this:
+ *
+ * ```
+ * L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});
+ * ```
*/
-L.Icon = L.Class.extend({
+
+L.TileLayer = L.GridLayer.extend({
+
+ // @section
+ // @aka TileLayer options
options: {
- /*
- iconUrl: (String) (required)
- iconRetinaUrl: (String) (optional, used for retina devices if detected)
- iconSize: (Point) (can be set through CSS)
- iconAnchor: (Point) (centered by default, can be set in CSS with negative margins)
- popupAnchor: (Point) (if not specified, popup opens in the anchor point)
- shadowUrl: (String) (no shadow by default)
- shadowRetinaUrl: (String) (optional, used for retina devices if detected)
- shadowSize: (Point)
- shadowAnchor: (Point)
- */
- className: ''
- },
+ // @option minZoom: Number = 0
+ // Minimum zoom number.
+ minZoom: 0,
- initialize: function (options) {
- L.setOptions(this, options);
- },
+ // @option maxZoom: Number = 18
+ // Maximum zoom number.
+ maxZoom: 18,
- createIcon: function (oldIcon) {
- return this._createIcon('icon', oldIcon);
- },
+ // @option maxNativeZoom: Number = null
+ // Maximum zoom number the tile source has available. If it is specified,
+ // the tiles on all zoom levels higher than `maxNativeZoom` will be loaded
+ // from `maxNativeZoom` level and auto-scaled.
+ maxNativeZoom: null,
- createShadow: function (oldIcon) {
- return this._createIcon('shadow', oldIcon);
- },
+ // @option subdomains: String|String[] = 'abc'
+ // Subdomains of the tile service. Can be passed in the form of one string (where each letter is a subdomain name) or an array of strings.
+ subdomains: 'abc',
- _createIcon: function (name, oldIcon) {
- var src = this._getIconUrl(name);
+ // @option errorTileUrl: String = ''
+ // URL to the tile image to show in place of the tile that failed to load.
+ errorTileUrl: '',
- if (!src) {
- if (name === 'icon') {
- throw new Error('iconUrl not set in Icon options (see the docs).');
- }
- return null;
- }
+ // @option zoomOffset: Number = 0
+ // The zoom number used in tile URLs will be offset with this value.
+ zoomOffset: 0,
- var img;
- if (!oldIcon || oldIcon.tagName !== 'IMG') {
- img = this._createImg(src);
- } else {
- img = this._createImg(src, oldIcon);
- }
- this._setIconStyles(img, name);
+ // @option tms: Boolean = false
+ // If `true`, inverses Y axis numbering for tiles (turn this on for [TMS](https://en.wikipedia.org/wiki/Tile_Map_Service) services).
+ tms: false,
- return img;
+ // @option zoomReverse: Boolean = false
+ // If set to true, the zoom number used in tile URLs will be reversed (`maxZoom - zoom` instead of `zoom`)
+ zoomReverse: false,
+
+ // @option detectRetina: Boolean = false
+ // If `true` and user is on a retina display, it will request four tiles of half the specified size and a bigger zoom level in place of one to utilize the high resolution.
+ detectRetina: false,
+
+ // @option crossOrigin: Boolean = false
+ // If true, all tiles will have their crossOrigin attribute set to ''. This is needed if you want to access tile pixel data.
+ crossOrigin: false
},
- _setIconStyles: function (img, name) {
- var options = this.options,
- size = L.point(options[name + 'Size']),
- anchor;
+ initialize: function (url, options) {
- if (name === 'shadow') {
- anchor = L.point(options.shadowAnchor || options.iconAnchor);
- } else {
- anchor = L.point(options.iconAnchor);
- }
+ this._url = url;
- if (!anchor && size) {
- anchor = size.divideBy(2, true);
- }
+ options = L.setOptions(this, options);
+
+ // detecting retina displays, adjusting tileSize and zoom levels
+ if (options.detectRetina && L.Browser.retina && options.maxZoom > 0) {
- img.className = 'leaflet-marker-' + name + ' ' + options.className;
+ options.tileSize = Math.floor(options.tileSize / 2);
- if (anchor) {
- img.style.marginLeft = (-anchor.x) + 'px';
- img.style.marginTop = (-anchor.y) + 'px';
+ if (!options.zoomReverse) {
+ options.zoomOffset++;
+ options.maxZoom--;
+ } else {
+ options.zoomOffset--;
+ options.minZoom++;
+ }
+
+ options.minZoom = Math.max(0, options.minZoom);
}
- if (size) {
- img.style.width = size.x + 'px';
- img.style.height = size.y + 'px';
+ if (typeof options.subdomains === 'string') {
+ options.subdomains = options.subdomains.split('');
}
- },
- _createImg: function (src, el) {
- el = el || document.createElement('img');
- el.src = src;
- return el;
+ // for https://github.com/Leaflet/Leaflet/issues/137
+ if (!L.Browser.android) {
+ this.on('tileunload', this._onTileRemove);
+ }
},
- _getIconUrl: function (name) {
- if (L.Browser.retina && this.options[name + 'RetinaUrl']) {
- return this.options[name + 'RetinaUrl'];
+ // @method setUrl(url: String, noRedraw?: Boolean): this
+ // Updates the layer's URL template and redraws it (unless `noRedraw` is set to `true`).
+ setUrl: function (url, noRedraw) {
+ this._url = url;
+
+ if (!noRedraw) {
+ this.redraw();
}
- return this.options[name + 'Url'];
- }
-});
+ return this;
+ },
-L.icon = function (options) {
- return new L.Icon(options);
-};
+ // @method createTile(coords: Object, done?: Function): HTMLElement
+ // Called only internally, overrides GridLayer's [`createTile()`](#gridlayer-createtile)
+ // to return an `<img>` HTML element with the appropiate image URL given `coords`. The `done`
+ // callback is called when the tile has been loaded.
+ createTile: function (coords, done) {
+ var tile = document.createElement('img');
+ L.DomEvent.on(tile, 'load', L.bind(this._tileOnLoad, this, done, tile));
+ L.DomEvent.on(tile, 'error', L.bind(this._tileOnError, this, done, tile));
-/*
- * L.Icon.Default is the blue marker icon used by default in Leaflet.
- */
+ if (this.options.crossOrigin) {
+ tile.crossOrigin = '';
+ }
-L.Icon.Default = L.Icon.extend({
+ /*
+ Alt tag is set to empty string to keep screen readers from reading URL and for compliance reasons
+ http://www.w3.org/TR/WCAG20-TECHS/H67
+ */
+ tile.alt = '';
- options: {
- iconSize: [25, 41],
- iconAnchor: [12, 41],
- popupAnchor: [1, -34],
+ tile.src = this.getTileUrl(coords);
- shadowSize: [41, 41]
+ return tile;
},
- _getIconUrl: function (name) {
- var key = name + 'Url';
+ // @section Extension methods
+ // @uninheritable
+ // Layers extending `TileLayer` might reimplement the following method.
+ // @method getTileUrl(coords: Object): String
+ // Called only internally, returns the URL for a tile given its coordinates.
+ // Classes extending `TileLayer` can override this function to provide custom tile URL naming schemes.
+ getTileUrl: function (coords) {
+ var data = {
+ r: L.Browser.retina ? '@2x' : '',
+ s: this._getSubdomain(coords),
+ x: coords.x,
+ y: coords.y,
+ z: this._getZoomForUrl()
+ };
+ if (this._map && !this._map.options.crs.infinite) {
+ var invertedY = this._globalTileRange.max.y - coords.y;
+ if (this.options.tms) {
+ data['y'] = invertedY;
+ }
+ data['-y'] = invertedY;
+ }
+
+ return L.Util.template(this._url, L.extend(data, this.options));
+ },
- if (this.options[key]) {
- return this.options[key];
+ _tileOnLoad: function (done, tile) {
+ // For https://github.com/Leaflet/Leaflet/issues/3332
+ if (L.Browser.ielt9) {
+ setTimeout(L.bind(done, this, null, tile), 0);
+ } else {
+ done(null, tile);
}
+ },
- if (L.Browser.retina && name === 'icon') {
- name += '-2x';
+ _tileOnError: function (done, tile, e) {
+ var errorUrl = this.options.errorTileUrl;
+ if (errorUrl) {
+ tile.src = errorUrl;
}
+ done(e, tile);
+ },
+
+ getTileSize: function () {
+ var map = this._map,
+ tileSize = L.GridLayer.prototype.getTileSize.call(this),
+ zoom = this._tileZoom + this.options.zoomOffset,
+ zoomN = this.options.maxNativeZoom;
+
+ // increase tile size when overscaling
+ return zoomN !== null && zoom > zoomN ?
+ tileSize.divideBy(map.getZoomScale(zoomN, zoom)).round() :
+ tileSize;
+ },
+
+ _onTileRemove: function (e) {
+ e.tile.onload = null;
+ },
+
+ _getZoomForUrl: function () {
- var path = L.Icon.Default.imagePath;
+ var options = this.options,
+ zoom = this._tileZoom;
- if (!path) {
- throw new Error('Couldn\'t autodetect L.Icon.Default.imagePath, set it manually.');
+ if (options.zoomReverse) {
+ zoom = options.maxZoom - zoom;
}
- return path + '/marker-' + name + '.png';
- }
-});
+ zoom += options.zoomOffset;
+
+ return options.maxNativeZoom !== null ? Math.min(zoom, options.maxNativeZoom) : zoom;
+ },
-L.Icon.Default.imagePath = (function () {
- var scripts = document.getElementsByTagName('script'),
- leafletRe = /[\/^]leaflet[\-\._]?([\w\-\._]*)\.js\??/;
+ _getSubdomain: function (tilePoint) {
+ var index = Math.abs(tilePoint.x + tilePoint.y) % this.options.subdomains.length;
+ return this.options.subdomains[index];
+ },
- var i, len, src, matches, path;
+ // stops loading all tiles in the background layer
+ _abortLoading: function () {
+ var i, tile;
+ for (i in this._tiles) {
+ if (this._tiles[i].coords.z !== this._tileZoom) {
+ tile = this._tiles[i].el;
- for (i = 0, len = scripts.length; i < len; i++) {
- src = scripts[i].src;
- matches = src.match(leafletRe);
+ tile.onload = L.Util.falseFn;
+ tile.onerror = L.Util.falseFn;
- if (matches) {
- path = src.split(leafletRe)[0];
- return (path ? path + '/' : '') + 'images';
+ if (!tile.complete) {
+ tile.src = L.Util.emptyImageUrl;
+ L.DomUtil.remove(tile);
+ }
+ }
}
}
-}());
+});
+
+
+// @factory L.tilelayer(urlTemplate: String, options?: TileLayer options)
+// Instantiates a tile layer object given a `URL template` and optionally an options object.
+
+L.tileLayer = function (url, options) {
+ return new L.TileLayer(url, options);
+};
+
/*
- * L.Marker is used to display clickable/draggable icons on the map.
+ * @class TileLayer.WMS
+ * @inherits TileLayer
+ * @aka L.TileLayer.WMS
+ * Used to display [WMS](https://en.wikipedia.org/wiki/Web_Map_Service) services as tile layers on the map. Extends `TileLayer`.
+ *
+ * @example
+ *
+ * ```js
+ * var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
+ * layers: 'nexrad-n0r-900913',
+ * format: 'image/png',
+ * transparent: true,
+ * attribution: "Weather data © 2012 IEM Nexrad"
+ * });
+ * ```
*/
-L.Marker = L.Class.extend({
+L.TileLayer.WMS = L.TileLayer.extend({
- includes: L.Mixin.Events,
+ // @section
+ // @aka TileLayer.WMS options
+ // If any custom options not documented here are used, they will be sent to the
+ // WMS server as extra parameters in each request URL. This can be useful for
+ // [non-standard vendor WMS parameters](http://docs.geoserver.org/stable/en/user/services/wms/vendor.html).
+ defaultWmsParams: {
+ service: 'WMS',
+ request: 'GetMap',
- options: {
- icon: new L.Icon.Default(),
- title: '',
- alt: '',
- clickable: true,
- draggable: false,
- keyboard: true,
- zIndexOffset: 0,
- opacity: 1,
- riseOnHover: false,
- riseOffset: 250
+ // @option layers: String = ''
+ // **(required)** Comma-separated list of WMS layers to show.
+ layers: '',
+
+ // @option styles: String = ''
+ // Comma-separated list of WMS styles.
+ styles: '',
+
+ // @option format: String = 'image/jpeg'
+ // WMS image format (use `'image/png'` for layers with transparency).
+ format: 'image/jpeg',
+
+ // @option transparent: Boolean = false
+ // If `true`, the WMS service will return images with transparency.
+ transparent: false,
+
+ // @option version: String = '1.1.1'
+ // Version of the WMS service to use
+ version: '1.1.1'
},
- initialize: function (latlng, options) {
- L.setOptions(this, options);
- this._latlng = L.latLng(latlng);
+ options: {
+ // @option crs: CRS = null
+ // Coordinate Reference System to use for the WMS requests, defaults to
+ // map CRS. Don't change this if you're not sure what it means.
+ crs: null,
+
+ // @option uppercase: Boolean = false
+ // If `true`, WMS request parameter keys will be uppercase.
+ uppercase: false
},
- onAdd: function (map) {
- this._map = map;
+ initialize: function (url, options) {
- map.on('viewreset', this.update, this);
+ this._url = url;
- this._initIcon();
- this.update();
- this.fire('add');
+ var wmsParams = L.extend({}, this.defaultWmsParams);
- if (map.options.zoomAnimation && map.options.markerZoomAnimation) {
- map.on('zoomanim', this._animateZoom, this);
+ // all keys that are not TileLayer options go to WMS params
+ for (var i in options) {
+ if (!(i in this.options)) {
+ wmsParams[i] = options[i];
+ }
}
- },
- addTo: function (map) {
- map.addLayer(this);
- return this;
- },
+ options = L.setOptions(this, options);
- onRemove: function (map) {
- if (this.dragging) {
- this.dragging.disable();
- }
+ wmsParams.width = wmsParams.height = options.tileSize * (options.detectRetina && L.Browser.retina ? 2 : 1);
- this._removeIcon();
- this._removeShadow();
+ this.wmsParams = wmsParams;
+ },
- this.fire('remove');
+ onAdd: function (map) {
- map.off({
- 'viewreset': this.update,
- 'zoomanim': this._animateZoom
- }, this);
+ this._crs = this.options.crs || map.options.crs;
+ this._wmsVersion = parseFloat(this.wmsParams.version);
- this._map = null;
- },
+ var projectionKey = this._wmsVersion >= 1.3 ? 'crs' : 'srs';
+ this.wmsParams[projectionKey] = this._crs.code;
- getLatLng: function () {
- return this._latlng;
+ L.TileLayer.prototype.onAdd.call(this, map);
},
- setLatLng: function (latlng) {
- this._latlng = L.latLng(latlng);
+ getTileUrl: function (coords) {
- this.update();
+ var tileBounds = this._tileCoordsToBounds(coords),
+ nw = this._crs.project(tileBounds.getNorthWest()),
+ se = this._crs.project(tileBounds.getSouthEast()),
- return this.fire('move', { latlng: this._latlng });
- },
+ bbox = (this._wmsVersion >= 1.3 && this._crs === L.CRS.EPSG4326 ?
+ [se.y, nw.x, nw.y, se.x] :
+ [nw.x, se.y, se.x, nw.y]).join(','),
- setZIndexOffset: function (offset) {
- this.options.zIndexOffset = offset;
- this.update();
+ url = L.TileLayer.prototype.getTileUrl.call(this, coords);
- return this;
+ return url +
+ L.Util.getParamString(this.wmsParams, url, this.options.uppercase) +
+ (this.options.uppercase ? '&BBOX=' : '&bbox=') + bbox;
},
- setIcon: function (icon) {
-
- this.options.icon = icon;
+ // @method setParams(params: Object, noRedraw?: Boolean): this
+ // Merges an object with the new parameters and re-requests tiles on the current screen (unless `noRedraw` was set to true).
+ setParams: function (params, noRedraw) {
- if (this._map) {
- this._initIcon();
- this.update();
- }
+ L.extend(this.wmsParams, params);
- if (this._popup) {
- this.bindPopup(this._popup);
+ if (!noRedraw) {
+ this.redraw();
}
return this;
- },
+ }
+});
- update: function () {
- if (this._icon) {
- this._setPos(this._map.latLngToLayerPoint(this._latlng).round());
- }
- return this;
- },
- _initIcon: function () {
- var options = this.options,
- map = this._map,
- animation = (map.options.zoomAnimation && map.options.markerZoomAnimation),
- classToAdd = animation ? 'leaflet-zoom-animated' : 'leaflet-zoom-hide';
+// @factory L.tileLayer.wms(baseUrl: String, options: TileLayer.WMS options)
+// Instantiates a WMS tile layer object given a base URL of the WMS service and a WMS parameters/options object.
+L.tileLayer.wms = function (url, options) {
+ return new L.TileLayer.WMS(url, options);
+};
- var icon = options.icon.createIcon(this._icon),
- addIcon = false;
- // if we're not reusing the icon, remove the old one and init new one
- if (icon !== this._icon) {
- if (this._icon) {
- this._removeIcon();
- }
- addIcon = true;
- if (options.title) {
- icon.title = options.title;
- }
+/*
+ * @class ImageOverlay
+ * @aka L.ImageOverlay
+ * @inherits Interactive layer
+ *
+ * Used to load and display a single image over specific bounds of the map. Extends `Layer`.
+ *
+ * @example
+ *
+ * ```js
+ * var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
+ * imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
+ * L.imageOverlay(imageUrl, imageBounds).addTo(map);
+ * ```
+ */
- if (options.alt) {
- icon.alt = options.alt;
- }
- }
+L.ImageOverlay = L.Layer.extend({
- L.DomUtil.addClass(icon, classToAdd);
+ // @section
+ // @aka ImageOverlay options
+ options: {
+ // @option opacity: Number = 1.0
+ // The opacity of the image overlay.
+ opacity: 1,
- if (options.keyboard) {
- icon.tabIndex = '0';
- }
+ // @option alt: String = ''
+ // Text for the `alt` attribute of the image (useful for accessibility).
+ alt: '',
- this._icon = icon;
+ // @option interactive: Boolean = false
+ // If `true`, the image overlay will emit [mouse events](#interactive-layer) when clicked or hovered.
+ interactive: false,
- this._initInteraction();
+ // @option attribution: String = null
+ // An optional string containing HTML to be shown on the `Attribution control`
+ attribution: null,
- if (options.riseOnHover) {
- L.DomEvent
- .on(icon, 'mouseover', this._bringToFront, this)
- .on(icon, 'mouseout', this._resetZIndex, this);
- }
+ // @option crossOrigin: Boolean = false
+ // If true, the image will have its crossOrigin attribute set to ''. This is needed if you want to access image pixel data.
+ crossOrigin: false
+ },
- var newShadow = options.icon.createShadow(this._shadow),
- addShadow = false;
+ initialize: function (url, bounds, options) { // (String, LatLngBounds, Object)
+ this._url = url;
+ this._bounds = L.latLngBounds(bounds);
- if (newShadow !== this._shadow) {
- this._removeShadow();
- addShadow = true;
+ L.setOptions(this, options);
+ },
+
+ onAdd: function () {
+ if (!this._image) {
+ this._initImage();
+
+ if (this.options.opacity < 1) {
+ this._updateOpacity();
+ }
}
- if (newShadow) {
- L.DomUtil.addClass(newShadow, classToAdd);
+ if (this.options.interactive) {
+ L.DomUtil.addClass(this._image, 'leaflet-interactive');
+ this.addInteractiveTarget(this._image);
}
- this._shadow = newShadow;
+ this.getPane().appendChild(this._image);
+ this._reset();
+ },
- if (options.opacity < 1) {
- this._updateOpacity();
+ onRemove: function () {
+ L.DomUtil.remove(this._image);
+ if (this.options.interactive) {
+ this.removeInteractiveTarget(this._image);
}
+ },
+ // @method setOpacity(opacity: Number): this
+ // Sets the opacity of the overlay.
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
- var panes = this._map._panes;
-
- if (addIcon) {
- panes.markerPane.appendChild(this._icon);
+ if (this._image) {
+ this._updateOpacity();
}
+ return this;
+ },
- if (newShadow && addShadow) {
- panes.shadowPane.appendChild(this._shadow);
+ setStyle: function (styleOpts) {
+ if (styleOpts.opacity) {
+ this.setOpacity(styleOpts.opacity);
}
+ return this;
},
- _removeIcon: function () {
- if (this.options.riseOnHover) {
- L.DomEvent
- .off(this._icon, 'mouseover', this._bringToFront)
- .off(this._icon, 'mouseout', this._resetZIndex);
+ // @method bringToFront(): this
+ // Brings the layer to the top of all overlays.
+ bringToFront: function () {
+ if (this._map) {
+ L.DomUtil.toFront(this._image);
}
-
- this._map._panes.markerPane.removeChild(this._icon);
-
- this._icon = null;
+ return this;
},
- _removeShadow: function () {
- if (this._shadow) {
- this._map._panes.shadowPane.removeChild(this._shadow);
+ // @method bringToBack(): this
+ // Brings the layer to the bottom of all overlays.
+ bringToBack: function () {
+ if (this._map) {
+ L.DomUtil.toBack(this._image);
}
- this._shadow = null;
+ return this;
},
- _setPos: function (pos) {
- L.DomUtil.setPosition(this._icon, pos);
+ // @method setUrl(url: String): this
+ // Changes the URL of the image.
+ setUrl: function (url) {
+ this._url = url;
- if (this._shadow) {
- L.DomUtil.setPosition(this._shadow, pos);
+ if (this._image) {
+ this._image.src = url;
}
+ return this;
+ },
- this._zIndex = pos.y + this.options.zIndexOffset;
+ setBounds: function (bounds) {
+ this._bounds = bounds;
- this._resetZIndex();
+ if (this._map) {
+ this._reset();
+ }
+ return this;
},
- _updateZIndex: function (offset) {
- this._icon.style.zIndex = this._zIndex + offset;
+ getAttribution: function () {
+ return this.options.attribution;
},
- _animateZoom: function (opt) {
- var pos = this._map._latLngToNewLayerPoint(this._latlng, opt.zoom, opt.center).round();
+ getEvents: function () {
+ var events = {
+ zoom: this._reset,
+ viewreset: this._reset
+ };
- this._setPos(pos);
+ if (this._zoomAnimated) {
+ events.zoomanim = this._animateZoom;
+ }
+
+ return events;
},
- _initInteraction: function () {
+ getBounds: function () {
+ return this._bounds;
+ },
- if (!this.options.clickable) { return; }
+ getElement: function () {
+ return this._image;
+ },
- // TODO refactor into something shared with Map/Path/etc. to DRY it up
+ _initImage: function () {
+ var img = this._image = L.DomUtil.create('img',
+ 'leaflet-image-layer ' + (this._zoomAnimated ? 'leaflet-zoom-animated' : ''));
- var icon = this._icon,
- events = ['dblclick', 'mousedown', 'mouseover', 'mouseout', 'contextmenu'];
+ img.onselectstart = L.Util.falseFn;
+ img.onmousemove = L.Util.falseFn;
- L.DomUtil.addClass(icon, 'leaflet-clickable');
- L.DomEvent.on(icon, 'click', this._onMouseClick, this);
- L.DomEvent.on(icon, 'keypress', this._onKeyPress, this);
+ img.onload = L.bind(this.fire, this, 'load');
- for (var i = 0; i < events.length; i++) {
- L.DomEvent.on(icon, events[i], this._fireMouseEvent, this);
+ if (this.options.crossOrigin) {
+ img.crossOrigin = '';
}
- if (L.Handler.MarkerDrag) {
- this.dragging = new L.Handler.MarkerDrag(this);
+ img.src = this._url;
+ img.alt = this.options.alt;
+ },
- if (this.options.draggable) {
- this.dragging.enable();
- }
- }
+ _animateZoom: function (e) {
+ var scale = this._map.getZoomScale(e.zoom),
+ offset = this._map._latLngToNewLayerPoint(this._bounds.getNorthWest(), e.zoom, e.center);
+
+ L.DomUtil.setTransform(this._image, offset, scale);
},
- _onMouseClick: function (e) {
- var wasDragged = this.dragging && this.dragging.moved();
+ _reset: function () {
+ var image = this._image,
+ bounds = new L.Bounds(
+ this._map.latLngToLayerPoint(this._bounds.getNorthWest()),
+ this._map.latLngToLayerPoint(this._bounds.getSouthEast())),
+ size = bounds.getSize();
- if (this.hasEventListeners(e.type) || wasDragged) {
- L.DomEvent.stopPropagation(e);
- }
+ L.DomUtil.setPosition(image, bounds.min);
+
+ image.style.width = size.x + 'px';
+ image.style.height = size.y + 'px';
+ },
+
+ _updateOpacity: function () {
+ L.DomUtil.setOpacity(this._image, this.options.opacity);
+ }
+});
+
+// @factory L.imageOverlay(imageUrl: String, bounds: LatLngBounds, options?: ImageOverlay options)
+// Instantiates an image overlay object given the URL of the image and the
+// geographical bounds it is tied to.
+L.imageOverlay = function (url, bounds, options) {
+ return new L.ImageOverlay(url, bounds, options);
+};
- if (wasDragged) { return; }
- if ((!this.dragging || !this.dragging._enabled) && this._map.dragging && this._map.dragging.moved()) { return; }
- this.fire(e.type, {
- originalEvent: e,
- latlng: this._latlng
- });
+/*
+ * @class Icon
+ * @aka L.Icon
+ * @inherits Layer
+ *
+ * Represents an icon to provide when creating a marker.
+ *
+ * @example
+ *
+ * ```js
+ * var myIcon = L.icon({
+ * iconUrl: 'my-icon.png',
+ * iconRetinaUrl: 'my-icon@2x.png',
+ * iconSize: [38, 95],
+ * iconAnchor: [22, 94],
+ * popupAnchor: [-3, -76],
+ * shadowUrl: 'my-icon-shadow.png',
+ * shadowRetinaUrl: 'my-icon-shadow@2x.png',
+ * shadowSize: [68, 95],
+ * shadowAnchor: [22, 94]
+ * });
+ *
+ * L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
+ * ```
+ *
+ * `L.Icon.Default` extends `L.Icon` and is the blue icon Leaflet uses for markers by default.
+ *
+ */
+
+L.Icon = L.Class.extend({
+
+ /* @section
+ * @aka Icon options
+ *
+ * @option iconUrl: String = null
+ * **(required)** The URL to the icon image (absolute or relative to your script path).
+ *
+ * @option iconRetinaUrl: String = null
+ * The URL to a retina sized version of the icon image (absolute or relative to your
+ * script path). Used for Retina screen devices.
+ *
+ * @option iconSize: Point = null
+ * Size of the icon image in pixels.
+ *
+ * @option iconAnchor: Point = null
+ * The coordinates of the "tip" of the icon (relative to its top left corner). The icon
+ * will be aligned so that this point is at the marker's geographical location. Centered
+ * by default if size is specified, also can be set in CSS with negative margins.
+ *
+ * @option popupAnchor: Point = null
+ * The coordinates of the point from which popups will "open", relative to the icon anchor.
+ *
+ * @option shadowUrl: String = null
+ * The URL to the icon shadow image. If not specified, no shadow image will be created.
+ *
+ * @option shadowRetinaUrl: String = null
+ *
+ * @option shadowSize: Point = null
+ * Size of the shadow image in pixels.
+ *
+ * @option shadowAnchor: Point = null
+ * The coordinates of the "tip" of the shadow (relative to its top left corner) (the same
+ * as iconAnchor if not specified).
+ *
+ * @option className: String = ''
+ * A custom class name to assign to both icon and shadow images. Empty by default.
+ */
+
+ initialize: function (options) {
+ L.setOptions(this, options);
},
- _onKeyPress: function (e) {
- if (e.keyCode === 13) {
- this.fire('click', {
- originalEvent: e,
- latlng: this._latlng
- });
- }
+ // @method createIcon(oldIcon?: HTMLElement): HTMLElement
+ // Called internally when the icon has to be shown, returns a `<img>` HTML element
+ // styled according to the options.
+ createIcon: function (oldIcon) {
+ return this._createIcon('icon', oldIcon);
},
- _fireMouseEvent: function (e) {
+ // @method createShadow(oldIcon?: HTMLElement): HTMLElement
+ // As `createIcon`, but for the shadow beneath it.
+ createShadow: function (oldIcon) {
+ return this._createIcon('shadow', oldIcon);
+ },
- this.fire(e.type, {
- originalEvent: e,
- latlng: this._latlng
- });
+ _createIcon: function (name, oldIcon) {
+ var src = this._getIconUrl(name);
- // TODO proper custom event propagation
- // this line will always be called if marker is in a FeatureGroup
- if (e.type === 'contextmenu' && this.hasEventListeners(e.type)) {
- L.DomEvent.preventDefault(e);
- }
- if (e.type !== 'mousedown') {
- L.DomEvent.stopPropagation(e);
- } else {
- L.DomEvent.preventDefault(e);
+ if (!src) {
+ if (name === 'icon') {
+ throw new Error('iconUrl not set in Icon options (see the docs).');
+ }
+ return null;
}
+
+ var img = this._createImg(src, oldIcon && oldIcon.tagName === 'IMG' ? oldIcon : null);
+ this._setIconStyles(img, name);
+
+ return img;
},
- setOpacity: function (opacity) {
- this.options.opacity = opacity;
- if (this._map) {
- this._updateOpacity();
+ _setIconStyles: function (img, name) {
+ var options = this.options;
+ var sizeOption = options[name + 'Size'];
+
+ if (typeof sizeOption === 'number') {
+ sizeOption = [sizeOption, sizeOption];
}
- return this;
- },
+ var size = L.point(sizeOption),
+ anchor = L.point(name === 'shadow' && options.shadowAnchor || options.iconAnchor ||
+ size && size.divideBy(2, true));
- _updateOpacity: function () {
- L.DomUtil.setOpacity(this._icon, this.options.opacity);
- if (this._shadow) {
- L.DomUtil.setOpacity(this._shadow, this.options.opacity);
+ img.className = 'leaflet-marker-' + name + ' ' + (options.className || '');
+
+ if (anchor) {
+ img.style.marginLeft = (-anchor.x) + 'px';
+ img.style.marginTop = (-anchor.y) + 'px';
+ }
+
+ if (size) {
+ img.style.width = size.x + 'px';
+ img.style.height = size.y + 'px';
}
},
- _bringToFront: function () {
- this._updateZIndex(this.options.riseOffset);
+ _createImg: function (src, el) {
+ el = el || document.createElement('img');
+ el.src = src;
+ return el;
},
- _resetZIndex: function () {
- this._updateZIndex(0);
+ _getIconUrl: function (name) {
+ return L.Browser.retina && this.options[name + 'RetinaUrl'] || this.options[name + 'Url'];
}
});
-L.marker = function (latlng, options) {
- return new L.Marker(latlng, options);
+
+// @factory L.icon(options: Icon options)
+// Creates an icon instance with the given options.
+L.icon = function (options) {
+ return new L.Icon(options);
};
+
/*
- * L.DivIcon is a lightweight HTML-based icon class (as opposed to the image-based L.Icon)
- * to use with L.Marker.
+ * @miniclass Icon.Default (Icon)
+ * @aka L.Icon.Default
+ * @section
+ *
+ * A trivial subclass of `Icon`, represents the icon to use in `Marker`s when
+ * no icon is specified. Points to the blue marker image distributed with Leaflet
+ * releases.
+ *
+ * In order to change the default icon, just change the properties of `L.Icon.Default.prototype.options`
+ * (which is a set of `Icon options`).
*/
-L.DivIcon = L.Icon.extend({
+L.Icon.Default = L.Icon.extend({
+
options: {
- iconSize: [12, 12], // also can be set through CSS
- /*
- iconAnchor: (Point)
- popupAnchor: (Point)
- html: (String)
- bgPos: (Point)
- */
- className: 'leaflet-div-icon',
- html: false
+ iconUrl: 'marker-icon.png',
+ iconRetinaUrl: 'marker-icon-2x.png',
+ shadowUrl: 'marker-shadow.png',
+ iconSize: [25, 41],
+ iconAnchor: [12, 41],
+ popupAnchor: [1, -34],
+ tooltipAnchor: [16, -28],
+ shadowSize: [41, 41]
},
- createIcon: function (oldIcon) {
- var div = (oldIcon && oldIcon.tagName === 'DIV') ? oldIcon : document.createElement('div'),
- options = this.options;
-
- if (options.html !== false) {
- div.innerHTML = options.html;
- } else {
- div.innerHTML = '';
- }
-
- if (options.bgPos) {
- div.style.backgroundPosition =
- (-options.bgPos.x) + 'px ' + (-options.bgPos.y) + 'px';
+ _getIconUrl: function (name) {
+ if (!L.Icon.Default.imagePath) { // Deprecated, backwards-compatibility only
+ L.Icon.Default.imagePath = this._detectIconPath();
}
- this._setIconStyles(div, 'icon');
- return div;
+ // @option imagePath: String
+ // `L.Icon.Default` will try to auto-detect the absolute location of the
+ // blue icon images. If you are placing these images in a non-standard
+ // way, set this option to point to the right absolute path.
+ return (this.options.imagePath || L.Icon.Default.imagePath) + L.Icon.prototype._getIconUrl.call(this, name);
},
- createShadow: function () {
- return null;
+ _detectIconPath: function () {
+ var el = L.DomUtil.create('div', 'leaflet-default-icon-path', document.body);
+ var path = L.DomUtil.getStyle(el, 'background-image') ||
+ L.DomUtil.getStyle(el, 'backgroundImage'); // IE8
+
+ document.body.removeChild(el);
+
+ return path.indexOf('url') === 0 ?
+ path.replace(/^url\([\"\']?/, '').replace(/[\"\']?\)$/, '') : '';
}
});
-L.divIcon = function (options) {
- return new L.DivIcon(options);
-};
/*
- * L.Popup is used for displaying popups on the map.
+ * @class Marker
+ * @inherits Interactive layer
+ * @aka L.Marker
+ * L.Marker is used to display clickable/draggable icons on the map. Extends `Layer`.
+ *
+ * @example
+ *
+ * ```js
+ * L.marker([50.5, 30.5]).addTo(map);
+ * ```
*/
-L.Map.mergeOptions({
- closePopupOnClick: true
-});
-
-L.Popup = L.Class.extend({
- includes: L.Mixin.Events,
+L.Marker = L.Layer.extend({
+ // @section
+ // @aka Marker options
options: {
- minWidth: 50,
- maxWidth: 300,
- // maxHeight: null,
- autoPan: true,
- closeButton: true,
- offset: [0, 7],
- autoPanPadding: [5, 5],
- // autoPanPaddingTopLeft: null,
- // autoPanPaddingBottomRight: null,
- keepInView: false,
- className: '',
- zoomAnimation: true
- },
-
- initialize: function (options, source) {
- L.setOptions(this, options);
+ // @option icon: Icon = *
+ // Icon class to use for rendering the marker. See [Icon documentation](#L.Icon) for details on how to customize the marker icon. If not specified, a new `L.Icon.Default` is used.
+ icon: new L.Icon.Default(),
- this._source = source;
- this._animated = L.Browser.any3d && this.options.zoomAnimation;
- this._isOpen = false;
- },
+ // Option inherited from "Interactive layer" abstract class
+ interactive: true,
- onAdd: function (map) {
- this._map = map;
+ // @option draggable: Boolean = false
+ // Whether the marker is draggable with mouse/touch or not.
+ draggable: false,
- if (!this._container) {
- this._initLayout();
- }
+ // @option keyboard: Boolean = true
+ // Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.
+ keyboard: true,
- var animFade = map.options.fadeAnimation;
+ // @option title: String = ''
+ // Text for the browser tooltip that appear on marker hover (no tooltip by default).
+ title: '',
- if (animFade) {
- L.DomUtil.setOpacity(this._container, 0);
- }
- map._panes.popupPane.appendChild(this._container);
+ // @option alt: String = ''
+ // Text for the `alt` attribute of the icon image (useful for accessibility).
+ alt: '',
- map.on(this._getEvents(), this);
+ // @option zIndexOffset: Number = 0
+ // By default, marker images zIndex is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like `1000` (or high negative value, respectively).
+ zIndexOffset: 0,
- this.update();
+ // @option opacity: Number = 1.0
+ // The opacity of the marker.
+ opacity: 1,
- if (animFade) {
- L.DomUtil.setOpacity(this._container, 1);
- }
+ // @option riseOnHover: Boolean = false
+ // If `true`, the marker will get on top of others when you hover the mouse over it.
+ riseOnHover: false,
- this.fire('open');
+ // @option riseOffset: Number = 250
+ // The z-index offset used for the `riseOnHover` feature.
+ riseOffset: 250,
- map.fire('popupopen', {popup: this});
+ // @option pane: String = 'markerPane'
+ // `Map pane` where the markers icon will be added.
+ pane: 'markerPane',
- if (this._source) {
- this._source.fire('popupopen', {popup: this});
- }
+ // FIXME: shadowPane is no longer a valid option
+ nonBubblingEvents: ['click', 'dblclick', 'mouseover', 'mouseout', 'contextmenu']
},
- addTo: function (map) {
- map.addLayer(this);
- return this;
- },
+ /* @section
+ *
+ * In addition to [shared layer methods](#Layer) like `addTo()` and `remove()` and [popup methods](#Popup) like bindPopup() you can also use the following methods:
+ */
- openOn: function (map) {
- map.openPopup(this);
- return this;
+ initialize: function (latlng, options) {
+ L.setOptions(this, options);
+ this._latlng = L.latLng(latlng);
},
- onRemove: function (map) {
- map._panes.popupPane.removeChild(this._container);
+ onAdd: function (map) {
+ this._zoomAnimated = this._zoomAnimated && map.options.markerZoomAnimation;
- L.Util.falseFn(this._container.offsetWidth); // force reflow
+ if (this._zoomAnimated) {
+ map.on('zoomanim', this._animateZoom, this);
+ }
- map.off(this._getEvents(), this);
+ this._initIcon();
+ this.update();
+ },
- if (map.options.fadeAnimation) {
- L.DomUtil.setOpacity(this._container, 0);
+ onRemove: function (map) {
+ if (this.dragging && this.dragging.enabled()) {
+ this.options.draggable = true;
+ this.dragging.removeHooks();
}
- this._map = null;
-
- this.fire('close');
+ if (this._zoomAnimated) {
+ map.off('zoomanim', this._animateZoom, this);
+ }
- map.fire('popupclose', {popup: this});
+ this._removeIcon();
+ this._removeShadow();
+ },
- if (this._source) {
- this._source.fire('popupclose', {popup: this});
- }
+ getEvents: function () {
+ return {
+ zoom: this.update,
+ viewreset: this.update
+ };
},
+ // @method getLatLng: LatLng
+ // Returns the current geographical position of the marker.
getLatLng: function () {
return this._latlng;
},
+ // @method setLatLng(latlng: LatLng): this
+ // Changes the marker position to the given point.
setLatLng: function (latlng) {
+ var oldLatLng = this._latlng;
this._latlng = L.latLng(latlng);
- if (this._map) {
- this._updatePosition();
- this._adjustPan();
- }
- return this;
- },
+ this.update();
- getContent: function () {
- return this._content;
+ // @event move: Event
+ // Fired when the marker is moved via [`setLatLng`](#marker-setlatlng) or by [dragging](#marker-dragging). Old and new coordinates are included in event arguments as `oldLatLng`, `latlng`.
+ return this.fire('move', {oldLatLng: oldLatLng, latlng: this._latlng});
},
- setContent: function (content) {
- this._content = content;
- this.update();
- return this;
+ // @method setZIndexOffset(offset: Number): this
+ // Changes the [zIndex offset](#marker-zindexoffset) of the marker.
+ setZIndexOffset: function (offset) {
+ this.options.zIndexOffset = offset;
+ return this.update();
},
- update: function () {
- if (!this._map) { return; }
-
- this._container.style.visibility = 'hidden';
-
- this._updateContent();
- this._updateLayout();
- this._updatePosition();
-
- this._container.style.visibility = '';
-
- this._adjustPan();
- },
+ // @method setIcon(icon: Icon): this
+ // Changes the marker icon.
+ setIcon: function (icon) {
- _getEvents: function () {
- var events = {
- viewreset: this._updatePosition
- };
+ this.options.icon = icon;
- if (this._animated) {
- events.zoomanim = this._zoomAnimation;
- }
- if ('closeOnClick' in this.options ? this.options.closeOnClick : this._map.options.closePopupOnClick) {
- events.preclick = this._close;
+ if (this._map) {
+ this._initIcon();
+ this.update();
}
- if (this.options.keepInView) {
- events.moveend = this._adjustPan;
+
+ if (this._popup) {
+ this.bindPopup(this._popup, this._popup.options);
}
- return events;
+ return this;
},
- _close: function () {
- if (this._map) {
- this._map.closePopup(this);
- }
+ getElement: function () {
+ return this._icon;
},
- _initLayout: function () {
- var prefix = 'leaflet-popup',
- containerClass = prefix + ' ' + this.options.className + ' leaflet-zoom-' +
- (this._animated ? 'animated' : 'hide'),
- container = this._container = L.DomUtil.create('div', containerClass),
- closeButton;
-
- if (this.options.closeButton) {
- closeButton = this._closeButton =
- L.DomUtil.create('a', prefix + '-close-button', container);
- closeButton.href = '#close';
- closeButton.innerHTML = '×';
- L.DomEvent.disableClickPropagation(closeButton);
+ update: function () {
- L.DomEvent.on(closeButton, 'click', this._onCloseButtonClick, this);
+ if (this._icon) {
+ var pos = this._map.latLngToLayerPoint(this._latlng).round();
+ this._setPos(pos);
}
- var wrapper = this._wrapper =
- L.DomUtil.create('div', prefix + '-content-wrapper', container);
- L.DomEvent.disableClickPropagation(wrapper);
-
- this._contentNode = L.DomUtil.create('div', prefix + '-content', wrapper);
-
- L.DomEvent.disableScrollPropagation(this._contentNode);
- L.DomEvent.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);
+ return this;
},
- _updateContent: function () {
- if (!this._content) { return; }
+ _initIcon: function () {
+ var options = this.options,
+ classToAdd = 'leaflet-zoom-' + (this._zoomAnimated ? 'animated' : 'hide');
- if (typeof this._content === 'string') {
- this._contentNode.innerHTML = this._content;
+ var icon = options.icon.createIcon(this._icon),
+ addIcon = false;
+
+ // if we're not reusing the icon, remove the old one and init new one
+ if (icon !== this._icon) {
+ if (this._icon) {
+ this._removeIcon();
+ }
+ addIcon = true;
+
+ if (options.title) {
+ icon.title = options.title;
+ }
+ if (options.alt) {
+ icon.alt = options.alt;
+ }
+ }
+
+ L.DomUtil.addClass(icon, classToAdd);
+
+ if (options.keyboard) {
+ icon.tabIndex = '0';
+ }
+
+ this._icon = icon;
+
+ if (options.riseOnHover) {
+ this.on({
+ mouseover: this._bringToFront,
+ mouseout: this._resetZIndex
+ });
+ }
+
+ var newShadow = options.icon.createShadow(this._shadow),
+ addShadow = false;
+
+ if (newShadow !== this._shadow) {
+ this._removeShadow();
+ addShadow = true;
+ }
+
+ if (newShadow) {
+ L.DomUtil.addClass(newShadow, classToAdd);
+ }
+ this._shadow = newShadow;
+
+
+ if (options.opacity < 1) {
+ this._updateOpacity();
+ }
+
+
+ if (addIcon) {
+ this.getPane().appendChild(this._icon);
+ }
+ this._initInteraction();
+ if (newShadow && addShadow) {
+ this.getPane('shadowPane').appendChild(this._shadow);
+ }
+ },
+
+ _removeIcon: function () {
+ if (this.options.riseOnHover) {
+ this.off({
+ mouseover: this._bringToFront,
+ mouseout: this._resetZIndex
+ });
+ }
+
+ L.DomUtil.remove(this._icon);
+ this.removeInteractiveTarget(this._icon);
+
+ this._icon = null;
+ },
+
+ _removeShadow: function () {
+ if (this._shadow) {
+ L.DomUtil.remove(this._shadow);
+ }
+ this._shadow = null;
+ },
+
+ _setPos: function (pos) {
+ L.DomUtil.setPosition(this._icon, pos);
+
+ if (this._shadow) {
+ L.DomUtil.setPosition(this._shadow, pos);
+ }
+
+ this._zIndex = pos.y + this.options.zIndexOffset;
+
+ this._resetZIndex();
+ },
+
+ _updateZIndex: function (offset) {
+ this._icon.style.zIndex = this._zIndex + offset;
+ },
+
+ _animateZoom: function (opt) {
+ var pos = this._map._latLngToNewLayerPoint(this._latlng, opt.zoom, opt.center).round();
+
+ this._setPos(pos);
+ },
+
+ _initInteraction: function () {
+
+ if (!this.options.interactive) { return; }
+
+ L.DomUtil.addClass(this._icon, 'leaflet-interactive');
+
+ this.addInteractiveTarget(this._icon);
+
+ if (L.Handler.MarkerDrag) {
+ var draggable = this.options.draggable;
+ if (this.dragging) {
+ draggable = this.dragging.enabled();
+ this.dragging.disable();
+ }
+
+ this.dragging = new L.Handler.MarkerDrag(this);
+
+ if (draggable) {
+ this.dragging.enable();
+ }
+ }
+ },
+
+ // @method setOpacity(opacity: Number): this
+ // Changes the opacity of the marker.
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
+ if (this._map) {
+ this._updateOpacity();
+ }
+
+ return this;
+ },
+
+ _updateOpacity: function () {
+ var opacity = this.options.opacity;
+
+ L.DomUtil.setOpacity(this._icon, opacity);
+
+ if (this._shadow) {
+ L.DomUtil.setOpacity(this._shadow, opacity);
+ }
+ },
+
+ _bringToFront: function () {
+ this._updateZIndex(this.options.riseOffset);
+ },
+
+ _resetZIndex: function () {
+ this._updateZIndex(0);
+ }
+});
+
+
+// factory L.marker(latlng: LatLng, options? : Marker options)
+
+// @factory L.marker(latlng: LatLng, options? : Marker options)
+// Instantiates a Marker object given a geographical point and optionally an options object.
+L.marker = function (latlng, options) {
+ return new L.Marker(latlng, options);
+};
+
+
+
+/*
+ * @class DivIcon
+ * @aka L.DivIcon
+ * @inherits Icon
+ *
+ * Represents a lightweight icon for markers that uses a simple `<div>`
+ * element instead of an image. Inherits from `Icon` but ignores the `iconUrl` and shadow options.
+ *
+ * @example
+ * ```js
+ * var myIcon = L.divIcon({className: 'my-div-icon'});
+ * // you can set .my-div-icon styles in CSS
+ *
+ * L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
+ * ```
+ *
+ * By default, it has a 'leaflet-div-icon' CSS class and is styled as a little white square with a shadow.
+ */
+
+L.DivIcon = L.Icon.extend({
+ options: {
+ // @section
+ // @aka DivIcon options
+ iconSize: [12, 12], // also can be set through CSS
+
+ // iconAnchor: (Point),
+ // popupAnchor: (Point),
+
+ // @option html: String = ''
+ // Custom HTML code to put inside the div element, empty by default.
+ html: false,
+
+ // @option bgPos: Point = [0, 0]
+ // Optional relative position of the background, in pixels
+ bgPos: null,
+
+ className: 'leaflet-div-icon'
+ },
+
+ createIcon: function (oldIcon) {
+ var div = (oldIcon && oldIcon.tagName === 'DIV') ? oldIcon : document.createElement('div'),
+ options = this.options;
+
+ div.innerHTML = options.html !== false ? options.html : '';
+
+ if (options.bgPos) {
+ var bgPos = L.point(options.bgPos);
+ div.style.backgroundPosition = (-bgPos.x) + 'px ' + (-bgPos.y) + 'px';
+ }
+ this._setIconStyles(div, 'icon');
+
+ return div;
+ },
+
+ createShadow: function () {
+ return null;
+ }
+});
+
+// @factory L.divIcon(options: DivIcon options)
+// Creates a `DivIcon` instance with the given options.
+L.divIcon = function (options) {
+ return new L.DivIcon(options);
+};
+
+
+
+/*
+ * @class DivOverlay
+ * @inherits Layer
+ * @aka L.DivOverlay
+ * Base model for L.Popup and L.Tooltip. Inherit from it for custom popup like plugins.
+ */
+
+// @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 {
- while (this._contentNode.hasChildNodes()) {
- this._contentNode.removeChild(this._contentNode.firstChild);
+ 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('<p>Hello world!<br />This is a nice popup.</p>')
+ * .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);
}
- this._contentNode.appendChild(this._content);
}
- this.fire('contentupdate');
+ },
+
+ 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';
+ 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;
+ }
+});
+
+
+
+/*
+ * @namespace Layer
+ * @section Popup methods example
+ *
+ * All layers share a set of methods convenient for binding popups to it.
+ *
+ * ```js
+ * var layer = L.Polygon(latlngs).bindPopup('Hi There!').addTo(map);
+ * layer.openPopup();
+ * layer.closePopup();
+ * ```
+ *
+ * Popups will also be automatically opened when the layer is clicked on and closed when the layer is removed from the map or another popup is opened.
+ */
+
+// @section Popup methods
+L.Layer.include({
+
+ // @method bindPopup(content: String|HTMLElement|Function|Popup, options?: Popup options): this
+ // Binds a popup to the layer with the passed `content` and sets up the
+ // neccessary event listeners. If a `Function` is passed it will receive
+ // the layer as the first argument and should return a `String` or `HTMLElement`.
+ bindPopup: function (content, options) {
+
+ if (content instanceof L.Popup) {
+ L.setOptions(content, options);
+ this._popup = content;
+ content._source = this;
+ } else {
+ if (!this._popup || options) {
+ this._popup = new L.Popup(options, this);
+ }
+ this._popup.setContent(content);
+ }
+
+ if (!this._popupHandlersAdded) {
+ this.on({
+ click: this._openPopup,
+ remove: this.closePopup,
+ move: this._movePopup
+ });
+ this._popupHandlersAdded = true;
+ }
+
+ return this;
+ },
+
+ // @method unbindPopup(): this
+ // Removes the popup previously bound with `bindPopup`.
+ unbindPopup: function () {
+ if (this._popup) {
+ this.off({
+ click: this._openPopup,
+ remove: this.closePopup,
+ move: this._movePopup
+ });
+ this._popupHandlersAdded = false;
+ this._popup = null;
+ }
+ return this;
+ },
+
+ // @method openPopup(latlng?: LatLng): this
+ // Opens the bound popup at the specificed `latlng` or at the default popup anchor if no `latlng` is passed.
+ openPopup: function (layer, latlng) {
+ if (!(layer instanceof L.Layer)) {
+ latlng = layer;
+ layer = this;
+ }
+
+ if (layer instanceof L.FeatureGroup) {
+ for (var id in this._layers) {
+ layer = this._layers[id];
+ break;
+ }
+ }
+
+ if (!latlng) {
+ latlng = layer.getCenter ? layer.getCenter() : layer.getLatLng();
+ }
+
+ if (this._popup && this._map) {
+ // set popup source to this layer
+ this._popup._source = layer;
+
+ // update the popup (content, layout, ect...)
+ this._popup.update();
+
+ // open the popup on the map
+ this._map.openPopup(this._popup, latlng);
+ }
+
+ return this;
+ },
+
+ // @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 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;
+ },
+
+ // @method isPopupOpen(): boolean
+ // Returns `true` if the popup bound to this layer is currently open.
+ isPopupOpen: function () {
+ return this._popup.isOpen();
+ },
+
+ // @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 getPopup(): Popup
+ // Returns the popup bound to this layer.
+ getPopup: function () {
+ return this._popup;
+ },
+
+ _openPopup: function (e) {
+ var layer = e.layer || e.target;
+
+ if (!this._popup) {
+ return;
+ }
+
+ 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;
+ }
+
+ // otherwise treat it like a marker and figure out
+ // if we should toggle it open/closed
+ if (this._map.hasLayer(this._popup) && this._popup._source === layer) {
+ this.closePopup();
+ } else {
+ this.openPopup(layer, e.latlng);
+ }
+ },
+
+ _movePopup: function (e) {
+ this._popup.setLatLng(e.latlng);
+ }
+});
+
+
+
+/*
+ * Popup extension to L.Marker, adding popup-related methods.
+ */
+
+L.Marker.include({
+ _getPopupAnchor: function () {
+ return this.options.icon.options.popupAnchor || [0, 0];
+ }
+});
+
+
+
+/*
+ * @class Tooltip
+ * @inherits DivOverlay
+ * @aka L.Tooltip
+ * Used to display small texts on top of map layers.
+ *
+ * @example
+ *
+ * ```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.
+ */
+
+
+// @namespace Tooltip
+L.Tooltip = L.DivOverlay.extend({
+
+ // @section
+ // @aka Tooltip options
+ options: {
+ // @option pane: String = 'tooltipPane'
+ // `Map pane` where the tooltip will be added.
+ pane: 'tooltipPane',
+
+ // @option offset: Point = Point(0, 0)
+ // Optional offset of the tooltip position.
+ offset: [0, 0],
+
+ // @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',
- var width = container.offsetWidth;
- width = Math.min(width, this.options.maxWidth);
- width = Math.max(width, this.options.minWidth);
+ // @option permanent: Boolean = false
+ // Whether to open the tooltip permanently or only on mouseover.
+ permanent: false,
- style.width = (width + 1) + 'px';
- style.whiteSpace = '';
+ // @option sticky: Boolean = false
+ // If true, the tooltip will follow the mouse instead of being fixed at the feature center.
+ sticky: false,
- style.height = '';
+ // @option interactive: Boolean = false
+ // If true, the tooltip will listen to the feature events.
+ interactive: false,
- var height = container.offsetHeight,
- maxHeight = this.options.maxHeight,
- scrolledClass = 'leaflet-popup-scrolled';
+ // @option opacity: Number = 0.9
+ // Tooltip container opacity.
+ opacity: 0.9
+ },
- if (maxHeight && height > maxHeight) {
- style.height = maxHeight + 'px';
- L.DomUtil.addClass(container, scrolledClass);
- } else {
- L.DomUtil.removeClass(container, scrolledClass);
- }
+ onAdd: function (map) {
+ L.DivOverlay.prototype.onAdd.call(this, map);
+ this.setOpacity(this.options.opacity);
- this._containerWidth = this._container.offsetWidth;
+ // @namespace Map
+ // @section Tooltip events
+ // @event tooltipopen: TooltipEvent
+ // Fired when a tooltip is opened in the map.
+ map.fire('tooltipopen', {tooltip: this});
+
+ if (this._source) {
+ // @namespace Layer
+ // @section Tooltip events
+ // @event tooltipopen: TooltipEvent
+ // Fired when a tooltip bound to this layer is opened.
+ this._source.fire('tooltipopen', {tooltip: this}, true);
+ }
},
- _updatePosition: function () {
- if (!this._map) { return; }
+ onRemove: function (map) {
+ L.DivOverlay.prototype.onRemove.call(this, map);
- var pos = this._map.latLngToLayerPoint(this._latlng),
- animated = this._animated,
- offset = L.point(this.options.offset);
+ // @namespace Map
+ // @section Tooltip events
+ // @event tooltipclose: TooltipEvent
+ // Fired when a tooltip in the map is closed.
+ map.fire('tooltipclose', {tooltip: this});
- if (animated) {
- L.DomUtil.setPosition(this._container, pos);
+ 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);
}
+ },
- this._containerBottom = -offset.y - (animated ? 0 : pos.y);
- this._containerLeft = -Math.round(this._containerWidth / 2) + offset.x + (animated ? 0 : pos.x);
+ getEvents: function () {
+ var events = L.DivOverlay.prototype.getEvents.call(this);
- // bottom position the popup in case the height of the popup changes (images loading etc)
- this._container.style.bottom = this._containerBottom + 'px';
- this._container.style.left = this._containerLeft + 'px';
+ if (L.Browser.touch && !this.options.permanent) {
+ events.preclick = this._close;
+ }
+
+ return events;
+ },
+
+ _close: function () {
+ if (this._map) {
+ this._map.closeTooltip(this);
+ }
},
- _zoomAnimation: function (opt) {
- var pos = this._map._latLngToNewLayerPoint(this._latlng, opt.zoom, opt.center);
+ _initLayout: function () {
+ var prefix = 'leaflet-tooltip',
+ className = prefix + ' ' + (this.options.className || '') + ' leaflet-zoom-' + (this._zoomAnimated ? 'animated' : 'hide');
- L.DomUtil.setPosition(this._container, pos);
+ this._contentNode = this._container = L.DomUtil.create('div', className);
},
- _adjustPan: function () {
- if (!this.options.autoPan) { return; }
+ _updateLayout: function () {},
+
+ _adjustPan: function () {},
+ _setPosition: function (pos) {
var map = this._map,
- containerHeight = this._container.offsetHeight,
- containerWidth = this._containerWidth,
+ container = this._container,
+ centerPoint = map.latLngToContainerPoint(map.getCenter()),
+ tooltipPoint = map.layerPointToContainerPoint(pos),
+ direction = this.options.direction,
+ tooltipWidth = container.offsetWidth,
+ tooltipHeight = container.offsetHeight,
+ offset = L.point(this.options.offset),
+ anchor = this._getAnchor();
+
+ if (direction === 'top') {
+ pos = pos.add(L.point(-tooltipWidth / 2 + offset.x, -tooltipHeight + offset.y + anchor.y));
+ } 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));
+ }
- layerPos = new L.Point(this._containerLeft, -containerHeight - this._containerBottom);
+ 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);
+ },
- if (this._animated) {
- layerPos._add(L.DomUtil.getPosition(this._container));
- }
+ _updatePosition: function () {
+ var pos = this._map.latLngToLayerPoint(this._latlng);
+ this._setPosition(pos);
+ },
- 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;
+ setOpacity: function (opacity) {
+ this.options.opacity = opacity;
- 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;
+ if (this._container) {
+ L.DomUtil.setOpacity(this._container, opacity);
}
+ },
- if (dx || dy) {
- map
- .fire('autopanstart')
- .panBy([dx, dy]);
- }
+ _animateZoom: function (e) {
+ var pos = this._map._latLngToNewLayerPoint(this._latlng, e.zoom, e.center);
+ this._setPosition(pos);
},
- _onCloseButtonClick: function (e) {
- this._close();
- L.DomEvent.stop(e);
+ _getAnchor: function () {
+ // Where should we anchor the tooltip on the source layer?
+ return L.point(this._source && this._source._getTooltipAnchor && !this.options.sticky ? this._source._getTooltipAnchor() : [0, 0]);
}
+
});
-L.popup = function (options, source) {
- return new L.Popup(options, source);
+// @namespace Tooltip
+// @factory L.tooltip(options?: Tooltip options, source?: Layer)
+// Instantiates a Tooltip object given an optional `options` object that describes its appearance and location and an optional `source` object that is used to tag the tooltip with a reference to the Layer to which it refers.
+L.tooltip = function (options, source) {
+ return new L.Tooltip(options, source);
};
-
+// @namespace Map
+// @section Methods for Layers and Controls
L.Map.include({
- openPopup: function (popup, latlng, options) { // (Popup) or (String || HTMLElement, LatLng[, Object])
- this.closePopup();
- if (!(popup instanceof L.Popup)) {
- var content = popup;
+ // @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);
+ }
- popup = new L.Popup(options)
- .setLatLng(latlng)
- .setContent(content);
+ if (latlng) {
+ tooltip.setLatLng(latlng);
}
- popup._isOpen = true;
- this._popup = popup;
- return this.addLayer(popup);
+ if (this.hasLayer(tooltip)) {
+ return this;
+ }
+
+ return this.addLayer(tooltip);
},
- closePopup: function (popup) {
- if (!popup || popup === this._popup) {
- popup = this._popup;
- this._popup = null;
- }
- if (popup) {
- this.removeLayer(popup);
- popup._isOpen = false;
+ // @method closeTooltip(tooltip?: Tooltip): this
+ // Closes the tooltip given as parameter.
+ closeTooltip: function (tooltip) {
+ if (tooltip) {
+ this.removeLayer(tooltip);
}
return this;
}
+
});
+
/*
- * Popup extension to L.Marker, adding popup-related methods.
+ * @namespace Layer
+ * @section Tooltip methods example
+ *
+ * All layers share a set of methods convenient for binding tooltips to it.
+ *
+ * ```js
+ * var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map);
+ * layer.openTooltip();
+ * layer.closeTooltip();
+ * ```
*/
-L.Marker.include({
- openPopup: function () {
- if (this._popup && this._map && !this._map.hasLayer(this._popup)) {
- this._popup.setLatLng(this._latlng);
- this._map.openPopup(this._popup);
+// @section Tooltip methods
+L.Layer.include({
+
+ // @method bindTooltip(content: String|HTMLElement|Function|Tooltip, options?: Tooltip options): this
+ // Binds a tooltip to the layer with the passed `content` and sets up the
+ // 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) {
+
+ 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);
+
+ }
+
+ this._initTooltipInteractions();
+
+ if (this._tooltip.options.permanent && this._map && this._map.hasLayer(this)) {
+ this.openTooltip();
}
return this;
},
- closePopup: function () {
- if (this._popup) {
- this._popup._close();
+ // @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;
},
- togglePopup: function () {
- if (this._popup) {
- if (this._popup._isOpen) {
- this.closePopup();
- } else {
- this.openPopup();
+ _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;
}
- return this;
+ this[onOff](events);
+ this._tooltipHandlersAdded = !remove;
},
- bindPopup: function (content, options) {
- var anchor = L.point(this.options.icon.options.popupAnchor || [0, 0]);
+ // @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;
+ }
- anchor = anchor.add(L.Popup.prototype.options.offset);
+ if (layer instanceof L.FeatureGroup) {
+ for (var id in this._layers) {
+ layer = this._layers[id];
+ break;
+ }
+ }
- if (options && options.offset) {
- anchor = anchor.add(options.offset);
+ if (!latlng) {
+ latlng = layer.getCenter ? layer.getCenter() : layer.getLatLng();
}
- options = L.extend({offset: anchor}, options);
+ if (this._tooltip && this._map) {
- if (!this._popupHandlersAdded) {
- this
- .on('click', this.togglePopup, this)
- .on('remove', this.closePopup, this)
- .on('move', this._movePopup, this);
- this._popupHandlersAdded = true;
- }
+ // set tooltip source to this layer
+ this._tooltip._source = layer;
- if (content instanceof L.Popup) {
- L.setOptions(content, options);
- this._popup = content;
- content._source = this;
- } else {
- this._popup = new L.Popup(options, this)
- .setContent(content);
+ // update the tooltip (content, layout, ect...)
+ this._tooltip.update();
+
+ // open the tooltip on the map
+ this._map.openTooltip(this._tooltip, latlng);
+
+ // 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);
+ }
}
return this;
},
- setPopupContent: function (content) {
- if (this._popup) {
- this._popup.setContent(content);
+ // @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;
},
- unbindPopup: function () {
- if (this._popup) {
- this._popup = null;
- this
- .off('click', this.togglePopup, this)
- .off('remove', this.closePopup, this)
- .off('move', this._movePopup, this);
- this._popupHandlersAdded = false;
+ // @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;
},
- getPopup: function () {
- return this._popup;
+ // @method isTooltipOpen(): boolean
+ // Returns `true` if the tooltip bound to this layer is currently open.
+ isTooltipOpen: function () {
+ return this._tooltip.isOpen();
},
- _movePopup: function (e) {
- this._popup.setLatLng(e.latlng);
+ // @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 getTooltip(): Tooltip
+ // Returns the tooltip bound to this layer.
+ getTooltip: function () {
+ return this._tooltip;
+ },
+
+ _openTooltip: function (e) {
+ var layer = e.layer || e.target;
+
+ if (!this._tooltip || !this._map) {
+ return;
+ }
+ this.openTooltip(layer, this._tooltip.options.sticky ? e.latlng : undefined);
+ },
+
+ _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);
+ }
+});
+
+
+
+/*
+ * Tooltip extension to L.Marker, adding tooltip-related methods.
+ */
+
+L.Marker.include({
+ _getTooltipAnchor: function () {
+ return this.options.icon.options.tooltipAnchor || [0, 0];
}
});
+
/*
- * L.LayerGroup is a class to combine several layers into one so that
- * you can manipulate the group (e.g. add/remove it) as one layer.
+ * @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.Class.extend({
+L.LayerGroup = L.Layer.extend({
+
initialize: function (layers) {
this._layers = {};
}
},
+ // @method addLayer(layer: Layer): this
+ // Adds the given layer to the group.
addLayer: function (layer) {
var id = this.getLayerId(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);
return this;
},
+ // @method hasLayer(layer: Layer): Boolean
+ // Returns `true` if the given layer is currently added to the group.
hasLayer: function (layer) {
- if (!layer) { return false; }
-
- return (layer in this._layers || this.getLayerId(layer) in this._layers);
+ return !!layer && (layer in this._layers || this.getLayerId(layer) in this._layers);
},
+ // @method clearLayers(): this
+ // Removes all the layers from the group.
clearLayers: function () {
- this.eachLayer(this.removeLayer, this);
+ 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;
},
onAdd: function (map) {
- this._map = map;
- this.eachLayer(map.addLayer, map);
+ for (var i in this._layers) {
+ map.addLayer(this._layers[i]);
+ }
},
onRemove: function (map) {
- this.eachLayer(map.removeLayer, map);
- this._map = null;
- },
-
- addTo: function (map) {
- map.addLayer(this);
- return this;
+ 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 = [];
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);
};
+
/*
- * L.FeatureGroup extends L.LayerGroup by introducing mouse events and additional methods
- * shared between a group of interactive layers (like vectors or markers).
+ * @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({
- includes: L.Mixin.Events,
-
- statics: {
- EVENTS: 'click dblclick mouseover mouseout mousemove contextmenu popupopen popupclose'
- },
addLayer: function (layer) {
if (this.hasLayer(layer)) {
return this;
}
- if ('on' in layer) {
- layer.on(L.FeatureGroup.EVENTS, this._propagateEvent, this);
- }
+ layer.addEventParent(this);
L.LayerGroup.prototype.addLayer.call(this, layer);
- if (this._popupContent && layer.bindPopup) {
- layer.bindPopup(this._popupContent, this._popupOptions);
- }
-
+ // @event layeradd: LayerEvent
+ // Fired when a layer is added to this `FeatureGroup`
return this.fire('layeradd', {layer: layer});
},
layer = this._layers[layer];
}
- if ('off' in layer) {
- layer.off(L.FeatureGroup.EVENTS, this._propagateEvent, this);
- }
+ layer.removeEventParent(this);
L.LayerGroup.prototype.removeLayer.call(this, layer);
- if (this._popupContent) {
- this.invoke('unbindPopup');
+ // @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);
+};
+
+
+
+/*
+ * @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
+ */
+
+L.Renderer = L.Layer.extend({
+
+ // @section
+ // @aka Renderer options
+ options: {
+ // @option padding: Number = 0.1
+ // How much to extend the clip area around the map view (relative to its size)
+ // e.g. 0.1 would be 10% of map view in each direction
+ padding: 0.1
+ },
+
+ initialize: function (options) {
+ L.setOptions(this, options);
+ L.stamp(this);
+ },
+
+ onAdd: function () {
+ if (!this._container) {
+ this._initContainer(); // defined by renderer implementations
+
+ if (this._zoomAnimated) {
+ L.DomUtil.addClass(this._container, 'leaflet-zoom-animated');
+ }
+ }
+
+ this.getPane().appendChild(this._container);
+ this._update();
+ },
+
+ onRemove: function () {
+ L.DomUtil.remove(this._container);
+ },
+
+ getEvents: function () {
+ var events = {
+ viewreset: this._reset,
+ zoom: this._onZoom,
+ moveend: this._update
+ };
+ if (this._zoomAnimated) {
+ events.zoomanim = this._onAnimZoom;
}
+ return events;
+ },
- return this.fire('layerremove', {layer: layer});
+ _onAnimZoom: function (ev) {
+ this._updateTransform(ev.center, ev.zoom);
},
- bindPopup: function (content, options) {
- this._popupContent = content;
- this._popupOptions = options;
- return this.invoke('bindPopup', content, options);
+ _onZoom: function () {
+ this._updateTransform(this._map.getCenter(), this._map.getZoom());
},
- openPopup: function (latlng) {
- // open popup on the first layer
- for (var id in this._layers) {
- this._layers[id].openPopup(latlng);
- break;
+ _updateTransform: function (center, zoom) {
+ var scale = this._map.getZoomScale(zoom, this._zoom),
+ position = L.DomUtil.getPosition(this._container),
+ viewHalf = this._map.getSize().multiplyBy(0.5 + this.options.padding),
+ currentCenterPoint = this._map.project(this._center, zoom),
+ destCenterPoint = this._map.project(center, zoom),
+ centerOffset = destCenterPoint.subtract(currentCenterPoint),
+
+ topLeftOffset = viewHalf.multiplyBy(-scale).add(position).add(viewHalf).subtract(centerOffset);
+
+ if (L.Browser.any3d) {
+ L.DomUtil.setTransform(this._container, topLeftOffset, scale);
+ } else {
+ L.DomUtil.setPosition(this._container, topLeftOffset);
}
- return this;
},
- setStyle: function (style) {
- return this.invoke('setStyle', style);
+ _reset: function () {
+ this._update();
+ this._updateTransform(this._center, this._zoom);
},
- bringToFront: function () {
- return this.invoke('bringToFront');
- },
+ _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();
- bringToBack: function () {
- return this.invoke('bringToBack');
- },
+ this._bounds = new L.Bounds(min, min.add(size.multiplyBy(1 + p * 2)).round());
- getBounds: function () {
- var bounds = new L.LatLngBounds();
+ this._center = this._map.getCenter();
+ this._zoom = this._map.getZoom();
+ }
+});
- this.eachLayer(function (layer) {
- bounds.extend(layer instanceof L.Marker ? layer.getLatLng() : layer.getBounds());
- });
- return bounds;
+L.Map.include({
+ // @namespace Map; @method getRenderer(layer: Path): Renderer
+ // Returns the instance of `Renderer` that should be used to render the given
+ // `Path`. It will ensure that the `renderer` options of the map and paths
+ // are respected, and that the renderers do exist on the map.
+ getRenderer: function (layer) {
+ // @namespace Path; @option renderer: Renderer
+ // Use this specific instance of `Renderer` for this path. Takes
+ // precedence over the map's [default renderer](#map-renderer).
+ var renderer = layer.options.renderer || this._getPaneRenderer(layer.options.pane) || this.options.renderer || this._renderer;
+
+ if (!renderer) {
+ // @namespace Map; @option preferCanvas: Boolean = false
+ // Whether `Path`s should be rendered on a `Canvas` renderer.
+ // By default, all `Path`s are rendered in a `SVG` renderer.
+ renderer = this._renderer = (this.options.preferCanvas && L.canvas()) || L.svg();
+ }
+
+ if (!this.hasLayer(renderer)) {
+ this.addLayer(renderer);
+ }
+ return renderer;
},
- _propagateEvent: function (e) {
- e = L.extend({
- layer: e.target,
- target: this
- }, e);
- this.fire(e.type, e);
+ _getPaneRenderer: function (name) {
+ if (name === 'overlayPane' || name === undefined) {
+ return false;
+ }
+
+ var renderer = this._paneRenderers[name];
+ if (renderer === undefined) {
+ renderer = (L.SVG && L.svg({pane: name})) || (L.Canvas && L.canvas({pane: name}));
+ this._paneRenderers[name] = renderer;
+ }
+ return renderer;
}
});
-L.featureGroup = function (layers) {
- return new L.FeatureGroup(layers);
-};
/*
- * L.Path is a base class for rendering vector paths on a map. Inherited by Polyline, Circle, etc.
+ * @class Path
+ * @aka L.Path
+ * @inherits Interactive layer
+ *
+ * An abstract class that contains options and constants shared between vector
+ * overlays (Polygon, Polyline, Circle). Do not use it directly. Extends `Layer`.
*/
-L.Path = L.Class.extend({
- includes: [L.Mixin.Events],
-
- statics: {
- // how much to extend the clip area around the map view
- // (relative to its size, e.g. 0.5 is half the screen in each direction)
- // set it so that SVG element doesn't exceed 1280px (vectors flicker on dragend if it is)
- CLIP_PADDING: (function () {
- var max = L.Browser.mobile ? 1280 : 2000,
- target = (max / Math.max(window.outerWidth, window.outerHeight) - 1) / 2;
- return Math.max(0, Math.min(0.5, target));
- })()
- },
+L.Path = L.Layer.extend({
+ // @section
+ // @aka Path options
options: {
+ // @option stroke: Boolean = true
+ // Whether to draw stroke along the path. Set it to `false` to disable borders on polygons or circles.
stroke: true,
- color: '#0033ff',
- dashArray: null,
- lineCap: null,
- lineJoin: null,
- weight: 5,
- opacity: 0.5,
- fill: false,
- fillColor: null, //same as color by default
- fillOpacity: 0.2,
+ // @option color: String = '#3388ff'
+ // Stroke color
+ color: '#3388ff',
- clickable: true
- },
+ // @option weight: Number = 3
+ // Stroke width in pixels
+ weight: 3,
- initialize: function (options) {
- L.setOptions(this, options);
- },
+ // @option opacity: Number = 1.0
+ // Stroke opacity
+ opacity: 1,
- onAdd: function (map) {
- this._map = map;
+ // @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 (!this._container) {
- this._initElements();
- this._initEvents();
- }
+ // @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',
- this.projectLatlngs();
- this._updatePath();
+ // @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,
- if (this._container) {
- this._map._pathRoot.appendChild(this._container);
- }
+ // @option dashOffset: String = null
+ // A string that defines the [distance into the dash pattern to start the dash](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset). Doesn't work on `Canvas`-powered layers in [some old browsers](https://developer.mozilla.org/docs/Web/API/CanvasRenderingContext2D/setLineDash#Browser_compatibility).
+ dashOffset: null,
- this.fire('add');
+ // @option fill: Boolean = depends
+ // Whether to fill the path with color. Set it to `false` to disable filling on polygons or circles.
+ fill: false,
- map.on({
- 'viewreset': this.projectLatlngs,
- 'moveend': this._updatePath
- }, this);
- },
+ // @option fillColor: String = *
+ // Fill color. Defaults to the value of the [`color`](#path-color) option
+ fillColor: null,
- addTo: function (map) {
- map.addLayer(this);
- return this;
+ // @option fillOpacity: Number = 0.2
+ // Fill opacity.
+ fillOpacity: 0.2,
+
+ // @option fillRule: String = 'evenodd'
+ // A string that defines [how the inside of a shape](https://developer.mozilla.org/docs/Web/SVG/Attribute/fill-rule) is determined.
+ fillRule: 'evenodd',
+
+ // className: '',
+
+ // Option inherited from "Interactive layer" abstract class
+ interactive: true
},
- onRemove: function (map) {
- map._pathRoot.removeChild(this._container);
+ beforeAdd: function (map) {
+ // Renderer is set here because we need to call renderer.getEvents
+ // before this.getEvents.
+ this._renderer = map.getRenderer(this);
+ },
- // Need to fire remove event before we set _map to null as the event hooks might need the object
- this.fire('remove');
- this._map = null;
+ onAdd: function () {
+ this._renderer._initPath(this);
+ this._reset();
+ this._renderer._addPath(this);
+ this._renderer.on('update', this._update, this);
+ },
- if (L.Browser.vml) {
- this._container = null;
- this._stroke = null;
- this._fill = null;
- }
+ onRemove: function () {
+ this._renderer._removePath(this);
+ this._renderer.off('update', this._update, this);
+ },
- map.off({
- 'viewreset': this.projectLatlngs,
- 'moveend': this._updatePath
- }, this);
+ getEvents: function () {
+ return {
+ zoomend: this._project,
+ viewreset: this._reset
+ };
},
- projectLatlngs: function () {
- // do all projection stuff here
+ // @method redraw(): this
+ // Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.
+ redraw: function () {
+ if (this._map) {
+ this._renderer._updatePath(this);
+ }
+ return this;
},
+ // @method setStyle(style: Path options): this
+ // Changes the appearance of a Path based on the options in the `Path options` object.
setStyle: function (style) {
L.setOptions(this, style);
-
- if (this._container) {
- this._updateStyle();
+ if (this._renderer) {
+ this._renderer._updateStyle(this);
}
+ return this;
+ },
+ // @method bringToFront(): this
+ // Brings the layer to the top of all path layers.
+ bringToFront: function () {
+ if (this._renderer) {
+ this._renderer._bringToFront(this);
+ }
return this;
},
- redraw: function () {
- if (this._map) {
- this.projectLatlngs();
- this._updatePath();
+ // @method bringToBack(): this
+ // Brings the layer to the bottom of all path layers.
+ bringToBack: function () {
+ if (this._renderer) {
+ this._renderer._bringToBack(this);
}
return this;
- }
-});
+ },
-L.Map.include({
- _updatePathViewport: function () {
- var p = L.Path.CLIP_PADDING,
- size = this.getSize(),
- panePos = L.DomUtil.getPosition(this._mapPane),
- min = panePos.multiplyBy(-1)._subtract(size.multiplyBy(p)._round()),
- max = min.add(size.multiplyBy(1 + p * 2)._round());
+ getElement: function () {
+ return this._path;
+ },
+
+ _reset: function () {
+ // defined in children classes
+ this._project();
+ this._update();
+ },
- this._pathViewport = new L.Bounds(min, max);
+ _clickTolerance: function () {
+ // used when doing hit detection for Canvas layers
+ return (this.options.stroke ? this.options.weight / 2 : 0) + (L.Browser.touch ? 10 : 0);
}
});
+
/*
- * Extends L.Path with SVG-specific rendering code.
+ * @namespace LineUtil
+ *
+ * Various utility functions for polyine points processing, used by Leaflet internally to make polylines lightning-fast.
*/
-L.Path.SVG_NS = 'http://www.w3.org/2000/svg';
+L.LineUtil = {
-L.Browser.svg = !!(document.createElementNS && document.createElementNS(L.Path.SVG_NS, 'svg').createSVGRect);
+ // Simplify polyline with vertex reduction and Douglas-Peucker simplification.
+ // Improves rendering performance dramatically by lessening the number of points to draw.
-L.Path = L.Path.extend({
- statics: {
- SVG: L.Browser.svg
- },
+ // @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();
+ }
- bringToFront: function () {
- var root = this._map._pathRoot,
- path = this._container;
+ var sqTolerance = tolerance * tolerance;
- if (path && root.lastChild !== path) {
- root.appendChild(path);
- }
- return this;
- },
+ // stage 1: vertex reduction
+ points = this._reducePoints(points, sqTolerance);
- bringToBack: function () {
- var root = this._map._pathRoot,
- path = this._container,
- first = root.firstChild;
+ // stage 2: Douglas-Peucker simplification
+ points = this._simplifyDP(points, sqTolerance);
- if (path && first !== path) {
- root.insertBefore(path, first);
- }
- return this;
+ return points;
},
- getPathString: function () {
- // form path string here
+ // @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));
},
- _createElement: function (name) {
- return document.createElementNS(L.Path.SVG_NS, name);
+ // @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);
},
- _initElements: function () {
- this._map._initPathRoot();
- this._initPath();
- this._initStyle();
- },
+ // 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);
- _initPath: function () {
- this._container = this._createElement('g');
+ markers[0] = markers[len - 1] = 1;
+
+ this._simplifyDPStep(points, markers, sqTolerance, 0, len - 1);
- this._path = this._createElement('path');
+ var i,
+ newPoints = [];
- if (this.options.className) {
- L.DomUtil.addClass(this._path, this.options.className);
+ for (i = 0; i < len; i++) {
+ if (markers[i]) {
+ newPoints.push(points[i]);
+ }
}
- this._container.appendChild(this._path);
+ return newPoints;
},
- _initStyle: function () {
- if (this.options.stroke) {
- this._path.setAttribute('stroke-linejoin', 'round');
- this._path.setAttribute('stroke-linecap', 'round');
+ _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 (this.options.fill) {
- this._path.setAttribute('fill-rule', 'evenodd');
+
+ if (maxSqDist > sqTolerance) {
+ markers[index] = 1;
+
+ this._simplifyDPStep(points, markers, sqTolerance, first, index);
+ this._simplifyDPStep(points, markers, sqTolerance, index, last);
}
- if (this.options.pointerEvents) {
- this._path.setAttribute('pointer-events', this.options.pointerEvents);
+ },
+
+ // 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 (!this.options.clickable && !this.options.pointerEvents) {
- this._path.setAttribute('pointer-events', 'none');
+ if (prev < len - 1) {
+ reducedPoints.push(points[len - 1]);
}
- this._updateStyle();
+ return reducedPoints;
},
- _updateStyle: function () {
- if (this.options.stroke) {
- this._path.setAttribute('stroke', this.options.color);
- this._path.setAttribute('stroke-opacity', this.options.opacity);
- this._path.setAttribute('stroke-width', this.options.weight);
- if (this.options.dashArray) {
- this._path.setAttribute('stroke-dasharray', this.options.dashArray);
- } else {
- this._path.removeAttribute('stroke-dasharray');
+
+ // @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 (this.options.lineCap) {
- this._path.setAttribute('stroke-linecap', this.options.lineCap);
+
+ // if a,b is outside the clip window (trivial reject)
+ if (codeA & codeB) {
+ return false;
}
- if (this.options.lineJoin) {
- this._path.setAttribute('stroke-linejoin', this.options.lineJoin);
+
+ // 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;
}
- } else {
- this._path.setAttribute('stroke', 'none');
- }
- if (this.options.fill) {
- this._path.setAttribute('fill', this.options.fillColor || this.options.color);
- this._path.setAttribute('fill-opacity', this.options.fillOpacity);
- } else {
- this._path.setAttribute('fill', 'none');
}
},
- _updatePath: function () {
- var str = this.getPathString();
- if (!str) {
- // fix webkit empty string parsing bug
- str = 'M0 0';
+ _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;
}
- this._path.setAttribute('d', str);
+
+ return new L.Point(x, y, round);
},
- // TODO remove duplication with L.Map
- _initEvents: function () {
- if (this.options.clickable) {
- if (L.Browser.svg || !L.Browser.vml) {
- L.DomUtil.addClass(this._path, 'leaflet-clickable');
- }
+ _getBitCode: function (p, bounds) {
+ var code = 0;
- L.DomEvent.on(this._container, 'click', this._onMouseClick, this);
+ if (p.x < bounds.min.x) { // left
+ code |= 1;
+ } else if (p.x > bounds.max.x) { // right
+ code |= 2;
+ }
- var events = ['dblclick', 'mousedown', 'mouseover',
- 'mouseout', 'mousemove', 'contextmenu'];
- for (var i = 0; i < events.length; i++) {
- L.DomEvent.on(this._container, events[i], this._fireMouseEvent, this);
- }
+ if (p.y < bounds.min.y) { // bottom
+ code |= 4;
+ } else if (p.y > bounds.max.y) { // top
+ code |= 8;
}
- },
- _onMouseClick: function (e) {
- if (this._map.dragging && this._map.dragging.moved()) { return; }
+ return code;
+ },
- this._fireMouseEvent(e);
+ // 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;
},
- _fireMouseEvent: function (e) {
- if (!this._map || !this.hasEventListeners(e.type)) { return; }
+ // 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;
- var map = this._map,
- containerPoint = map.mouseEventToContainerPoint(e),
- layerPoint = map.containerPointToLayerPoint(containerPoint),
- latlng = map.layerPointToLatLng(layerPoint);
+ return sqDist ? dx * dx + dy * dy : new L.Point(x, y);
+ }
+};
- this.fire(e.type, {
- latlng: latlng,
- layerPoint: layerPoint,
- containerPoint: containerPoint,
- originalEvent: e
- });
- if (e.type === 'contextmenu') {
- L.DomEvent.preventDefault(e);
- }
- if (e.type !== 'mousemove') {
- L.DomEvent.stopPropagation(e);
- }
- }
-});
-L.Map.include({
- _initPathRoot: function () {
- if (!this._pathRoot) {
- this._pathRoot = L.Path.prototype._createElement('svg');
- this._panes.overlayPane.appendChild(this._pathRoot);
+/*
+ * @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]]
+ * ];
+ * ```
+ */
- if (this.options.zoomAnimation && L.Browser.any3d) {
- L.DomUtil.addClass(this._pathRoot, 'leaflet-zoom-animated');
+L.Polyline = L.Path.extend({
- this.on({
- 'zoomanim': this._animatePathZoom,
- 'zoomend': this._endPathZoom
- });
- } else {
- L.DomUtil.addClass(this._pathRoot, 'leaflet-zoom-hide');
- }
+ // @section
+ // @aka Polyline options
+ options: {
+ // @option smoothFactor: Number = 1.0
+ // How much to simplify the polyline on each zoom level. More means
+ // better performance and smoother look, and less means more accurate representation.
+ smoothFactor: 1.0,
- this.on('moveend', this._updateSvgViewport);
- this._updateSvgViewport();
- }
+ // @option noClip: Boolean = false
+ // Disable polyline clipping.
+ noClip: false
},
- _animatePathZoom: function (e) {
- var scale = this.getZoomScale(e.zoom),
- offset = this._getCenterOffset(e.center)._multiplyBy(-scale)._add(this._pathViewport.min);
+ initialize: function (latlngs, options) {
+ L.setOptions(this, options);
+ this._setLatLngs(latlngs);
+ },
- this._pathRoot.style[L.DomUtil.TRANSFORM] =
- L.DomUtil.getTranslateString(offset) + ' scale(' + scale + ') ';
+ // @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;
+ },
- this._pathZooming = true;
+ // @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();
},
- _endPathZoom: function () {
- this._pathZooming = false;
+ // @method isEmpty(): Boolean
+ // Returns `true` if the Polyline has no LatLngs.
+ isEmpty: function () {
+ return !this._latlngs.length;
},
- _updateSvgViewport: function () {
+ closestLayerPoint: function (p) {
+ var minDistance = Infinity,
+ minPoint = null,
+ closest = L.LineUtil._sqClosestPointOnSegment,
+ p1, p2;
- if (this._pathZooming) {
- // Do not update SVGs while a zoom animation is going on otherwise the animation will break.
- // When the zoom animation ends we will be updated again anyway
- // This fixes the case where you do a momentum move and zoom while the move is still ongoing.
- return;
- }
+ for (var j = 0, jLen = this._parts.length; j < jLen; j++) {
+ var points = this._parts[j];
- this._updatePathViewport();
+ for (var i = 1, len = points.length; i < len; i++) {
+ p1 = points[i - 1];
+ p2 = points[i];
- var vp = this._pathViewport,
- min = vp.min,
- max = vp.max,
- width = max.x - min.x,
- height = max.y - min.y,
- root = this._pathRoot,
- pane = this._panes.overlayPane;
+ var sqDist = closest(p, p1, p2, true);
- // Hack to make flicker on drag end on mobile webkit less irritating
- if (L.Browser.mobileWebkit) {
- pane.removeChild(root);
+ if (sqDist < minDistance) {
+ minDistance = sqDist;
+ minPoint = closest(p, p1, p2);
+ }
+ }
}
+ if (minPoint) {
+ minPoint.distance = Math.sqrt(minDistance);
+ }
+ return minPoint;
+ },
- L.DomUtil.setPosition(root, min);
- root.setAttribute('width', width);
- root.setAttribute('height', height);
- root.setAttribute('viewBox', [min.x, min.y, width, height].join(' '));
-
- if (L.Browser.mobileWebkit) {
- pane.appendChild(root);
+ // @method getCenter(): LatLng
+ // Returns the center ([centroid](http://en.wikipedia.org/wiki/Centroid)) of the polyline.
+ getCenter: function () {
+ // throws error when not yet added to map as this center calculation requires projected coordinates
+ if (!this._map) {
+ throw new Error('Must add layer to map before using getCenter()');
}
- }
-});
+ var i, halfDist, segDist, dist, p1, p2, ratio,
+ points = this._rings[0],
+ len = points.length;
-/*
- * Popup extension to L.Path (polylines, polygons, circles), adding popup-related methods.
- */
+ if (!len) { return null; }
-L.Path.include({
+ // polyline centroid algorithm; only uses the first ring if there are multiple
- bindPopup: function (content, options) {
+ for (i = 0, halfDist = 0; i < len - 1; i++) {
+ halfDist += points[i].distanceTo(points[i + 1]) / 2;
+ }
- if (content instanceof L.Popup) {
- this._popup = content;
- } else {
- if (!this._popup || options) {
- this._popup = new L.Popup(options, this);
- }
- this._popup.setContent(content);
+ // 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]);
}
- if (!this._popupHandlersAdded) {
- this
- .on('click', this._openPopup, this)
- .on('remove', this.closePopup, this);
+ for (i = 0, dist = 0; i < len - 1; i++) {
+ p1 = points[i];
+ p2 = points[i + 1];
+ segDist = p1.distanceTo(p2);
+ dist += segDist;
- this._popupHandlersAdded = true;
+ 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)
+ ]);
+ }
}
-
- return this;
},
- unbindPopup: function () {
- if (this._popup) {
- this._popup = null;
- this
- .off('click', this._openPopup)
- .off('remove', this.closePopup);
+ // @method getBounds(): LatLngBounds
+ // Returns the `LatLngBounds` of the path.
+ getBounds: function () {
+ return this._bounds;
+ },
+
+ // @method addLatLng(latlng: LatLng, latlngs? LatLng[]): this
+ // Adds a given point to the polyline. By default, adds to the first ring of
+ // the polyline in case of a multi-polyline, but can be overridden by passing
+ // a specific ring as a LatLng array (that you can earlier access with [`getLatLngs`](#polyline-getlatlngs)).
+ addLatLng: function (latlng, latlngs) {
+ latlngs = latlngs || this._defaultShape();
+ latlng = L.latLng(latlng);
+ latlngs.push(latlng);
+ this._bounds.extend(latlng);
+ return this.redraw();
+ },
- this._popupHandlersAdded = false;
- }
- return this;
+ _setLatLngs: function (latlngs) {
+ this._bounds = new L.LatLngBounds();
+ this._latlngs = this._convertLatLngs(latlngs);
},
- openPopup: function (latlng) {
+ _defaultShape: function () {
+ return L.Polyline._flat(this._latlngs) ? this._latlngs : this._latlngs[0];
+ },
- if (this._popup) {
- // open the popup from one of the path's points if not specified
- latlng = latlng || this._latlng ||
- this._latlngs[Math.floor(this._latlngs.length / 2)];
+ // recursively convert latlngs input into actual LatLng instances; calculate bounds along the way
+ _convertLatLngs: function (latlngs) {
+ var result = [],
+ flat = L.Polyline._flat(latlngs);
- this._openPopup({latlng: latlng});
+ for (var i = 0, len = latlngs.length; i < len; i++) {
+ if (flat) {
+ result[i] = L.latLng(latlngs[i]);
+ this._bounds.extend(result[i]);
+ } else {
+ result[i] = this._convertLatLngs(latlngs[i]);
+ }
}
- return this;
+ return result;
},
- closePopup: function () {
- if (this._popup) {
- this._popup._close();
+ _project: function () {
+ var pxBounds = new L.Bounds();
+ this._rings = [];
+ this._projectLatlngs(this._latlngs, this._rings, pxBounds);
+
+ var w = this._clickTolerance(),
+ p = new L.Point(w, w);
+
+ if (this._bounds.isValid() && pxBounds.isValid()) {
+ pxBounds.min._subtract(p);
+ pxBounds.max._add(p);
+ this._pxBounds = pxBounds;
}
- return this;
},
- _openPopup: function (e) {
- this._popup.setLatLng(e.latlng);
- this._map.openPopup(this._popup);
- }
-});
-
+ // 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;
-/*
- * Vector rendering for IE6-8 through VML.
- * Thanks to Dmitry Baranovsky and his Raphael library for inspiration!
- */
+ 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);
+ }
+ }
+ },
-L.Browser.vml = !L.Browser.svg && (function () {
- try {
- var div = document.createElement('div');
- div.innerHTML = '<v:shape adj="1"/>';
+ // clip polyline by renderer bounds so that we have less to render for performance
+ _clipPoints: function () {
+ var bounds = this._renderer._bounds;
- var shape = div.firstChild;
- shape.style.behavior = 'url(#default#VML)';
+ this._parts = [];
+ if (!this._pxBounds || !this._pxBounds.intersects(bounds)) {
+ return;
+ }
- return shape && (typeof shape.adj === 'object');
+ if (this.options.noClip) {
+ this._parts = this._rings;
+ return;
+ }
- } catch (e) {
- return false;
- }
-}());
+ var parts = this._parts,
+ i, j, k, len, len2, segment, points;
-L.Path = L.Browser.svg || !L.Browser.vml ? L.Path : L.Path.extend({
- statics: {
- VML: true,
- CLIP_PADDING: 0.02
- },
+ for (i = 0, k = 0, len = this._rings.length; i < len; i++) {
+ points = this._rings[i];
- _createElement: (function () {
- try {
- document.namespaces.add('lvml', 'urn:schemas-microsoft-com:vml');
- return function (name) {
- return document.createElement('<lvml:' + name + ' class="lvml">');
- };
- } catch (e) {
- return function (name) {
- return document.createElement(
- '<' + name + ' xmlns="urn:schemas-microsoft.com:vml" class="lvml">');
- };
- }
- }()),
+ for (j = 0, len2 = points.length; j < len2 - 1; j++) {
+ segment = L.LineUtil.clipSegment(points[j], points[j + 1], bounds, j, true);
- _initPath: function () {
- var container = this._container = this._createElement('shape');
+ if (!segment) { continue; }
- L.DomUtil.addClass(container, 'leaflet-vml-shape' +
- (this.options.className ? ' ' + this.options.className : ''));
+ parts[k] = parts[k] || [];
+ parts[k].push(segment[0]);
- if (this.options.clickable) {
- L.DomUtil.addClass(container, 'leaflet-clickable');
+ // 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++;
+ }
+ }
}
+ },
- container.coordsize = '1 1';
-
- this._path = this._createElement('path');
- container.appendChild(this._path);
+ // simplify each clipped part of the polyline for performance
+ _simplifyPoints: function () {
+ var parts = this._parts,
+ tolerance = this.options.smoothFactor;
- this._map._pathRoot.appendChild(container);
+ for (var i = 0, len = parts.length; i < len; i++) {
+ parts[i] = L.LineUtil.simplify(parts[i], tolerance);
+ }
},
- _initStyle: function () {
- this._updateStyle();
+ _update: function () {
+ if (!this._map) { return; }
+
+ this._clipPoints();
+ this._simplifyPoints();
+ this._updatePath();
},
- _updateStyle: function () {
- var stroke = this._stroke,
- fill = this._fill,
- options = this.options,
- container = this._container;
+ _updatePath: function () {
+ this._renderer._updatePoly(this);
+ }
+});
- container.stroked = options.stroke;
- container.filled = options.fill;
+// @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 (options.stroke) {
- if (!stroke) {
- stroke = this._stroke = this._createElement('stroke');
- stroke.endcap = 'round';
- container.appendChild(stroke);
- }
- stroke.weight = options.weight + 'px';
- stroke.color = options.color;
- stroke.opacity = options.opacity;
+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 (options.dashArray) {
- stroke.dashStyle = L.Util.isArray(options.dashArray) ?
- options.dashArray.join(' ') :
- options.dashArray.replace(/( *, *)/g, ' ');
- } else {
- stroke.dashStyle = '';
- }
- if (options.lineCap) {
- stroke.endcap = options.lineCap.replace('butt', 'flat');
- }
- if (options.lineJoin) {
- stroke.joinstyle = options.lineJoin;
- }
- } else if (stroke) {
- container.removeChild(stroke);
- this._stroke = null;
- }
- if (options.fill) {
- if (!fill) {
- fill = this._fill = this._createElement('fill');
- container.appendChild(fill);
- }
- fill.color = options.fillColor || options.color;
- fill.opacity = options.fillOpacity;
+/*
+ * @namespace PolyUtil
+ * Various utility functions for polygon geometries.
+ */
- } else if (fill) {
- container.removeChild(fill);
- this._fill = null;
- }
- },
+L.PolyUtil = {};
- _updatePath: function () {
- var style = this._container.style;
+/* @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;
- style.display = 'none';
- this._path.v = this.getPathString() + ' '; // the space fixes IE empty path string bug
- style.display = '';
+ for (i = 0, len = points.length; i < len; i++) {
+ points[i]._code = lu._getBitCode(points[i], bounds);
}
-});
-L.Map.include(L.Browser.svg || !L.Browser.vml ? {} : {
- _initPathRoot: function () {
- if (this._pathRoot) { return; }
+ // 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];
- var root = this._pathRoot = document.createElement('div');
- root.className = 'leaflet-vml-container';
- this._panes.overlayPane.appendChild(root);
+ // 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);
- this.on('moveend', this._updatePathViewport);
- this._updatePathViewport();
+ // 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;
+};
+
/*
- * Vector rendering for all browsers that support canvas.
+ * @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]]
+ * ]
+ * ];
+ * ```
*/
-L.Browser.canvas = (function () {
- return !!document.createElement('canvas').getContext;
-}());
-
-L.Path = (L.Path.SVG && !window.L_PREFER_CANVAS) || !L.Browser.canvas ? L.Path : L.Path.extend({
- statics: {
- //CLIP_PADDING: 0.02, // not sure if there's a need to set it to a small value
- CANVAS: true,
- SVG: false
- },
+L.Polygon = L.Polyline.extend({
- redraw: function () {
- if (this._map) {
- this.projectLatlngs();
- this._requestUpdate();
- }
- return this;
+ options: {
+ fill: true
},
- setStyle: function (style) {
- L.setOptions(this, style);
-
- if (this._map) {
- this._updateStyle();
- this._requestUpdate();
- }
- return this;
+ isEmpty: function () {
+ return !this._latlngs.length || !this._latlngs[0].length;
},
- onRemove: function (map) {
- map
- .off('viewreset', this.projectLatlngs, this)
- .off('moveend', this._updatePath, this);
-
- if (this.options.clickable) {
- this._map.off('click', this._onClick, this);
- this._map.off('mousemove', this._onMouseMove, this);
+ 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()');
}
- this._requestUpdate();
-
- this.fire('remove');
- this._map = null;
- },
+ var i, j, p1, p2, f, area, x, y, center,
+ points = this._rings[0],
+ len = points.length;
- _requestUpdate: function () {
- if (this._map && !L.Path._updateRequest) {
- L.Path._updateRequest = L.Util.requestAnimFrame(this._fireMapMoveEnd, this._map);
- }
- },
+ if (!len) { return null; }
- _fireMapMoveEnd: function () {
- L.Path._updateRequest = null;
- this.fire('moveend');
- },
+ // polygon centroid algorithm; only uses the first ring if there are multiple
- _initElements: function () {
- this._map._initPathRoot();
- this._ctx = this._map._canvasCtx;
- },
+ area = x = y = 0;
- _updateStyle: function () {
- var options = this.options;
+ for (i = 0, j = len - 1; i < len; j = i++) {
+ p1 = points[i];
+ p2 = points[j];
- if (options.stroke) {
- this._ctx.lineWidth = options.weight;
- this._ctx.strokeStyle = options.color;
- }
- if (options.fill) {
- this._ctx.fillStyle = options.fillColor || options.color;
+ f = p1.y * p2.x - p2.y * p1.x;
+ x += (p1.x + p2.x) * f;
+ y += (p1.y + p2.y) * f;
+ area += f * 3;
}
- if (options.lineCap) {
- this._ctx.lineCap = options.lineCap;
- }
- if (options.lineJoin) {
- this._ctx.lineJoin = options.lineJoin;
+ 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);
},
- _drawPath: function () {
- var i, j, len, len2, point, drawMethod;
+ _convertLatLngs: function (latlngs) {
+ var result = L.Polyline.prototype._convertLatLngs.call(this, latlngs),
+ len = result.length;
- this._ctx.beginPath();
-
- for (i = 0, len = this._parts.length; i < len; i++) {
- for (j = 0, len2 = this._parts[i].length; j < len2; j++) {
- point = this._parts[i][j];
- drawMethod = (j === 0 ? 'move' : 'line') + 'To';
+ // remove last point if it equals first one
+ if (len >= 2 && result[0] instanceof L.LatLng && result[0].equals(result[len - 1])) {
+ result.pop();
+ }
+ return result;
+ },
- this._ctx[drawMethod](point.x, point.y);
- }
- // TODO refactor ugly hack
- if (this instanceof L.Polygon) {
- this._ctx.closePath();
- }
+ _setLatLngs: function (latlngs) {
+ L.Polyline.prototype._setLatLngs.call(this, latlngs);
+ if (L.Polyline._flat(this._latlngs)) {
+ this._latlngs = [this._latlngs];
}
},
- _checkIfEmpty: function () {
- return !this._parts.length;
+ _defaultShape: function () {
+ return L.Polyline._flat(this._latlngs[0]) ? this._latlngs[0] : this._latlngs[0][0];
},
- _updatePath: function () {
- if (this._checkIfEmpty()) { return; }
+ _clipPoints: function () {
+ // polygons need a different clipping algorithm so we redefine that
- var ctx = this._ctx,
- options = this.options;
+ var bounds = this._renderer._bounds,
+ w = this.options.weight,
+ p = new L.Point(w, w);
- this._drawPath();
- ctx.save();
- this._updateStyle();
+ // 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 (options.fill) {
- ctx.globalAlpha = options.fillOpacity;
- ctx.fill(options.fillRule || 'evenodd');
+ this._parts = [];
+ if (!this._pxBounds || !this._pxBounds.intersects(bounds)) {
+ return;
}
- if (options.stroke) {
- ctx.globalAlpha = options.opacity;
- ctx.stroke();
+ if (this.options.noClip) {
+ this._parts = this._rings;
+ return;
}
- ctx.restore();
-
- // TODO optimization: 1 fill/stroke for all features with equal style instead of 1 for each feature
- },
-
- _initEvents: function () {
- if (this.options.clickable) {
- this._map.on('mousemove', this._onMouseMove, this);
- this._map.on('click dblclick contextmenu', this._fireMouseEvent, this);
+ 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);
+ }
}
},
- _fireMouseEvent: function (e) {
- if (this._containsPoint(e.layerPoint)) {
- this.fire(e.type, e);
- }
- },
+ _updatePath: function () {
+ this._renderer._updatePoly(this, true);
+ }
+});
- _onMouseMove: function (e) {
- if (!this._map || this._map._animatingZoom) { return; }
- // TODO don't do on each move
- if (this._containsPoint(e.layerPoint)) {
- this._ctx.canvas.style.cursor = 'pointer';
- this._mouseInside = true;
- this.fire('mouseover', e);
+// @factory L.polygon(latlngs: LatLng[], options?: Polyline options)
+L.polygon = function (latlngs, options) {
+ return new L.Polygon(latlngs, options);
+};
- } else if (this._mouseInside) {
- this._ctx.canvas.style.cursor = '';
- this._mouseInside = false;
- this.fire('mouseout', e);
- }
- }
-});
-L.Map.include((L.Path.SVG && !window.L_PREFER_CANVAS) || !L.Browser.canvas ? {} : {
- _initPathRoot: function () {
- var root = this._pathRoot,
- ctx;
- if (!root) {
- root = this._pathRoot = document.createElement('canvas');
- root.style.position = 'absolute';
- ctx = this._canvasCtx = root.getContext('2d');
+/*
+ * L.Rectangle extends Polygon and creates a rectangle when passed a LatLngBounds object.
+ */
- ctx.lineCap = 'round';
- ctx.lineJoin = 'round';
+/*
+ * @class Rectangle
+ * @aka L.Retangle
+ * @inherits Polygon
+ *
+ * A class for drawing rectangle overlays on a map. Extends `Polygon`.
+ *
+ * @example
+ *
+ * ```js
+ * // define rectangle geographical bounds
+ * var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
+ *
+ * // create an orange rectangle
+ * L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
+ *
+ * // zoom the map to the rectangle bounds
+ * map.fitBounds(bounds);
+ * ```
+ *
+ */
- this._panes.overlayPane.appendChild(root);
- if (this.options.zoomAnimation) {
- this._pathRoot.className = 'leaflet-zoom-animated';
- this.on('zoomanim', this._animatePathZoom);
- this.on('zoomend', this._endPathZoom);
- }
- this.on('moveend', this._updateCanvasViewport);
- this._updateCanvasViewport();
- }
+L.Rectangle = L.Polygon.extend({
+ initialize: function (latLngBounds, options) {
+ L.Polygon.prototype.initialize.call(this, this._boundsToLatLngs(latLngBounds), options);
},
- _updateCanvasViewport: function () {
- // don't redraw while zooming. See _updateSvgViewport for more details
- if (this._pathZooming) { return; }
- this._updatePathViewport();
-
- var vp = this._pathViewport,
- min = vp.min,
- size = vp.max.subtract(min),
- root = this._pathRoot;
+ // @method setBounds(latLngBounds: LatLngBounds): this
+ // Redraws the rectangle with the passed bounds.
+ setBounds: function (latLngBounds) {
+ return this.setLatLngs(this._boundsToLatLngs(latLngBounds));
+ },
- //TODO check if this works properly on mobile webkit
- L.DomUtil.setPosition(root, min);
- root.width = size.x;
- root.height = size.y;
- root.getContext('2d').translate(-min.x, -min.y);
+ _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);
+};
+
+
+
/*
- * L.LineUtil contains different utility functions for line segments
- * and polylines (clipping, simplification, distances, etc.)
+ * @class CircleMarker
+ * @aka L.CircleMarker
+ * @inherits Path
+ *
+ * A circle of a fixed size with radius specified in pixels. Extends `Path`.
*/
-/*jshint bitwise:false */ // allow bitwise operations for this file
+L.CircleMarker = L.Path.extend({
-L.LineUtil = {
+ // @section
+ // @aka CircleMarker options
+ options: {
+ fill: true,
- // Simplify polyline with vertex reduction and Douglas-Peucker simplification.
- // Improves rendering performance dramatically by lessening the number of points to draw.
+ // @option radius: Number = 10
+ // Radius of the circle marker, in pixels
+ radius: 10
+ },
- simplify: function (/*Point[]*/ points, /*Number*/ tolerance) {
- if (!tolerance || !points.length) {
- return points.slice();
- }
+ initialize: function (latlng, options) {
+ L.setOptions(this, options);
+ this._latlng = L.latLng(latlng);
+ this._radius = this.options.radius;
+ },
- var sqTolerance = tolerance * tolerance;
+ // @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});
+ },
- // stage 1: vertex reduction
- points = this._reducePoints(points, sqTolerance);
+ // @method getLatLng(): LatLng
+ // Returns the current geographical position of the circle marker
+ getLatLng: function () {
+ return this._latlng;
+ },
- // stage 2: Douglas-Peucker simplification
- points = this._simplifyDP(points, sqTolerance);
+ // @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();
+ },
- return points;
+ // @method getRadius(): Number
+ // Returns the current radius of the circle
+ getRadius: function () {
+ return this._radius;
},
- // distance from a point to a segment between two points
- pointToSegmentDistance: function (/*Point*/ p, /*Point*/ p1, /*Point*/ p2) {
- return Math.sqrt(this._sqClosestPointOnSegment(p, p1, p2, true));
+ setStyle : function (options) {
+ var radius = options && options.radius || this._radius;
+ L.Path.prototype.setStyle.call(this, options);
+ this.setRadius(radius);
+ return this;
},
- closestPointOnSegment: function (/*Point*/ p, /*Point*/ p1, /*Point*/ p2) {
- return this._sqClosestPointOnSegment(p, p1, p2);
+ _project: function () {
+ this._point = this._map.latLngToLayerPoint(this._latlng);
+ this._updateBounds();
},
- // Douglas-Peucker simplification, see http://en.wikipedia.org/wiki/Douglas-Peucker_algorithm
- _simplifyDP: function (points, sqTolerance) {
+ _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));
+ },
- var len = points.length,
- ArrayConstructor = typeof Uint8Array !== undefined + '' ? Uint8Array : Array,
- markers = new ArrayConstructor(len);
+ _update: function () {
+ if (this._map) {
+ this._updatePath();
+ }
+ },
- markers[0] = markers[len - 1] = 1;
+ _updatePath: function () {
+ this._renderer._updateCircle(this);
+ },
- this._simplifyDPStep(points, markers, sqTolerance, 0, len - 1);
+ _empty: function () {
+ return this._radius && !this._renderer._bounds.intersects(this._pxBounds);
+ }
+});
- var i,
- newPoints = [];
- for (i = 0; i < len; i++) {
- if (markers[i]) {
- newPoints.push(points[i]);
- }
- }
+// @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);
+};
- return newPoints;
- },
- _simplifyDPStep: function (points, markers, sqTolerance, first, last) {
- var maxSqDist = 0,
- index, i, sqDist;
+/*
+ * @class Circle
+ * @aka L.Circle
+ * @inherits CircleMarker
+ *
+ * A class for drawing circle overlays on a map. Extends `CircleMarker`.
+ *
+ * It's an approximation and starts to diverge from a real circle closer to poles (due to projection distortion).
+ *
+ * @example
+ *
+ * ```js
+ * L.circle([50.5, 30.5], 200).addTo(map);
+ * ```
+ */
- for (i = first + 1; i <= last - 1; i++) {
- sqDist = this._sqClosestPointOnSegment(points[i], points[first], points[last], true);
+L.Circle = L.CircleMarker.extend({
- if (sqDist > maxSqDist) {
- index = i;
- maxSqDist = sqDist;
- }
+ 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);
- if (maxSqDist > sqTolerance) {
- markers[index] = 1;
+ if (isNaN(this.options.radius)) { throw new Error('Circle radius cannot be NaN'); }
- this._simplifyDPStep(points, markers, sqTolerance, first, index);
- this._simplifyDPStep(points, markers, sqTolerance, index, last);
- }
+ // @section
+ // @aka Circle options
+ // @option radius: Number; Radius of the circle, in meters.
+ this._mRadius = this.options.radius;
},
- // 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;
+ // @method setRadius(radius: Number): this
+ // Sets the radius of a circle. Units are in meters.
+ setRadius: function (radius) {
+ this._mRadius = radius;
+ return this.redraw();
},
- // Cohen-Sutherland line clipping algorithm.
- // Used to avoid rendering parts of a polyline that are not currently visible.
+ // @method getRadius(): Number
+ // Returns the current radius of a circle. Units are in meters.
+ getRadius: function () {
+ return this._mRadius;
+ },
- clipSegment: function (a, b, bounds, useLastCode) {
- var codeA = useLastCode ? this._lastCode : this._getBitCode(a, bounds),
- codeB = this._getBitCode(b, bounds),
+ // @method getBounds(): LatLngBounds
+ // Returns the `LatLngBounds` of the path.
+ getBounds: function () {
+ var half = [this._radius, this._radiusY || this._radius];
- codeOut, p, newCode;
+ return new L.LatLngBounds(
+ this._map.layerPointToLatLng(this._point.subtract(half)),
+ this._map.layerPointToLatLng(this._point.add(half)));
+ },
- // save 2nd code to avoid calculating it on the next segment
- this._lastCode = codeB;
+ setStyle: L.Path.prototype.setStyle,
- 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)
- } else if (codeA & codeB) {
- return false;
- // other cases
- } else {
- codeOut = codeA || codeB;
- p = this._getEdgeIntersection(a, b, codeOut, bounds);
- newCode = this._getBitCode(p, bounds);
+ _project: function () {
- if (codeOut === codeA) {
- a = p;
- codeA = newCode;
- } else {
- b = p;
- codeB = newCode;
- }
+ var lng = this._latlng.lng,
+ lat = this._latlng.lat,
+ map = this._map,
+ crs = map.options.crs;
+
+ if (crs.distance === L.CRS.Earth.distance) {
+ var d = Math.PI / 180,
+ latR = (this._mRadius / L.CRS.Earth.R) / d,
+ top = map.project([lat + latR, lng]),
+ bottom = map.project([lat - latR, lng]),
+ p = top.add(bottom).divideBy(2),
+ lat2 = map.unproject(p).lat,
+ lngR = Math.acos((Math.cos(latR * d) - Math.sin(lat * d) * Math.sin(lat2 * d)) /
+ (Math.cos(lat * d) * Math.cos(lat2 * d))) / d;
+
+ if (isNaN(lngR) || lngR === 0) {
+ lngR = latR / Math.cos(Math.PI / 180 * lat); // Fallback for edge case, #2425
}
- }
- },
- _getEdgeIntersection: function (a, b, code, bounds) {
- var dx = b.x - a.x,
- dy = b.y - a.y,
- min = bounds.min,
- max = bounds.max;
+ this._point = p.subtract(map.getPixelOrigin());
+ this._radius = isNaN(lngR) ? 0 : Math.max(Math.round(p.x - map.project([lat2, lng - lngR]).x), 1);
+ this._radiusY = Math.max(Math.round(p.y - top.y), 1);
- if (code & 8) { // top
- return new L.Point(a.x + dx * (max.y - a.y) / dy, max.y);
- } else if (code & 4) { // bottom
- return new L.Point(a.x + dx * (min.y - a.y) / dy, min.y);
- } else if (code & 2) { // right
- return new L.Point(max.x, a.y + dy * (max.x - a.x) / dx);
- } else if (code & 1) { // left
- return new L.Point(min.x, a.y + dy * (min.x - a.x) / dx);
+ } else {
+ var latlng2 = crs.unproject(crs.project(this._latlng).subtract([this._mRadius, 0]));
+
+ this._point = map.latLngToLayerPoint(this._latlng);
+ this._radius = this._point.x - map.latLngToLayerPoint(latlng2).x;
}
- },
- _getBitCode: function (/*Point*/ p, bounds) {
- var code = 0;
+ this._updateBounds();
+ }
+});
- 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;
- }
+// @factory L.circle(latlng: LatLng, options?: Circle options)
+// Instantiates a circle object given a geographical point, and an options object
+// which contains the circle radius.
+// @alternative
+// @factory L.circle(latlng: LatLng, radius: Number, options?: Circle options)
+// Obsolete way of instantiating a circle, for compatibility with 0.7.x code.
+// Do not use in new applications or plugins.
+L.circle = function (latlng, options, legacyOptions) {
+ return new L.Circle(latlng, options, legacyOptions);
+};
- 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;
+
+/*
+ * @class SVG
+ * @inherits Renderer
+ * @aka L.SVG
+ *
+ * Allows vector layers to be displayed with [SVG](https://developer.mozilla.org/docs/Web/SVG).
+ * Inherits `Renderer`.
+ *
+ * Due to [technical limitations](http://caniuse.com/#search=svg), SVG is not
+ * available in all web browsers, notably Android 2.x and 3.x.
+ *
+ * Although SVG is not available on IE7 and IE8, these browsers support
+ * [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language)
+ * (a now deprecated technology), and the SVG renderer will fall back to VML in
+ * this case.
+ *
+ * @example
+ *
+ * Use SVG by default for all paths in the map:
+ *
+ * ```js
+ * var map = L.map('map', {
+ * renderer: L.svg()
+ * });
+ * ```
+ *
+ * Use a SVG renderer with extra padding for specific vector geometries:
+ *
+ * ```js
+ * var map = L.map('map');
+ * var myRenderer = L.svg({ padding: 0.5 });
+ * var line = L.polyline( coordinates, { renderer: myRenderer } );
+ * var circle = L.circle( center, { renderer: myRenderer } );
+ * ```
+ */
+
+L.SVG = L.Renderer.extend({
+
+ getEvents: function () {
+ var events = L.Renderer.prototype.getEvents.call(this);
+ events.zoomstart = this._onZoomStart;
+ return events;
},
- // 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;
+ _initContainer: function () {
+ this._container = L.SVG.create('svg');
- if (dot > 0) {
- t = ((p.x - x) * dx + (p.y - y) * dy) / dot;
+ // makes it possible to click through svg root; we'll reset it back in individual paths
+ this._container.setAttribute('pointer-events', 'none');
- if (t > 1) {
- x = p2.x;
- y = p2.y;
- } else if (t > 0) {
- x += dx * t;
- y += dy * t;
- }
- }
+ this._rootGroup = L.SVG.create('g');
+ this._container.appendChild(this._rootGroup);
+ },
- dx = p.x - x;
- dy = p.y - y;
+ _onZoomStart: function () {
+ // Drag-then-pinch interactions might mess up the center and zoom.
+ // In this case, the easiest way to prevent this is re-do the renderer
+ // bounds and padding when the zooming starts.
+ this._update();
+ },
- return sqDist ? dx * dx + dy * dy : new L.Point(x, y);
- }
-};
+ _update: function () {
+ if (this._map._animatingZoom && this._bounds) { return; }
+ L.Renderer.prototype._update.call(this);
-/*
- * L.Polyline is used to display polylines on a map.
- */
+ var b = this._bounds,
+ size = b.getSize(),
+ container = this._container;
-L.Polyline = L.Path.extend({
- initialize: function (latlngs, options) {
- L.Path.prototype.initialize.call(this, options);
+ // set size of svg-container if changed
+ if (!this._svgSize || !this._svgSize.equals(size)) {
+ this._svgSize = size;
+ container.setAttribute('width', size.x);
+ container.setAttribute('height', size.y);
+ }
- this._latlngs = this._convertLatLngs(latlngs);
- },
+ // movement: update container viewBox so that we don't have to change coordinates of individual layers
+ L.DomUtil.setPosition(container, b.min);
+ container.setAttribute('viewBox', [b.min.x, b.min.y, size.x, size.y].join(' '));
- options: {
- // how much to simplify the polyline on each zoom level
- // more = better performance and smoother look, less = more accurate
- smoothFactor: 1.0,
- noClip: false
+ this.fire('update');
},
- projectLatlngs: function () {
- this._originalPoints = [];
+ // methods below are called by vector layers implementations
- for (var i = 0, len = this._latlngs.length; i < len; i++) {
- this._originalPoints[i] = this._map.latLngToLayerPoint(this._latlngs[i]);
+ _initPath: function (layer) {
+ var path = layer._path = L.SVG.create('path');
+
+ // @namespace Path
+ // @option className: String = null
+ // Custom class name set on an element. Only for SVG renderer.
+ if (layer.options.className) {
+ L.DomUtil.addClass(path, layer.options.className);
}
- },
- getPathString: function () {
- for (var i = 0, len = this._parts.length, str = ''; i < len; i++) {
- str += this._getPathPartStr(this._parts[i]);
+ if (layer.options.interactive) {
+ L.DomUtil.addClass(path, 'leaflet-interactive');
}
- return str;
- },
- getLatLngs: function () {
- return this._latlngs;
+ this._updateStyle(layer);
},
- setLatLngs: function (latlngs) {
- this._latlngs = this._convertLatLngs(latlngs);
- return this.redraw();
+ _addPath: function (layer) {
+ this._rootGroup.appendChild(layer._path);
+ layer.addInteractiveTarget(layer._path);
},
- addLatLng: function (latlng) {
- this._latlngs.push(L.latLng(latlng));
- return this.redraw();
+ _removePath: function (layer) {
+ L.DomUtil.remove(layer._path);
+ layer.removeInteractiveTarget(layer._path);
},
- spliceLatLngs: function () { // (Number index, Number howMany)
- var removed = [].splice.apply(this._latlngs, arguments);
- this._convertLatLngs(this._latlngs, true);
- this.redraw();
- return removed;
+ _updatePath: function (layer) {
+ layer._project();
+ layer._update();
},
- closestLayerPoint: function (p) {
- var minDistance = Infinity, parts = this._parts, p1, p2, minPoint = null;
+ _updateStyle: function (layer) {
+ var path = layer._path,
+ options = layer.options;
- for (var j = 0, jLen = parts.length; j < jLen; j++) {
- var points = parts[j];
- for (var i = 1, len = points.length; i < len; i++) {
- p1 = points[i - 1];
- p2 = points[i];
- var sqDist = L.LineUtil._sqClosestPointOnSegment(p, p1, p2, true);
- if (sqDist < minDistance) {
- minDistance = sqDist;
- minPoint = L.LineUtil._sqClosestPointOnSegment(p, p1, p2);
- }
+ if (!path) { return; }
+
+ if (options.stroke) {
+ path.setAttribute('stroke', options.color);
+ path.setAttribute('stroke-opacity', options.opacity);
+ path.setAttribute('stroke-width', options.weight);
+ path.setAttribute('stroke-linecap', options.lineCap);
+ path.setAttribute('stroke-linejoin', options.lineJoin);
+
+ if (options.dashArray) {
+ path.setAttribute('stroke-dasharray', options.dashArray);
+ } else {
+ path.removeAttribute('stroke-dasharray');
+ }
+
+ if (options.dashOffset) {
+ path.setAttribute('stroke-dashoffset', options.dashOffset);
+ } else {
+ path.removeAttribute('stroke-dashoffset');
}
+ } else {
+ path.setAttribute('stroke', 'none');
}
- if (minPoint) {
- minPoint.distance = Math.sqrt(minDistance);
+
+ if (options.fill) {
+ path.setAttribute('fill', options.fillColor || options.color);
+ path.setAttribute('fill-opacity', options.fillOpacity);
+ path.setAttribute('fill-rule', options.fillRule || 'evenodd');
+ } else {
+ path.setAttribute('fill', 'none');
}
- return minPoint;
},
- getBounds: function () {
- return new L.LatLngBounds(this.getLatLngs());
+ _updatePoly: function (layer, closed) {
+ this._setPath(layer, L.SVG.pointsToPath(layer._parts, closed));
},
- _convertLatLngs: function (latlngs, overwrite) {
- var i, len, target = overwrite ? latlngs : [];
+ _updateCircle: function (layer) {
+ var p = layer._point,
+ r = layer._radius,
+ r2 = layer._radiusY || r,
+ arc = 'a' + r + ',' + r2 + ' 0 1,0 ';
- for (i = 0, len = latlngs.length; i < len; i++) {
- if (L.Util.isArray(latlngs[i]) && typeof latlngs[i][0] !== 'number') {
- return;
- }
- target[i] = L.latLng(latlngs[i]);
- }
- return target;
- },
+ // drawing a circle with two half-arcs
+ var d = layer._empty() ? 'M0 0' :
+ 'M' + (p.x - r) + ',' + p.y +
+ arc + (r * 2) + ',0 ' +
+ arc + (-r * 2) + ',0 ';
- _initEvents: function () {
- L.Path.prototype._initEvents.call(this);
+ this._setPath(layer, d);
},
- _getPathPartStr: function (points) {
- var round = L.Path.VML;
-
- for (var j = 0, len2 = points.length, str = '', p; j < len2; j++) {
- p = points[j];
- if (round) {
- p._round();
- }
- str += (j ? 'L' : 'M') + p.x + ' ' + p.y;
- }
- return str;
+ _setPath: function (layer, path) {
+ layer._path.setAttribute('d', path);
},
- _clipPoints: function () {
- var points = this._originalPoints,
- len = points.length,
- i, k, segment;
+ // SVG does not have the concept of zIndex so we resort to changing the DOM order of elements
+ _bringToFront: function (layer) {
+ L.DomUtil.toFront(layer._path);
+ },
- if (this.options.noClip) {
- this._parts = [points];
- return;
- }
+ _bringToBack: function (layer) {
+ L.DomUtil.toBack(layer._path);
+ }
+});
- this._parts = [];
- var parts = this._parts,
- vp = this._map._pathViewport,
- lu = L.LineUtil;
+// @namespace SVG; @section
+// There are several static functions which can be called without instantiating L.SVG:
+L.extend(L.SVG, {
+ // @function create(name: String): SVGElement
+ // Returns a instance of [SVGElement](https://developer.mozilla.org/docs/Web/API/SVGElement),
+ // corresponding to the class name passed. For example, using 'line' will return
+ // an instance of [SVGLineElement](https://developer.mozilla.org/docs/Web/API/SVGLineElement).
+ create: function (name) {
+ return document.createElementNS('http://www.w3.org/2000/svg', name);
+ },
- for (i = 0, k = 0; i < len - 1; i++) {
- segment = lu.clipSegment(points[i], points[i + 1], vp, i);
- if (!segment) {
- continue;
- }
+ // @function pointsToPath(rings: Point[], closed: Boolean): String
+ // Generates a SVG path string for multiple rings, with each ring turning
+ // into "M..L..L.." instructions
+ pointsToPath: function (rings, closed) {
+ var str = '',
+ i, j, len, len2, points, p;
- parts[k] = parts[k] || [];
- parts[k].push(segment[0]);
+ for (i = 0, len = rings.length; i < len; i++) {
+ points = rings[i];
- // if segment goes out of screen, or it's the last one, it's the end of the line part
- if ((segment[1] !== points[i + 1]) || (i === len - 2)) {
- parts[k].push(segment[1]);
- k++;
+ for (j = 0, len2 = points.length; j < len2; j++) {
+ p = points[j];
+ str += (j ? 'L' : 'M') + p.x + ' ' + p.y;
}
- }
- },
-
- // simplify each clipped part of the polyline
- _simplifyPoints: function () {
- var parts = this._parts,
- lu = L.LineUtil;
- for (var i = 0, len = parts.length; i < len; i++) {
- parts[i] = lu.simplify(parts[i], this.options.smoothFactor);
+ // closes the ring for polygons; "x" is VML syntax
+ str += closed ? (L.Browser.svg ? 'z' : 'x') : '';
}
- },
-
- _updatePath: function () {
- if (!this._map) { return; }
-
- this._clipPoints();
- this._simplifyPoints();
- L.Path.prototype._updatePath.call(this);
+ // SVG complains about empty path strings
+ return str || 'M0 0';
}
});
-L.polyline = function (latlngs, options) {
- return new L.Polyline(latlngs, options);
-};
+// @namespace Browser; @property svg: Boolean
+// `true` when the browser supports [SVG](https://developer.mozilla.org/docs/Web/SVG).
+L.Browser.svg = !!(document.createElementNS && L.SVG.create('svg').createSVGRect);
-/*
- * L.PolyUtil contains utility functions for polygons (clipping, etc.).
- */
+// @namespace SVG
+// @factory L.svg(options?: Renderer options)
+// Creates a SVG renderer with the given options.
+L.svg = function (options) {
+ return L.Browser.svg || L.Browser.vml ? new L.SVG(options) : null;
+};
-/*jshint bitwise:false */ // allow bitwise operations here
-L.PolyUtil = {};
/*
- * Sutherland-Hodgeman polygon clipping algorithm.
- * Used to avoid rendering parts of a polygon that are not currently visible.
+ * Thanks to Dmitry Baranovsky and his Raphael library for inspiration!
*/
-L.PolyUtil.clipPolygon = function (points, bounds) {
- 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);
- }
+/*
+ * @class SVG
+ *
+ * Although SVG is not available on IE7 and IE8, these browsers support [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language), and the SVG renderer will fall back to VML in this case.
+ *
+ * VML was deprecated in 2012, which means VML functionality exists only for backwards compatibility
+ * with old versions of Internet Explorer.
+ */
- // for each edge (left, bottom, right, top)
- for (k = 0; k < 4; k++) {
- edge = edges[k];
- clippedPoints = [];
+// @namespace Browser; @property vml: Boolean
+// `true` if the browser supports [VML](https://en.wikipedia.org/wiki/Vector_Markup_Language).
+L.Browser.vml = !L.Browser.svg && (function () {
+ try {
+ var div = document.createElement('div');
+ div.innerHTML = '<v:shape adj="1"/>';
- for (i = 0, len = points.length, j = len - 1; i < len; j = i++) {
- a = points[i];
- b = points[j];
+ var shape = div.firstChild;
+ shape.style.behavior = 'url(#default#VML)';
- // 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);
- p._code = lu._getBitCode(p, bounds);
- clippedPoints.push(p);
- }
- clippedPoints.push(a);
+ return shape && (typeof shape.adj === 'object');
- // 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);
- p._code = lu._getBitCode(p, bounds);
- clippedPoints.push(p);
- }
- }
- points = clippedPoints;
+ } catch (e) {
+ return false;
}
+}());
- return points;
-};
-
-
-/*
- * L.Polygon is used to display polygons on a map.
- */
+// redefine some SVG methods to handle VML syntax which is similar but with some differences
+L.SVG.include(!L.Browser.vml ? {} : {
-L.Polygon = L.Polyline.extend({
- options: {
- fill: true
+ _initContainer: function () {
+ this._container = L.DomUtil.create('div', 'leaflet-vml-container');
},
- initialize: function (latlngs, options) {
- L.Polyline.prototype.initialize.call(this, latlngs, options);
- this._initWithHoles(latlngs);
+ _update: function () {
+ if (this._map._animatingZoom) { return; }
+ L.Renderer.prototype._update.call(this);
},
- _initWithHoles: function (latlngs) {
- var i, len, hole;
- if (latlngs && L.Util.isArray(latlngs[0]) && (typeof latlngs[0][0] !== 'number')) {
- this._latlngs = this._convertLatLngs(latlngs[0]);
- this._holes = latlngs.slice(1);
+ _initPath: function (layer) {
+ var container = layer._container = L.SVG.create('shape');
- for (i = 0, len = this._holes.length; i < len; i++) {
- hole = this._holes[i] = this._convertLatLngs(this._holes[i]);
- if (hole[0].equals(hole[hole.length - 1])) {
- hole.pop();
- }
- }
- }
+ L.DomUtil.addClass(container, 'leaflet-vml-shape ' + (this.options.className || ''));
+
+ container.coordsize = '1 1';
- // filter out last point if its equal to the first one
- latlngs = this._latlngs;
+ layer._path = L.SVG.create('path');
+ container.appendChild(layer._path);
- if (latlngs.length >= 2 && latlngs[0].equals(latlngs[latlngs.length - 1])) {
- latlngs.pop();
- }
+ this._updateStyle(layer);
},
- projectLatlngs: function () {
- L.Polyline.prototype.projectLatlngs.call(this);
+ _addPath: function (layer) {
+ var container = layer._container;
+ this._container.appendChild(container);
+
+ if (layer.options.interactive) {
+ layer.addInteractiveTarget(container);
+ }
+ },
- // project polygon holes points
- // TODO move this logic to Polyline to get rid of duplication
- this._holePoints = [];
+ _removePath: function (layer) {
+ var container = layer._container;
+ L.DomUtil.remove(container);
+ layer.removeInteractiveTarget(container);
+ },
- if (!this._holes) { return; }
+ _updateStyle: function (layer) {
+ var stroke = layer._stroke,
+ fill = layer._fill,
+ options = layer.options,
+ container = layer._container;
- var i, j, len, len2;
+ container.stroked = !!options.stroke;
+ container.filled = !!options.fill;
- for (i = 0, len = this._holes.length; i < len; i++) {
- this._holePoints[i] = [];
+ if (options.stroke) {
+ if (!stroke) {
+ stroke = layer._stroke = L.SVG.create('stroke');
+ }
+ container.appendChild(stroke);
+ stroke.weight = options.weight + 'px';
+ stroke.color = options.color;
+ stroke.opacity = options.opacity;
- for (j = 0, len2 = this._holes[i].length; j < len2; j++) {
- this._holePoints[i][j] = this._map.latLngToLayerPoint(this._holes[i][j]);
+ if (options.dashArray) {
+ stroke.dashStyle = L.Util.isArray(options.dashArray) ?
+ options.dashArray.join(' ') :
+ options.dashArray.replace(/( *, *)/g, ' ');
+ } else {
+ stroke.dashStyle = '';
}
+ stroke.endcap = options.lineCap.replace('butt', 'flat');
+ stroke.joinstyle = options.lineJoin;
+
+ } else if (stroke) {
+ container.removeChild(stroke);
+ layer._stroke = null;
}
- },
- setLatLngs: function (latlngs) {
- if (latlngs && L.Util.isArray(latlngs[0]) && (typeof latlngs[0][0] !== 'number')) {
- this._initWithHoles(latlngs);
- return this.redraw();
- } else {
- return L.Polyline.prototype.setLatLngs.call(this, latlngs);
+ if (options.fill) {
+ if (!fill) {
+ fill = layer._fill = L.SVG.create('fill');
+ }
+ container.appendChild(fill);
+ fill.color = options.fillColor || options.color;
+ fill.opacity = options.fillOpacity;
+
+ } else if (fill) {
+ container.removeChild(fill);
+ layer._fill = null;
}
},
- _clipPoints: function () {
- var points = this._originalPoints,
- newParts = [];
-
- this._parts = [points].concat(this._holePoints);
+ _updateCircle: function (layer) {
+ var p = layer._point.round(),
+ r = Math.round(layer._radius),
+ r2 = Math.round(layer._radiusY || r);
- if (this.options.noClip) { return; }
+ this._setPath(layer, layer._empty() ? 'M0 0' :
+ 'AL ' + p.x + ',' + p.y + ' ' + r + ',' + r2 + ' 0,' + (65535 * 360));
+ },
- for (var i = 0, len = this._parts.length; i < len; i++) {
- var clipped = L.PolyUtil.clipPolygon(this._parts[i], this._map._pathViewport);
- if (clipped.length) {
- newParts.push(clipped);
- }
- }
+ _setPath: function (layer, path) {
+ layer._path.v = path;
+ },
- this._parts = newParts;
+ _bringToFront: function (layer) {
+ L.DomUtil.toFront(layer._container);
},
- _getPathPartStr: function (points) {
- var str = L.Polyline.prototype._getPathPartStr.call(this, points);
- return str + (L.Browser.svg ? 'z' : 'x');
+ _bringToBack: function (layer) {
+ L.DomUtil.toBack(layer._container);
}
});
-L.polygon = function (latlngs, options) {
- return new L.Polygon(latlngs, options);
-};
+if (L.Browser.vml) {
+ L.SVG.create = (function () {
+ try {
+ document.namespaces.add('lvml', 'urn:schemas-microsoft-com:vml');
+ return function (name) {
+ return document.createElement('<lvml:' + name + ' class="lvml">');
+ };
+ } catch (e) {
+ return function (name) {
+ return document.createElement('<' + name + ' xmlns="urn:schemas-microsoft.com:vml" class="lvml">');
+ };
+ }
+ })();
+}
+
/*
- * Contains L.MultiPolyline and L.MultiPolygon layers.
+ * @class Canvas
+ * @inherits Renderer
+ * @aka L.Canvas
+ *
+ * Allows vector layers to be displayed with [`<canvas>`](https://developer.mozilla.org/docs/Web/API/Canvas_API).
+ * Inherits `Renderer`.
+ *
+ * Due to [technical limitations](http://caniuse.com/#search=canvas), Canvas is not
+ * available in all web browsers, notably IE8, and overlapping geometries might
+ * not display properly in some edge cases.
+ *
+ * @example
+ *
+ * Use Canvas by default for all paths in the map:
+ *
+ * ```js
+ * var map = L.map('map', {
+ * renderer: L.canvas()
+ * });
+ * ```
+ *
+ * Use a Canvas renderer with extra padding for specific vector geometries:
+ *
+ * ```js
+ * var map = L.map('map');
+ * var myRenderer = L.canvas({ padding: 0.5 });
+ * var line = L.polyline( coordinates, { renderer: myRenderer } );
+ * var circle = L.circle( center, { renderer: myRenderer } );
+ * ```
*/
-(function () {
- function createMulti(Klass) {
+L.Canvas = L.Renderer.extend({
- return L.FeatureGroup.extend({
+ onAdd: function () {
+ L.Renderer.prototype.onAdd.call(this);
- initialize: function (latlngs, options) {
- this._layers = {};
- this._options = options;
- this.setLatLngs(latlngs);
- },
+ this._layers = this._layers || {};
- setLatLngs: function (latlngs) {
- var i = 0,
- len = latlngs.length;
+ // Redraw vectors since canvas is cleared upon removal,
+ // in case of removing the renderer itself from the map.
+ this._draw();
+ },
- this.eachLayer(function (layer) {
- if (i < len) {
- layer.setLatLngs(latlngs[i++]);
- } else {
- this.removeLayer(layer);
- }
- }, this);
+ _initContainer: function () {
+ var container = this._container = document.createElement('canvas');
- while (i < len) {
- this.addLayer(new Klass(latlngs[i++], this._options));
- }
+ L.DomEvent
+ .on(container, 'mousemove', L.Util.throttle(this._onMouseMove, 32, this), this)
+ .on(container, 'click dblclick mousedown mouseup contextmenu', this._onClick, this)
+ .on(container, 'mouseout', this._handleMouseOut, this);
- return this;
- },
+ this._ctx = container.getContext('2d');
+ },
- getLatLngs: function () {
- var latlngs = [];
+ _update: function () {
+ if (this._map._animatingZoom && this._bounds) { return; }
- this.eachLayer(function (layer) {
- latlngs.push(layer.getLatLngs());
- });
+ this._drawnLayers = {};
- return latlngs;
- }
- });
- }
+ L.Renderer.prototype._update.call(this);
- L.MultiPolyline = createMulti(L.Polyline);
- L.MultiPolygon = createMulti(L.Polygon);
+ var b = this._bounds,
+ container = this._container,
+ size = b.getSize(),
+ m = L.Browser.retina ? 2 : 1;
- L.multiPolyline = function (latlngs, options) {
- return new L.MultiPolyline(latlngs, options);
- };
+ L.DomUtil.setPosition(container, b.min);
- L.multiPolygon = function (latlngs, options) {
- return new L.MultiPolygon(latlngs, options);
- };
-}());
+ // set canvas size (also clearing it); use double size on retina
+ container.width = m * size.x;
+ container.height = m * size.y;
+ container.style.width = size.x + 'px';
+ container.style.height = size.y + 'px';
+ if (L.Browser.retina) {
+ this._ctx.scale(2, 2);
+ }
-/*
- * L.Rectangle extends Polygon and creates a rectangle when passed a LatLngBounds object.
- */
+ // translate so we use the same path coordinates after canvas element moves
+ this._ctx.translate(-b.min.x, -b.min.y);
-L.Rectangle = L.Polygon.extend({
- initialize: function (latLngBounds, options) {
- L.Polygon.prototype.initialize.call(this, this._boundsToLatLngs(latLngBounds), options);
+ // Tell paths to redraw themselves
+ this.fire('update');
},
- setBounds: function (latLngBounds) {
- this.setLatLngs(this._boundsToLatLngs(latLngBounds));
+ _initPath: function (layer) {
+ this._updateDashArray(layer);
+ this._layers[L.stamp(layer)] = layer;
},
- _boundsToLatLngs: function (latLngBounds) {
- latLngBounds = L.latLngBounds(latLngBounds);
- return [
- latLngBounds.getSouthWest(),
- latLngBounds.getNorthWest(),
- latLngBounds.getNorthEast(),
- latLngBounds.getSouthEast()
- ];
- }
-});
-
-L.rectangle = function (latLngBounds, options) {
- return new L.Rectangle(latLngBounds, options);
-};
-
-
-/*
- * L.Circle is a circle overlay (with a certain radius in meters).
- */
+ _addPath: L.Util.falseFn,
-L.Circle = L.Path.extend({
- initialize: function (latlng, radius, options) {
- L.Path.prototype.initialize.call(this, options);
+ _removePath: function (layer) {
+ layer._removed = true;
+ this._requestRedraw(layer);
+ },
- this._latlng = L.latLng(latlng);
- this._mRadius = radius;
+ _updatePath: function (layer) {
+ this._redrawBounds = layer._pxBounds;
+ this._draw(true);
+ layer._project();
+ layer._update();
+ this._draw();
+ this._redrawBounds = null;
},
- options: {
- fill: true
+ _updateStyle: function (layer) {
+ this._updateDashArray(layer);
+ this._requestRedraw(layer);
},
- setLatLng: function (latlng) {
- this._latlng = L.latLng(latlng);
- return this.redraw();
+ _updateDashArray: function (layer) {
+ if (layer.options.dashArray) {
+ var parts = layer.options.dashArray.split(','),
+ dashArray = [],
+ i;
+ for (i = 0; i < parts.length; i++) {
+ dashArray.push(Number(parts[i]));
+ }
+ layer.options._dashArray = dashArray;
+ }
},
- setRadius: function (radius) {
- this._mRadius = radius;
- return this.redraw();
+ _requestRedraw: function (layer) {
+ if (!this._map) { return; }
+
+ var padding = (layer.options.weight || 0) + 1;
+ this._redrawBounds = this._redrawBounds || new L.Bounds();
+ this._redrawBounds.extend(layer._pxBounds.min.subtract([padding, padding]));
+ this._redrawBounds.extend(layer._pxBounds.max.add([padding, padding]));
+
+ this._redrawRequest = this._redrawRequest || L.Util.requestAnimFrame(this._redraw, this);
},
- projectLatlngs: function () {
- var lngRadius = this._getLngRadius(),
- latlng = this._latlng,
- pointLeft = this._map.latLngToLayerPoint([latlng.lat, latlng.lng - lngRadius]);
+ _redraw: function () {
+ this._redrawRequest = null;
- this._point = this._map.latLngToLayerPoint(latlng);
- this._radius = Math.max(this._point.x - pointLeft.x, 1);
+ this._draw(true); // clear layers in redraw bounds
+ this._draw(); // draw layers
+
+ this._redrawBounds = null;
},
- getBounds: function () {
- var lngRadius = this._getLngRadius(),
- latRadius = (this._mRadius / 40075017) * 360,
- latlng = this._latlng;
+ _draw: function (clear) {
+ this._clear = clear;
+ var layer, bounds = this._redrawBounds;
+ this._ctx.save();
+ if (bounds) {
+ this._ctx.beginPath();
+ this._ctx.rect(bounds.min.x, bounds.min.y, bounds.max.x - bounds.min.x, bounds.max.y - bounds.min.y);
+ this._ctx.clip();
+ }
- return new L.LatLngBounds(
- [latlng.lat - latRadius, latlng.lng - lngRadius],
- [latlng.lat + latRadius, latlng.lng + lngRadius]);
+ for (var id in this._layers) {
+ layer = this._layers[id];
+ if (!bounds || (layer._pxBounds && layer._pxBounds.intersects(bounds))) {
+ layer._updatePath();
+ }
+ if (clear && layer._removed) {
+ delete layer._removed;
+ delete this._layers[id];
+ }
+ }
+ this._ctx.restore(); // Restore state before clipping.
},
- getLatLng: function () {
- return this._latlng;
- },
+ _updatePoly: function (layer, closed) {
+
+ var i, j, len2, p,
+ parts = layer._parts,
+ len = parts.length,
+ ctx = this._ctx;
- getPathString: function () {
- var p = this._point,
- r = this._radius;
+ if (!len) { return; }
- if (this._checkIfEmpty()) {
- return '';
+ this._drawnLayers[layer._leaflet_id] = layer;
+
+ ctx.beginPath();
+
+ if (ctx.setLineDash) {
+ ctx.setLineDash(layer.options && layer.options._dashArray || []);
}
- if (L.Browser.svg) {
- return 'M' + p.x + ',' + (p.y - r) +
- 'A' + r + ',' + r + ',0,1,1,' +
- (p.x - 0.1) + ',' + (p.y - r) + ' z';
- } else {
- p._round();
- r = Math.round(r);
- return 'AL ' + p.x + ',' + p.y + ' ' + r + ',' + r + ' 0,' + (65535 * 360);
+ for (i = 0; i < len; i++) {
+ for (j = 0, len2 = parts[i].length; j < len2; j++) {
+ p = parts[i][j];
+ ctx[j ? 'lineTo' : 'moveTo'](p.x, p.y);
+ }
+ if (closed) {
+ ctx.closePath();
+ }
}
- },
- getRadius: function () {
- return this._mRadius;
+ this._fillStroke(ctx, layer);
+
+ // TODO optimization: 1 fill/stroke for all features with equal style instead of 1 for each feature
},
- // TODO Earth hardcoded, move into projection code!
+ _updateCircle: function (layer) {
- _getLatRadius: function () {
- return (this._mRadius / 40075017) * 360;
- },
+ if (layer._empty()) { return; }
- _getLngRadius: function () {
- return this._getLatRadius() / Math.cos(L.LatLng.DEG_TO_RAD * this._latlng.lat);
- },
+ var p = layer._point,
+ ctx = this._ctx,
+ r = layer._radius,
+ s = (layer._radiusY || r) / r;
- _checkIfEmpty: function () {
- if (!this._map) {
- return false;
+ this._drawnLayers[layer._leaflet_id] = layer;
+
+ if (s !== 1) {
+ ctx.save();
+ ctx.scale(1, s);
}
- var vp = this._map._pathViewport,
- r = this._radius,
- p = this._point;
- return p.x - r > vp.max.x || p.y - r > vp.max.y ||
- p.x + r < vp.min.x || p.y + r < vp.min.y;
- }
-});
+ ctx.beginPath();
+ ctx.arc(p.x, p.y / s, r, 0, Math.PI * 2, false);
-L.circle = function (latlng, radius, options) {
- return new L.Circle(latlng, radius, options);
-};
+ if (s !== 1) {
+ ctx.restore();
+ }
+ this._fillStroke(ctx, layer);
+ },
-/*
- * L.CircleMarker is a circle overlay with a permanent pixel radius.
- */
+ _fillStroke: function (ctx, layer) {
+ var clear = this._clear,
+ options = layer.options;
-L.CircleMarker = L.Circle.extend({
- options: {
- radius: 10,
- weight: 2
- },
+ ctx.globalCompositeOperation = clear ? 'destination-out' : 'source-over';
- initialize: function (latlng, options) {
- L.Circle.prototype.initialize.call(this, latlng, null, options);
- this._radius = this.options.radius;
- },
+ if (options.fill) {
+ ctx.globalAlpha = clear ? 1 : options.fillOpacity;
+ ctx.fillStyle = options.fillColor || options.color;
+ ctx.fill(options.fillRule || 'evenodd');
+ }
- projectLatlngs: function () {
- this._point = this._map.latLngToLayerPoint(this._latlng);
- },
+ if (options.stroke && options.weight !== 0) {
+ ctx.globalAlpha = clear ? 1 : options.opacity;
- _updateStyle : function () {
- L.Circle.prototype._updateStyle.call(this);
- this.setRadius(this.options.radius);
- },
+ // if clearing shape, do it with the previously drawn line width
+ layer._prevWeight = ctx.lineWidth = clear ? layer._prevWeight + 1 : options.weight;
- setLatLng: function (latlng) {
- L.Circle.prototype.setLatLng.call(this, latlng);
- if (this._popup && this._popup._isOpen) {
- this._popup.setLatLng(latlng);
+ ctx.strokeStyle = options.color;
+ ctx.lineCap = options.lineCap;
+ ctx.lineJoin = options.lineJoin;
+ ctx.stroke();
}
- return this;
},
- setRadius: function (radius) {
- this.options.radius = this._radius = radius;
- return this.redraw();
- },
+ // Canvas obviously doesn't have mouse events for individual drawn objects,
+ // so we emulate that by calculating what's under the mouse on mousemove/click manually
- getRadius: function () {
- return this._radius;
- }
-});
+ _onClick: function (e) {
+ var point = this._map.mouseEventToLayerPoint(e), layers = [], layer;
-L.circleMarker = function (latlng, options) {
- return new L.CircleMarker(latlng, options);
-};
+ for (var id in this._layers) {
+ layer = this._layers[id];
+ if (layer.options.interactive && layer._containsPoint(point) && !this._map._draggableMoved(layer)) {
+ L.DomEvent._fakeStop(e);
+ layers.push(layer);
+ }
+ }
+ if (layers.length) {
+ this._fireEvent(layers, e);
+ }
+ },
+ _onMouseMove: function (e) {
+ if (!this._map || this._map.dragging.moving() || this._map._animatingZoom) { return; }
-/*
- * Extends L.Polyline to be able to manually detect clicks on Canvas-rendered polylines.
- */
+ var point = this._map.mouseEventToLayerPoint(e);
+ this._handleMouseOut(e, point);
+ this._handleMouseHover(e, point);
+ },
-L.Polyline.include(!L.Path.CANVAS ? {} : {
- _containsPoint: function (p, closed) {
- var i, j, k, len, len2, dist, part,
- w = this.options.weight / 2;
- if (L.Browser.touch) {
- w += 10; // polyline click tolerance on touch devices
+ _handleMouseOut: function (e, point) {
+ var layer = this._hoveredLayer;
+ if (layer && (e.type === 'mouseout' || !layer._containsPoint(point))) {
+ // if we're leaving the layer, fire mouseout
+ L.DomUtil.removeClass(this._container, 'leaflet-interactive');
+ this._fireEvent([layer], e, 'mouseout');
+ this._hoveredLayer = null;
}
+ },
- for (i = 0, len = this._parts.length; i < len; i++) {
- part = this._parts[i];
- for (j = 0, len2 = part.length, k = len2 - 1; j < len2; k = j++) {
- if (!closed && (j === 0)) {
- continue;
- }
-
- dist = L.LineUtil.pointToSegmentDistance(p, part[k], part[j]);
+ _handleMouseHover: function (e, point) {
+ var id, layer;
- if (dist <= w) {
- return true;
- }
+ for (id in this._drawnLayers) {
+ layer = this._drawnLayers[id];
+ if (layer.options.interactive && layer._containsPoint(point)) {
+ L.DomUtil.addClass(this._container, 'leaflet-interactive'); // change cursor
+ this._fireEvent([layer], e, 'mouseover');
+ this._hoveredLayer = layer;
}
}
- return false;
- }
-});
+ if (this._hoveredLayer) {
+ this._fireEvent([this._hoveredLayer], e);
+ }
+ },
-/*
- * Extends L.Polygon to be able to manually detect clicks on Canvas-rendered polygons.
- */
+ _fireEvent: function (layers, e, type) {
+ this._map._fireDOMEvent(e, type || e.type, layers);
+ },
-L.Polygon.include(!L.Path.CANVAS ? {} : {
- _containsPoint: function (p) {
- var inside = false,
- part, p1, p2,
- i, j, k,
- len, len2;
+ // TODO _bringToFront & _bringToBack, pretty tricky
- // TODO optimization: check if within bounds first
+ _bringToFront: L.Util.falseFn,
+ _bringToBack: L.Util.falseFn
+});
- if (L.Polyline.prototype._containsPoint.call(this, p, true)) {
- // click on polygon border
- return true;
- }
+// @namespace Browser; @property canvas: Boolean
+// `true` when the browser supports [`<canvas>`](https://developer.mozilla.org/docs/Web/API/Canvas_API).
+L.Browser.canvas = (function () {
+ return !!document.createElement('canvas').getContext;
+}());
- // ray casting algorithm for detecting if point is in polygon
+// @namespace Canvas
+// @factory L.canvas(options?: Renderer options)
+// Creates a Canvas renderer with the given options.
+L.canvas = function (options) {
+ return L.Browser.canvas ? new L.Canvas(options) : null;
+};
- for (i = 0, len = this._parts.length; i < len; i++) {
- part = this._parts[i];
+L.Polyline.prototype._containsPoint = function (p, closed) {
+ var i, j, k, len, len2, part,
+ w = this._clickTolerance();
- for (j = 0, len2 = part.length, k = len2 - 1; j < len2; k = j++) {
- p1 = part[j];
- p2 = part[k];
+ if (!this._pxBounds.contains(p)) { return false; }
- if (((p1.y > p.y) !== (p2.y > p.y)) &&
- (p.x < (p2.x - p1.x) * (p.y - p1.y) / (p2.y - p1.y) + p1.x)) {
- inside = !inside;
- }
+ // hit detection for polylines
+ for (i = 0, len = this._parts.length; i < len; i++) {
+ part = this._parts[i];
+
+ for (j = 0, len2 = part.length, k = len2 - 1; j < len2; k = j++) {
+ if (!closed && (j === 0)) { continue; }
+
+ if (L.LineUtil.pointToSegmentDistance(p, part[k], part[j]) <= w) {
+ return true;
}
}
-
- return inside;
}
-});
+ return false;
+};
+L.Polygon.prototype._containsPoint = function (p) {
+ var inside = false,
+ part, p1, p2, i, j, k, len, len2;
-/*
- * Extends L.Circle with Canvas-specific code.
- */
+ if (!this._pxBounds.contains(p)) { return false; }
-L.Circle.include(!L.Path.CANVAS ? {} : {
- _drawPath: function () {
- var p = this._point;
- this._ctx.beginPath();
- this._ctx.arc(p.x, p.y, this._radius, 0, Math.PI * 2, false);
- },
+ // ray casting algorithm for detecting if point is in polygon
+ for (i = 0, len = this._parts.length; i < len; i++) {
+ part = this._parts[i];
- _containsPoint: function (p) {
- var center = this._point,
- w2 = this.options.stroke ? this.options.weight / 2 : 0;
+ for (j = 0, len2 = part.length, k = len2 - 1; j < len2; k = j++) {
+ p1 = part[j];
+ p2 = part[k];
- return (p.distanceTo(center) <= this._radius + w2);
+ if (((p1.y > p.y) !== (p2.y > p.y)) && (p.x < (p2.x - p1.x) * (p.y - p1.y) / (p2.y - p1.y) + p1.x)) {
+ inside = !inside;
+ }
+ }
}
-});
+ // also check if it's on polygon stroke
+ return inside || L.Polyline.prototype._containsPoint.call(this, p, true);
+};
-/*
- * CircleMarker canvas specific drawing parts.
- */
+L.CircleMarker.prototype._containsPoint = function (p) {
+ return p.distanceTo(this._point) <= this._radius + this._clickTolerance();
+};
-L.CircleMarker.include(!L.Path.CANVAS ? {} : {
- _updateStyle: function () {
- L.Path.prototype._updateStyle.call(this);
- }
-});
/*
- * L.GeoJSON turns any GeoJSON data into a Leaflet layer.
+ * @class GeoJSON
+ * @aka L.GeoJSON
+ * @inherits FeatureGroup
+ *
+ * Represents a GeoJSON object or an array of GeoJSON objects. Allows you to parse
+ * GeoJSON data and display it on the map. Extends `FeatureGroup`.
+ *
+ * @example
+ *
+ * ```js
+ * L.geoJSON(data, {
+ * style: function (feature) {
+ * return {color: feature.properties.color};
+ * }
+ * }).bindPopup(function (layer) {
+ * return layer.feature.properties.description;
+ * }).addTo(map);
+ * ```
*/
L.GeoJSON = L.FeatureGroup.extend({
+ /* @section
+ * @aka GeoJSON options
+ *
+ * @option pointToLayer: Function = *
+ * A `Function` defining how GeoJSON points spawn Leaflet layers. It is internally
+ * called when data is added, passing the GeoJSON point feature and its `LatLng`.
+ * The default is to spawn a default `Marker`:
+ * ```js
+ * function(geoJsonPoint, latlng) {
+ * return L.marker(latlng);
+ * }
+ * ```
+ *
+ * @option style: Function = *
+ * A `Function` defining the `Path options` for styling GeoJSON lines and polygons,
+ * called internally when data is added.
+ * The default value is to not override any defaults:
+ * ```js
+ * function (geoJsonFeature) {
+ * return {}
+ * }
+ * ```
+ *
+ * @option onEachFeature: Function = *
+ * A `Function` that will be called once for each created `Feature`, after it has
+ * been created and styled. Useful for attaching events and popups to features.
+ * The default is to do nothing with the newly created layers:
+ * ```js
+ * function (feature, layer) {}
+ * ```
+ *
+ * @option filter: Function = *
+ * A `Function` that will be used to decide whether to show a feature or not.
+ * The default is to show all features:
+ * ```js
+ * function (geoJsonFeature) {
+ * return true;
+ * }
+ * ```
+ *
+ * @option coordsToLatLng: Function = *
+ * A `Function` that will be used for converting GeoJSON coordinates to `LatLng`s.
+ * The default is the `coordsToLatLng` static method.
+ */
+
initialize: function (geojson, options) {
L.setOptions(this, options);
}
},
+ // @function addData( <GeoJSON> data ): Layer
+ // Adds a GeoJSON object to the layer.
addData: function (geojson) {
var features = L.Util.isArray(geojson) ? geojson : geojson.features,
i, len, feature;
if (features) {
for (i = 0, len = features.length; i < len; i++) {
- // Only add this if geometry or geometries are set and not null
+ // only add this if geometry or geometries are set and not null
feature = features[i];
if (feature.geometries || feature.geometry || feature.features || feature.coordinates) {
- this.addData(features[i]);
+ this.addData(feature);
}
}
return this;
var options = this.options;
- if (options.filter && !options.filter(geojson)) { return; }
+ if (options.filter && !options.filter(geojson)) { return this; }
- var layer = L.GeoJSON.geometryToLayer(geojson, options.pointToLayer, options.coordsToLatLng, options);
+ var layer = L.GeoJSON.geometryToLayer(geojson, options);
+ if (!layer) {
+ return this;
+ }
layer.feature = L.GeoJSON.asFeature(geojson);
layer.defaultOptions = layer.options;
return this.addLayer(layer);
},
+ // @function resetStyle( <Path> layer ): Layer
+ // Resets the given vector layer's style to the original GeoJSON style, useful for resetting style after hover events.
resetStyle: function (layer) {
- var style = this.options.style;
- if (style) {
- // reset any custom styles
- L.Util.extend(layer.options, layer.defaultOptions);
-
- this._setLayerStyle(layer, style);
- }
+ // reset any custom styles
+ layer.options = L.Util.extend({}, layer.defaultOptions);
+ this._setLayerStyle(layer, this.options.style);
+ return this;
},
+ // @function setStyle( <Function> style ): Layer
+ // Changes styles of GeoJSON vector layers with the given style function.
setStyle: function (style) {
- this.eachLayer(function (layer) {
+ return this.eachLayer(function (layer) {
this._setLayerStyle(layer, style);
}, this);
},
}
});
+// @section
+// There are several static functions which can be called without instantiating L.GeoJSON:
L.extend(L.GeoJSON, {
- geometryToLayer: function (geojson, pointToLayer, coordsToLatLng, vectorOptions) {
+ // @function geometryToLayer(featureData: Object, options?: GeoJSON options): Layer
+ // Creates a `Layer` from a given GeoJSON feature. Can use a custom
+ // [`pointToLayer`](#geojson-pointtolayer) and/or [`coordsToLatLng`](#geojson-coordstolatlng)
+ // functions if provided as options.
+ geometryToLayer: function (geojson, options) {
+
var geometry = geojson.type === 'Feature' ? geojson.geometry : geojson,
- coords = geometry.coordinates,
+ coords = geometry ? geometry.coordinates : null,
layers = [],
+ pointToLayer = options && options.pointToLayer,
+ coordsToLatLng = options && options.coordsToLatLng || this.coordsToLatLng,
latlng, latlngs, i, len;
- coordsToLatLng = coordsToLatLng || this.coordsToLatLng;
+ if (!coords && !geometry) {
+ return null;
+ }
switch (geometry.type) {
case 'Point':
return new L.FeatureGroup(layers);
case 'LineString':
- latlngs = this.coordsToLatLngs(coords, 0, coordsToLatLng);
- return new L.Polyline(latlngs, vectorOptions);
-
- case 'Polygon':
- if (coords.length === 2 && !coords[1].length) {
- throw new Error('Invalid GeoJSON object.');
- }
- latlngs = this.coordsToLatLngs(coords, 1, coordsToLatLng);
- return new L.Polygon(latlngs, vectorOptions);
-
case 'MultiLineString':
- latlngs = this.coordsToLatLngs(coords, 1, coordsToLatLng);
- return new L.MultiPolyline(latlngs, vectorOptions);
+ latlngs = this.coordsToLatLngs(coords, geometry.type === 'LineString' ? 0 : 1, coordsToLatLng);
+ return new L.Polyline(latlngs, options);
+ case 'Polygon':
case 'MultiPolygon':
- latlngs = this.coordsToLatLngs(coords, 2, coordsToLatLng);
- return new L.MultiPolygon(latlngs, vectorOptions);
+ latlngs = this.coordsToLatLngs(coords, geometry.type === 'Polygon' ? 1 : 2, coordsToLatLng);
+ return new L.Polygon(latlngs, options);
case 'GeometryCollection':
for (i = 0, len = geometry.geometries.length; i < len; i++) {
-
- layers.push(this.geometryToLayer({
+ var layer = this.geometryToLayer({
geometry: geometry.geometries[i],
type: 'Feature',
properties: geojson.properties
- }, pointToLayer, coordsToLatLng, vectorOptions));
+ }, options);
+
+ if (layer) {
+ layers.push(layer);
+ }
}
return new L.FeatureGroup(layers);
}
},
- coordsToLatLng: function (coords) { // (Array[, Boolean]) -> LatLng
+ // @function coordsToLatLng(coords: Array): LatLng
+ // Creates a `LatLng` object from an array of 2 numbers (longitude, latitude)
+ // or 3 numbers (longitude, latitude, altitude) used in GeoJSON for points.
+ coordsToLatLng: function (coords) {
return new L.LatLng(coords[1], coords[0], coords[2]);
},
- coordsToLatLngs: function (coords, levelsDeep, coordsToLatLng) { // (Array[, Number, Function]) -> Array
- var latlng, i, len,
- latlngs = [];
+ // @function coordsToLatLngs(coords: Array, levelsDeep?: Number, coordsToLatLng?: Function): Array
+ // Creates a multidimensional array of `LatLng`s from a GeoJSON coordinates array.
+ // `levelsDeep` specifies the nesting level (0 is for an array of points, 1 for an array of arrays of points, etc., 0 by default).
+ // Can use a custom [`coordsToLatLng`](#geojson-coordstolatlng) function.
+ coordsToLatLngs: function (coords, levelsDeep, coordsToLatLng) {
+ var latlngs = [];
- for (i = 0, len = coords.length; i < len; i++) {
+ for (var i = 0, len = coords.length, latlng; i < len; i++) {
latlng = levelsDeep ?
this.coordsToLatLngs(coords[i], levelsDeep - 1, coordsToLatLng) :
(coordsToLatLng || this.coordsToLatLng)(coords[i]);
return latlngs;
},
+ // @function latLngToCoords(latlng: LatLng): Array
+ // Reverse of [`coordsToLatLng`](#geojson-coordstolatlng)
latLngToCoords: function (latlng) {
- var coords = [latlng.lng, latlng.lat];
-
- if (latlng.alt !== undefined) {
- coords.push(latlng.alt);
- }
- return coords;
+ return latlng.alt !== undefined ?
+ [latlng.lng, latlng.lat, latlng.alt] :
+ [latlng.lng, latlng.lat];
},
- latLngsToCoords: function (latLngs) {
+ // @function latLngsToCoords(latlngs: Array, levelsDeep?: Number, closed?: Boolean): Array
+ // Reverse of [`coordsToLatLngs`](#geojson-coordstolatlngs)
+ // `closed` determines whether the first point should be appended to the end of the array to close the feature, only used when `levelsDeep` is 0. False by default.
+ latLngsToCoords: function (latlngs, levelsDeep, closed) {
var coords = [];
- for (var i = 0, len = latLngs.length; i < len; i++) {
- coords.push(L.GeoJSON.latLngToCoords(latLngs[i]));
+ for (var i = 0, len = latlngs.length; i < len; i++) {
+ coords.push(levelsDeep ?
+ L.GeoJSON.latLngsToCoords(latlngs[i], levelsDeep - 1, closed) :
+ L.GeoJSON.latLngToCoords(latlngs[i]));
+ }
+
+ if (!levelsDeep && closed) {
+ coords.push(coords[0]);
}
return coords;
},
getFeature: function (layer, newGeometry) {
- return layer.feature ? L.extend({}, layer.feature, {geometry: newGeometry}) : L.GeoJSON.asFeature(newGeometry);
+ return layer.feature ?
+ L.extend({}, layer.feature, {geometry: newGeometry}) :
+ L.GeoJSON.asFeature(newGeometry);
},
- asFeature: function (geoJSON) {
- if (geoJSON.type === 'Feature') {
- return geoJSON;
+ // @function asFeature(geojson: Object): Object
+ // Normalize GeoJSON geometries/features into GeoJSON features.
+ asFeature: function (geojson) {
+ if (geojson.type === 'Feature') {
+ return geojson;
}
return {
type: 'Feature',
properties: {},
- geometry: geoJSON
+ geometry: geojson
};
}
});
};
L.Marker.include(PointToGeoJSON);
+
+// @namespace CircleMarker
+// @method toGeoJSON(): Object
+// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the circle marker (as a GeoJSON `Point` Feature).
L.Circle.include(PointToGeoJSON);
L.CircleMarker.include(PointToGeoJSON);
-L.Polyline.include({
- toGeoJSON: function () {
- return L.GeoJSON.getFeature(this, {
- type: 'LineString',
- coordinates: L.GeoJSON.latLngsToCoords(this.getLatLngs())
- });
+
+// @namespace Polyline
+// @method toGeoJSON(): Object
+// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the polyline (as a GeoJSON `LineString` or `MultiLineString` Feature).
+L.Polyline.prototype.toGeoJSON = function () {
+ var multi = !L.Polyline._flat(this._latlngs);
+
+ var coords = L.GeoJSON.latLngsToCoords(this._latlngs, multi ? 1 : 0);
+
+ return L.GeoJSON.getFeature(this, {
+ type: (multi ? 'Multi' : '') + 'LineString',
+ coordinates: coords
+ });
+};
+
+// @namespace Polygon
+// @method toGeoJSON(): Object
+// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the polygon (as a GeoJSON `Polygon` or `MultiPolygon` Feature).
+L.Polygon.prototype.toGeoJSON = function () {
+ var holes = !L.Polyline._flat(this._latlngs),
+ multi = holes && !L.Polyline._flat(this._latlngs[0]);
+
+ var coords = L.GeoJSON.latLngsToCoords(this._latlngs, multi ? 2 : holes ? 1 : 0, true);
+
+ if (!holes) {
+ coords = [coords];
}
-});
-L.Polygon.include({
- toGeoJSON: function () {
- var coords = [L.GeoJSON.latLngsToCoords(this.getLatLngs())],
- i, len, hole;
+ return L.GeoJSON.getFeature(this, {
+ type: (multi ? 'Multi' : '') + 'Polygon',
+ coordinates: coords
+ });
+};
- coords[0].push(coords[0][0]);
- if (this._holes) {
- for (i = 0, len = this._holes.length; i < len; i++) {
- hole = L.GeoJSON.latLngsToCoords(this._holes[i]);
- hole.push(hole[0]);
- coords.push(hole);
- }
- }
+// @namespace LayerGroup
+L.LayerGroup.include({
+ toMultiPoint: function () {
+ var coords = [];
+
+ this.eachLayer(function (layer) {
+ coords.push(layer.toGeoJSON().geometry.coordinates);
+ });
return L.GeoJSON.getFeature(this, {
- type: 'Polygon',
+ type: 'MultiPoint',
coordinates: coords
});
- }
-});
+ },
-(function () {
- function multiToGeoJSON(type) {
- return function () {
- var coords = [];
+ // @method toGeoJSON(): Object
+ // Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the layer group (as a GeoJSON `GeometryCollection`).
+ toGeoJSON: function () {
- this.eachLayer(function (layer) {
- coords.push(layer.toGeoJSON().geometry.coordinates);
- });
+ var type = this.feature && this.feature.geometry && this.feature.geometry.type;
+ if (type === 'MultiPoint') {
+ return this.toMultiPoint();
+ }
+
+ var isGeometryCollection = type === 'GeometryCollection',
+ jsons = [];
+
+ this.eachLayer(function (layer) {
+ if (layer.toGeoJSON) {
+ var json = layer.toGeoJSON();
+ jsons.push(isGeometryCollection ? json.geometry : L.GeoJSON.asFeature(json));
+ }
+ });
+
+ if (isGeometryCollection) {
return L.GeoJSON.getFeature(this, {
- type: type,
- coordinates: coords
+ geometries: jsons,
+ type: 'GeometryCollection'
});
+ }
+
+ return {
+ type: 'FeatureCollection',
+ features: jsons
};
}
+});
- L.MultiPolyline.include({toGeoJSON: multiToGeoJSON('MultiLineString')});
- L.MultiPolygon.include({toGeoJSON: multiToGeoJSON('MultiPolygon')});
+// @namespace GeoJSON
+// @factory L.geoJSON(geojson?: Object, options?: GeoJSON options)
+// Creates a GeoJSON layer. Optionally accepts an object in
+// [GeoJSON format](http://geojson.org/geojson-spec.html) to display on the map
+// (you can alternatively add it later with `addData` method) and an `options` object.
+L.geoJSON = function (geojson, options) {
+ return new L.GeoJSON(geojson, options);
+};
+// Backward compatibility.
+L.geoJson = L.geoJSON;
- L.LayerGroup.include({
- toGeoJSON: function () {
- var geometry = this.feature && this.feature.geometry,
- jsons = [],
- json;
- if (geometry && geometry.type === 'MultiPoint') {
- return multiToGeoJSON('MultiPoint').call(this);
- }
+/*
+ * @namespace DomEvent
+ * Utility functions to work with the [DOM events](https://developer.mozilla.org/docs/Web/API/Event), used by Leaflet internally.
+ */
- var isGeometryCollection = geometry && geometry.type === 'GeometryCollection';
+// Inspired by John Resig, Dean Edwards and YUI addEvent implementations.
- this.eachLayer(function (layer) {
- if (layer.toGeoJSON) {
- json = layer.toGeoJSON();
- jsons.push(isGeometryCollection ? json.geometry : L.GeoJSON.asFeature(json));
- }
- });
- if (isGeometryCollection) {
- return L.GeoJSON.getFeature(this, {
- geometries: jsons,
- type: 'GeometryCollection'
- });
+
+var eventsKey = '_leaflet_events';
+
+L.DomEvent = {
+
+ // @function on(el: HTMLElement, types: String, fn: Function, context?: Object): this
+ // Adds a listener function (`fn`) to a particular DOM event type of the
+ // element `el`. You can optionally specify the context of the listener
+ // (object the `this` keyword will point to). You can also pass several
+ // space-separated types (e.g. `'click dblclick'`).
+
+ // @alternative
+ // @function on(el: HTMLElement, eventMap: Object, context?: Object): this
+ // Adds a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}`
+ on: function (obj, types, fn, context) {
+
+ if (typeof types === 'object') {
+ for (var type in types) {
+ this._on(obj, type, types[type], fn);
}
+ } else {
+ types = L.Util.splitWords(types);
- return {
- type: 'FeatureCollection',
- features: jsons
- };
+ for (var i = 0, len = types.length; i < len; i++) {
+ this._on(obj, types[i], fn, context);
+ }
}
- });
-}());
-L.geoJson = function (geojson, options) {
- return new L.GeoJSON(geojson, options);
-};
+ return this;
+ },
+ // @function off(el: HTMLElement, types: String, fn: Function, context?: Object): this
+ // Removes a previously added listener function. If no function is specified,
+ // it will remove all the listeners of that particular DOM event from the element.
+ // Note that if you passed a custom context to on, you must pass the same
+ // context to `off` in order to remove the listener.
-/*
- * L.DomEvent contains functions for working with DOM events.
- */
+ // @alternative
+ // @function off(el: HTMLElement, eventMap: Object, context?: Object): this
+ // Removes a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}`
+ off: function (obj, types, fn, context) {
-L.DomEvent = {
- /* inspired by John Resig, Dean Edwards and YUI addEvent implementations */
- addListener: function (obj, type, fn, context) { // (HTMLElement, String, Function[, Object])
+ if (typeof types === 'object') {
+ for (var type in types) {
+ this._off(obj, type, types[type], fn);
+ }
+ } else {
+ types = L.Util.splitWords(types);
- var id = L.stamp(fn),
- key = '_leaflet_' + type + id,
- handler, originalHandler, newType;
+ for (var i = 0, len = types.length; i < len; i++) {
+ this._off(obj, types[i], fn, context);
+ }
+ }
+
+ return this;
+ },
+
+ _on: function (obj, type, fn, context) {
+ var id = type + L.stamp(fn) + (context ? '_' + L.stamp(context) : '');
- if (obj[key]) { return this; }
+ if (obj[eventsKey] && obj[eventsKey][id]) { return this; }
- handler = function (e) {
- return fn.call(context || obj, e || L.DomEvent._getEvent());
+ var handler = function (e) {
+ return fn.call(context || obj, e || window.event);
};
+ var originalHandler = handler;
+
if (L.Browser.pointer && type.indexOf('touch') === 0) {
- return this.addPointerListener(obj, type, handler, id);
- }
- if (L.Browser.touch && (type === 'dblclick') && this.addDoubleTapListener) {
+ this.addPointerListener(obj, type, handler, id);
+
+ } else if (L.Browser.touch && (type === 'dblclick') && this.addDoubleTapListener) {
this.addDoubleTapListener(obj, handler, id);
- }
- if ('addEventListener' in obj) {
+ } else if ('addEventListener' in obj) {
if (type === 'mousewheel') {
- obj.addEventListener('DOMMouseScroll', handler, false);
- obj.addEventListener(type, handler, false);
+ obj.addEventListener('onwheel' in obj ? 'wheel' : 'mousewheel', handler, false);
} else if ((type === 'mouseenter') || (type === 'mouseleave')) {
-
- originalHandler = handler;
- newType = (type === 'mouseenter' ? 'mouseover' : 'mouseout');
-
- handler = function (e) {
- if (!L.DomEvent._checkMouse(obj, e)) { return; }
- return originalHandler(e);
- };
-
- obj.addEventListener(newType, handler, false);
-
- } else if (type === 'click' && L.Browser.android) {
- originalHandler = handler;
handler = function (e) {
- return L.DomEvent._filterClick(e, originalHandler);
+ e = e || window.event;
+ if (L.DomEvent._isExternalTarget(obj, e)) {
+ originalHandler(e);
+ }
};
+ obj.addEventListener(type === 'mouseenter' ? 'mouseover' : 'mouseout', handler, false);
- obj.addEventListener(type, handler, false);
} else {
+ if (type === 'click' && L.Browser.android) {
+ handler = function (e) {
+ return L.DomEvent._filterClick(e, originalHandler);
+ };
+ }
obj.addEventListener(type, handler, false);
}
obj.attachEvent('on' + type, handler);
}
- obj[key] = handler;
+ obj[eventsKey] = obj[eventsKey] || {};
+ obj[eventsKey][id] = handler;
return this;
},
- removeListener: function (obj, type, fn) { // (HTMLElement, String, Function)
+ _off: function (obj, type, fn, context) {
- var id = L.stamp(fn),
- key = '_leaflet_' + type + id,
- handler = obj[key];
+ var id = type + L.stamp(fn) + (context ? '_' + L.stamp(context) : ''),
+ handler = obj[eventsKey] && obj[eventsKey][id];
if (!handler) { return this; }
if (L.Browser.pointer && type.indexOf('touch') === 0) {
this.removePointerListener(obj, type, id);
+
} else if (L.Browser.touch && (type === 'dblclick') && this.removeDoubleTapListener) {
this.removeDoubleTapListener(obj, id);
} else if ('removeEventListener' in obj) {
if (type === 'mousewheel') {
- obj.removeEventListener('DOMMouseScroll', handler, false);
- obj.removeEventListener(type, handler, false);
+ obj.removeEventListener('onwheel' in obj ? 'wheel' : 'mousewheel', handler, false);
- } else if ((type === 'mouseenter') || (type === 'mouseleave')) {
- obj.removeEventListener((type === 'mouseenter' ? 'mouseover' : 'mouseout'), handler, false);
} else {
- obj.removeEventListener(type, handler, false);
+ obj.removeEventListener(
+ type === 'mouseenter' ? 'mouseover' :
+ type === 'mouseleave' ? 'mouseout' : type, handler, false);
}
+
} else if ('detachEvent' in obj) {
obj.detachEvent('on' + type, handler);
}
- obj[key] = null;
+ obj[eventsKey][id] = null;
return this;
},
+ // @function stopPropagation(ev: DOMEvent): this
+ // Stop the given event from propagation to parent elements. Used inside the listener functions:
+ // ```js
+ // L.DomEvent.on(div, 'click', function (ev) {
+ // L.DomEvent.stopPropagation(ev);
+ // });
+ // ```
stopPropagation: function (e) {
if (e.stopPropagation) {
e.stopPropagation();
+ } else if (e.originalEvent) { // In case of Leaflet event.
+ e.originalEvent._stopped = true;
} else {
e.cancelBubble = true;
}
return this;
},
+ // @function disableScrollPropagation(el: HTMLElement): this
+ // Adds `stopPropagation` to the element's `'mousewheel'` events (plus browser variants).
disableScrollPropagation: function (el) {
- var stop = L.DomEvent.stopPropagation;
-
- return L.DomEvent
- .on(el, 'mousewheel', stop)
- .on(el, 'MozMousePixelScroll', stop);
+ return L.DomEvent.on(el, 'mousewheel', L.DomEvent.stopPropagation);
},
+ // @function disableClickPropagation(el: HTMLElement): this
+ // Adds `stopPropagation` to the element's `'click'`, `'doubleclick'`,
+ // `'mousedown'` and `'touchstart'` events (plus browser variants).
disableClickPropagation: function (el) {
var stop = L.DomEvent.stopPropagation;
- for (var i = L.Draggable.START.length - 1; i >= 0; i--) {
- L.DomEvent.on(el, L.Draggable.START[i], stop);
- }
+ L.DomEvent.on(el, L.Draggable.START.join(' '), stop);
- return L.DomEvent
- .on(el, 'click', L.DomEvent._fakeStop)
- .on(el, 'dblclick', stop);
+ return L.DomEvent.on(el, {
+ click: L.DomEvent._fakeStop,
+ dblclick: stop
+ });
},
+ // @function preventDefault(ev: DOMEvent): this
+ // Prevents the default action of the DOM Event `ev` from happening (such as
+ // following a link in the href of the a element, or doing a POST request
+ // with page reload when a `<form>` is submitted).
+ // Use it inside listener functions.
preventDefault: function (e) {
if (e.preventDefault) {
return this;
},
+ // @function stop(ev): this
+ // Does `stopPropagation` and `preventDefault` at the same time.
stop: function (e) {
return L.DomEvent
.preventDefault(e)
.stopPropagation(e);
},
+ // @function getMousePosition(ev: DOMEvent, container?: HTMLElement): Point
+ // Gets normalized mouse position from a DOM event relative to the
+ // `container` or to the whole page if not specified.
getMousePosition: function (e, container) {
if (!container) {
return new L.Point(e.clientX, e.clientY);
e.clientY - rect.top - container.clientTop);
},
- getWheelDelta: function (e) {
-
- var delta = 0;
+ // Chrome on Win scrolls double the pixels as in other platforms (see #4538),
+ // and Firefox scrolls device pixels, not CSS pixels
+ _wheelPxFactor: (L.Browser.win && L.Browser.chrome) ? 2 :
+ L.Browser.gecko ? window.devicePixelRatio :
+ 1,
- if (e.wheelDelta) {
- delta = e.wheelDelta / 120;
- }
- if (e.detail) {
- delta = -e.detail / 3;
- }
- return delta;
+ // @function getWheelDelta(ev: DOMEvent): Number
+ // Gets normalized wheel delta from a mousewheel DOM event, in vertical
+ // pixels scrolled (negative if scrolling down).
+ // Events from pointing devices without precise scrolling are mapped to
+ // a best guess of 60 pixels.
+ getWheelDelta: function (e) {
+ return (L.Browser.edge) ? e.wheelDeltaY / 2 : // Don't trust window-geometry-based delta
+ (e.deltaY && e.deltaMode === 0) ? -e.deltaY / L.DomEvent._wheelPxFactor : // Pixels
+ (e.deltaY && e.deltaMode === 1) ? -e.deltaY * 20 : // Lines
+ (e.deltaY && e.deltaMode === 2) ? -e.deltaY * 60 : // Pages
+ (e.deltaX || e.deltaZ) ? 0 : // Skip horizontal/depth wheel events
+ e.wheelDelta ? (e.wheelDeltaY || e.wheelDelta) / 2 : // Legacy IE pixels
+ (e.detail && Math.abs(e.detail) < 32765) ? -e.detail * 20 : // Legacy Moz lines
+ e.detail ? e.detail / -32765 * 60 : // Legacy Moz pages
+ 0;
},
_skipEvents: {},
},
// check if element really left/entered the event target (for mouseenter/mouseleave)
- _checkMouse: function (el, e) {
+ _isExternalTarget: function (el, e) {
var related = e.relatedTarget;
return (related !== el);
},
- _getEvent: function () { // evil magic for IE
- /*jshint noarg:false */
- var e = window.event;
- if (!e) {
- var caller = arguments.callee.caller;
- while (caller) {
- e = caller['arguments'][0];
- if (e && window.Event === e.constructor) {
- break;
- }
- caller = caller.caller;
- }
- }
- return e;
- },
-
// this is a horrible workaround for a bug in Android where a single touch triggers two click events
_filterClick: function (e, handler) {
- var timeStamp = (e.timeStamp || e.originalEvent.timeStamp),
- elapsed = L.DomEvent._lastClick && (timeStamp - L.DomEvent._lastClick);
+ var timeStamp = (e.timeStamp || (e.originalEvent && e.originalEvent.timeStamp)),
+ elapsed = L.DomEvent._lastClick && (timeStamp - L.DomEvent._lastClick);
// are they closer together than 500ms yet more than 100ms?
// Android typically triggers them ~300ms apart while multiple listeners
}
L.DomEvent._lastClick = timeStamp;
- return handler(e);
+ handler(e);
}
};
-L.DomEvent.on = L.DomEvent.addListener;
-L.DomEvent.off = L.DomEvent.removeListener;
+// @function addListener(…): this
+// Alias to [`L.DomEvent.on`](#domevent-on)
+L.DomEvent.addListener = L.DomEvent.on;
+
+// @function removeListener(…): this
+// Alias to [`L.DomEvent.off`](#domevent-off)
+L.DomEvent.removeListener = L.DomEvent.off;
+
/*
- * L.Draggable allows you to add dragging capabilities to any element. Supports mobile devices too.
+ * @class Draggable
+ * @aka L.Draggable
+ * @inherits Evented
+ *
+ * A class for making DOM elements draggable (including touch support).
+ * Used internally for map and marker dragging. Only works for elements
+ * that were positioned with [`L.DomUtil.setPosition`](#domutil-setposition).
+ *
+ * @example
+ * ```js
+ * var draggable = new L.Draggable(elementToDrag);
+ * draggable.enable();
+ * ```
*/
-L.Draggable = L.Class.extend({
- includes: L.Mixin.Events,
+L.Draggable = L.Evented.extend({
+
+ options: {
+ // @option clickTolerance: Number = 3
+ // The max number of pixels a user can shift the mouse pointer during a click
+ // for it to be considered a valid click (as opposed to a mouse drag).
+ clickTolerance: 3
+ },
statics: {
START: L.Browser.touch ? ['touchstart', 'mousedown'] : ['mousedown'],
}
},
- initialize: function (element, dragStartTarget) {
+ // @constructor L.Draggable(el: HTMLElement, dragHandle?: HTMLElement, preventOutline: Boolean)
+ // Creates a `Draggable` object for moving `el` when you start dragging the `dragHandle` element (equals `el` itself by default).
+ initialize: function (element, dragStartTarget, preventOutline) {
this._element = element;
this._dragStartTarget = dragStartTarget || element;
+ this._preventOutline = preventOutline;
},
+ // @method enable()
+ // Enables the dragging ability
enable: function () {
if (this._enabled) { return; }
- for (var i = L.Draggable.START.length - 1; i >= 0; i--) {
- L.DomEvent.on(this._dragStartTarget, L.Draggable.START[i], this._onDown, this);
- }
+ L.DomEvent.on(this._dragStartTarget, L.Draggable.START.join(' '), this._onDown, this);
this._enabled = true;
},
+ // @method disable()
+ // Disables the dragging ability
disable: function () {
if (!this._enabled) { return; }
- for (var i = L.Draggable.START.length - 1; i >= 0; i--) {
- L.DomEvent.off(this._dragStartTarget, L.Draggable.START[i], this._onDown, this);
- }
+ L.DomEvent.off(this._dragStartTarget, L.Draggable.START.join(' '), this._onDown, this);
this._enabled = false;
this._moved = false;
},
_onDown: function (e) {
+ // Ignore simulated events, since we handle both touch and
+ // mouse explicitly; otherwise we risk getting duplicates of
+ // touch events, see #4315.
+ // Also ignore the event if disabled; this happens in IE11
+ // under some circumstances, see #3666.
+ if (e._simulated || !this._enabled) { return; }
+
this._moved = false;
- if (e.shiftKey || ((e.which !== 1) && (e.button !== 1) && !e.touches)) { return; }
+ if (L.DomUtil.hasClass(this._element, 'leaflet-zoom-anim')) { return; }
- L.DomEvent.stopPropagation(e);
+ if (L.Draggable._dragging || e.shiftKey || ((e.which !== 1) && (e.button !== 1) && !e.touches) || !this._enabled) { return; }
+ L.Draggable._dragging = true; // Prevent dragging multiple objects at once.
- if (L.Draggable._disabled) { return; }
+ if (this._preventOutline) {
+ L.DomUtil.preventOutline(this._element);
+ }
L.DomUtil.disableImageDrag();
L.DomUtil.disableTextSelection();
if (this._moving) { return; }
+ // @event down: Event
+ // Fired when a drag is about to start.
+ this.fire('down');
+
var first = e.touches ? e.touches[0] : e;
this._startPoint = new L.Point(first.clientX, first.clientY);
- this._startPos = this._newPos = L.DomUtil.getPosition(this._element);
L.DomEvent
- .on(document, L.Draggable.MOVE[e.type], this._onMove, this)
- .on(document, L.Draggable.END[e.type], this._onUp, this);
+ .on(document, L.Draggable.MOVE[e.type], this._onMove, this)
+ .on(document, L.Draggable.END[e.type], this._onUp, this);
},
_onMove: function (e) {
+ // Ignore simulated events, since we handle both touch and
+ // mouse explicitly; otherwise we risk getting duplicates of
+ // touch events, see #4315.
+ // Also ignore the event if disabled; this happens in IE11
+ // under some circumstances, see #3666.
+ if (e._simulated || !this._enabled) { return; }
+
if (e.touches && e.touches.length > 1) {
this._moved = true;
return;
offset = newPoint.subtract(this._startPoint);
if (!offset.x && !offset.y) { return; }
- if (L.Browser.touch && Math.abs(offset.x) + Math.abs(offset.y) < 3) { return; }
+ if (Math.abs(offset.x) + Math.abs(offset.y) < this.options.clickTolerance) { return; }
L.DomEvent.preventDefault(e);
if (!this._moved) {
+ // @event dragstart: Event
+ // Fired when a drag starts
this.fire('dragstart');
this._moved = true;
this._startPos = L.DomUtil.getPosition(this._element).subtract(offset);
L.DomUtil.addClass(document.body, 'leaflet-dragging');
+
this._lastTarget = e.target || e.srcElement;
+ // IE and Edge do not give the <use> element, so fetch it
+ // if necessary
+ if ((window.SVGElementInstance) && (this._lastTarget instanceof SVGElementInstance)) {
+ this._lastTarget = this._lastTarget.correspondingUseElement;
+ }
L.DomUtil.addClass(this._lastTarget, 'leaflet-drag-target');
}
this._moving = true;
L.Util.cancelAnimFrame(this._animRequest);
- this._animRequest = L.Util.requestAnimFrame(this._updatePosition, this, true, this._dragStartTarget);
+ this._lastEvent = e;
+ this._animRequest = L.Util.requestAnimFrame(this._updatePosition, this, true);
},
_updatePosition: function () {
- this.fire('predrag');
+ var e = {originalEvent: this._lastEvent};
+
+ // @event predrag: Event
+ // Fired continuously during dragging *before* each corresponding
+ // update of the element's position.
+ this.fire('predrag', e);
L.DomUtil.setPosition(this._element, this._newPos);
- this.fire('drag');
+
+ // @event drag: Event
+ // Fired continuously during dragging.
+ this.fire('drag', e);
},
- _onUp: function () {
+ _onUp: function (e) {
+ // Ignore simulated events, since we handle both touch and
+ // mouse explicitly; otherwise we risk getting duplicates of
+ // touch events, see #4315.
+ // Also ignore the event if disabled; this happens in IE11
+ // under some circumstances, see #3666.
+ if (e._simulated || !this._enabled) { return; }
+
L.DomUtil.removeClass(document.body, 'leaflet-dragging');
if (this._lastTarget) {
for (var i in L.Draggable.MOVE) {
L.DomEvent
- .off(document, L.Draggable.MOVE[i], this._onMove)
- .off(document, L.Draggable.END[i], this._onUp);
+ .off(document, L.Draggable.MOVE[i], this._onMove, this)
+ .off(document, L.Draggable.END[i], this._onUp, this);
}
L.DomUtil.enableImageDrag();
// ensure drag is not fired after dragend
L.Util.cancelAnimFrame(this._animRequest);
+ // @event dragend: DragEndEvent
+ // Fired when the drag ends.
this.fire('dragend', {
distance: this._newPos.distanceTo(this._startPos)
});
}
this._moving = false;
+ L.Draggable._dragging = false;
}
});
+
/*
L.Handler is a base class for handler classes that are used internally to inject
interaction features like dragging to classes like Map and Marker.
*/
+// @class Handler
+// @aka L.Handler
+// Abstract class for map interaction handlers
+
L.Handler = L.Class.extend({
initialize: function (map) {
this._map = map;
},
+ // @method enable(): this
+ // Enables the handler
enable: function () {
- if (this._enabled) { return; }
+ if (this._enabled) { return this; }
this._enabled = true;
this.addHooks();
+ return this;
},
+ // @method disable(): this
+ // Disables the handler
disable: function () {
- if (!this._enabled) { return; }
+ if (!this._enabled) { return this; }
this._enabled = false;
this.removeHooks();
+ return this;
},
+ // @method enabled(): Boolean
+ // Returns `true` if the handler is enabled
enabled: function () {
return !!this._enabled;
}
+
+ // @section Extension methods
+ // Classes inheriting from `Handler` must implement the two following methods:
+ // @method addHooks()
+ // Called when the handler is enabled, should add event hooks.
+ // @method removeHooks()
+ // Called when the handler is disabled, should remove the event hooks added previously.
});
+
/*
* L.Handler.MapDrag is used to make the map draggable (with panning inertia), enabled by default.
*/
+// @namespace Map
+// @section Interaction Options
L.Map.mergeOptions({
+ // @option dragging: Boolean = true
+ // Whether the map be draggable with mouse/touch or not.
dragging: true,
+ // @section Panning Inertia Options
+ // @option inertia: Boolean = *
+ // If enabled, panning of the map will have an inertia effect where
+ // the map builds momentum while dragging and continues moving in
+ // the same direction for some time. Feels especially nice on touch
+ // devices. Enabled by default unless running on old Android devices.
inertia: !L.Browser.android23,
+
+ // @option inertiaDeceleration: Number = 3000
+ // The rate with which the inertial movement slows down, in pixels/second².
inertiaDeceleration: 3400, // px/s^2
+
+ // @option inertiaMaxSpeed: Number = Infinity
+ // Max speed of the inertial movement, in pixels/second.
inertiaMaxSpeed: Infinity, // px/s
- inertiaThreshold: L.Browser.touch ? 32 : 18, // ms
- easeLinearity: 0.25,
+
+ // @option easeLinearity: Number = 0.2
+ easeLinearity: 0.2,
// TODO refactor, move to CRS
- worldCopyJump: false
+ // @option worldCopyJump: Boolean = false
+ // With this option enabled, the map tracks when you pan to another "copy"
+ // of the world and seamlessly jumps to the original one so that all overlays
+ // like markers and vector layers are still visible.
+ worldCopyJump: false,
+
+ // @option maxBoundsViscosity: Number = 0.0
+ // If `maxBounds` is set, this option will control how solid the bounds
+ // are when dragging the map around. The default value of `0.0` allows the
+ // user to drag outside the bounds at normal speed, higher values will
+ // slow down map dragging outside bounds, and `1.0` makes the bounds fully
+ // solid, preventing the user from dragging outside the bounds.
+ maxBoundsViscosity: 0.0
});
L.Map.Drag = L.Handler.extend({
this._draggable = new L.Draggable(map._mapPane, map._container);
this._draggable.on({
- 'dragstart': this._onDragStart,
- 'drag': this._onDrag,
- 'dragend': this._onDragEnd
+ down: this._onDown,
+ dragstart: this._onDragStart,
+ drag: this._onDrag,
+ dragend: this._onDragEnd
}, this);
+ this._draggable.on('predrag', this._onPreDragLimit, this);
if (map.options.worldCopyJump) {
- this._draggable.on('predrag', this._onPreDrag, this);
- map.on('viewreset', this._onViewReset, this);
+ this._draggable.on('predrag', this._onPreDragWrap, this);
+ map.on('zoomend', this._onZoomEnd, this);
- map.whenReady(this._onViewReset, this);
+ map.whenReady(this._onZoomEnd, this);
}
}
+ L.DomUtil.addClass(this._map._container, 'leaflet-grab leaflet-touch-drag');
this._draggable.enable();
+ this._positions = [];
+ this._times = [];
},
removeHooks: function () {
+ L.DomUtil.removeClass(this._map._container, 'leaflet-grab');
+ L.DomUtil.removeClass(this._map._container, 'leaflet-touch-drag');
this._draggable.disable();
},
return this._draggable && this._draggable._moved;
},
+ moving: function () {
+ return this._draggable && this._draggable._moving;
+ },
+
+ _onDown: function () {
+ this._map._stop();
+ },
+
_onDragStart: function () {
var map = this._map;
- if (map._panAnim) {
- map._panAnim.stop();
+ if (this._map.options.maxBounds && this._map.options.maxBoundsViscosity) {
+ var bounds = L.latLngBounds(this._map.options.maxBounds);
+
+ this._offsetLimit = L.bounds(
+ this._map.latLngToContainerPoint(bounds.getNorthWest()).multiplyBy(-1),
+ this._map.latLngToContainerPoint(bounds.getSouthEast()).multiplyBy(-1)
+ .add(this._map.getSize()));
+
+ this._viscosity = Math.min(1.0, Math.max(0.0, this._map.options.maxBoundsViscosity));
+ } else {
+ this._offsetLimit = null;
}
map
}
},
- _onDrag: function () {
+ _onDrag: function (e) {
if (this._map.options.inertia) {
var time = this._lastTime = +new Date(),
- pos = this._lastPos = this._draggable._newPos;
+ pos = this._lastPos = this._draggable._absPos || this._draggable._newPos;
this._positions.push(pos);
this._times.push(time);
- if (time - this._times[0] > 200) {
+ if (time - this._times[0] > 50) {
this._positions.shift();
this._times.shift();
}
}
this._map
- .fire('move')
- .fire('drag');
+ .fire('move', e)
+ .fire('drag', e);
},
- _onViewReset: function () {
- // TODO fix hardcoded Earth values
- var pxCenter = this._map.getSize()._divideBy(2),
+ _onZoomEnd: function () {
+ var pxCenter = this._map.getSize().divideBy(2),
pxWorldCenter = this._map.latLngToLayerPoint([0, 0]);
this._initialWorldOffset = pxWorldCenter.subtract(pxCenter).x;
- this._worldWidth = this._map.project([0, 180]).x;
+ this._worldWidth = this._map.getPixelWorldBounds().getSize().x;
+ },
+
+ _viscousLimit: function (value, threshold) {
+ return value - (value - threshold) * this._viscosity;
+ },
+
+ _onPreDragLimit: function () {
+ if (!this._viscosity || !this._offsetLimit) { return; }
+
+ var offset = this._draggable._newPos.subtract(this._draggable._startPos);
+
+ var limit = this._offsetLimit;
+ if (offset.x < limit.min.x) { offset.x = this._viscousLimit(offset.x, limit.min.x); }
+ if (offset.y < limit.min.y) { offset.y = this._viscousLimit(offset.y, limit.min.y); }
+ if (offset.x > limit.max.x) { offset.x = this._viscousLimit(offset.x, limit.max.x); }
+ if (offset.y > limit.max.y) { offset.y = this._viscousLimit(offset.y, limit.max.y); }
+
+ this._draggable._newPos = this._draggable._startPos.add(offset);
},
- _onPreDrag: function () {
+ _onPreDragWrap: function () {
// TODO refactor to be able to adjust map pane position after zoom
var worldWidth = this._worldWidth,
halfWidth = Math.round(worldWidth / 2),
newX2 = (x + halfWidth + dx) % worldWidth - halfWidth - dx,
newX = Math.abs(newX1 + dx) < Math.abs(newX2 + dx) ? newX1 : newX2;
+ this._draggable._absPos = this._draggable._newPos.clone();
this._draggable._newPos.x = newX;
},
_onDragEnd: function (e) {
var map = this._map,
options = map.options,
- delay = +new Date() - this._lastTime,
- noInertia = !options.inertia || delay > options.inertiaThreshold || !this._positions[0];
+ noInertia = !options.inertia || this._times.length < 2;
map.fire('dragend', e);
} else {
var direction = this._lastPos.subtract(this._positions[0]),
- duration = (this._lastTime + delay - this._times[0]) / 1000,
+ duration = (this._lastTime - this._times[0]) / 1000,
ease = options.easeLinearity,
speedVector = direction.multiplyBy(ease / duration),
decelerationDuration = limitedSpeed / (options.inertiaDeceleration * ease),
offset = limitedSpeedVector.multiplyBy(-decelerationDuration / 2).round();
- if (!offset.x || !offset.y) {
+ if (!offset.x && !offset.y) {
map.fire('moveend');
} else {
map.panBy(offset, {
duration: decelerationDuration,
easeLinearity: ease,
- noMoveStart: true
+ noMoveStart: true,
+ animate: true
});
});
}
}
});
+// @section Handlers
+// @property dragging: Handler
+// Map dragging handler (by both mouse and touch).
L.Map.addInitHook('addHandler', 'dragging', L.Map.Drag);
+
/*
* L.Handler.DoubleClickZoom is used to handle double-click zoom on the map, enabled by default.
*/
+// @namespace Map
+// @section Interaction Options
+
L.Map.mergeOptions({
+ // @option doubleClickZoom: Boolean|String = true
+ // Whether the map can be zoomed in by double clicking on it and
+ // zoomed out by double clicking while holding shift. If passed
+ // `'center'`, double-click zoom will zoom to the center of the
+ // view regardless of where the mouse was.
doubleClickZoom: true
});
_onDoubleClick: function (e) {
var map = this._map,
- zoom = map.getZoom() + (e.originalEvent.shiftKey ? -1 : 1);
+ oldZoom = map.getZoom(),
+ delta = map.options.zoomDelta,
+ zoom = e.originalEvent.shiftKey ? oldZoom - delta : oldZoom + delta;
if (map.options.doubleClickZoom === 'center') {
map.setZoom(zoom);
}
});
+// @section Handlers
+//
+// Map properties include interaction handlers that allow you to control
+// interaction behavior in runtime, enabling or disabling certain features such
+// as dragging or touch zoom (see `Handler` methods). For example:
+//
+// ```js
+// map.doubleClickZoom.disable();
+// ```
+//
+// @property doubleClickZoom: Handler
+// Double click zoom handler.
L.Map.addInitHook('addHandler', 'doubleClickZoom', L.Map.DoubleClickZoom);
+
/*
* L.Handler.ScrollWheelZoom is used by L.Map to enable mouse scroll wheel zoom on the map.
*/
+// @namespace Map
+// @section Interaction Options
L.Map.mergeOptions({
- scrollWheelZoom: true
+ // @section Mousewheel options
+ // @option scrollWheelZoom: Boolean|String = true
+ // Whether the map can be zoomed by using the mouse wheel. If passed `'center'`,
+ // it will zoom to the center of the view regardless of where the mouse was.
+ scrollWheelZoom: true,
+
+ // @option wheelDebounceTime: Number = 40
+ // Limits the rate at which a wheel can fire (in milliseconds). By default
+ // user can't zoom via wheel more often than once per 40 ms.
+ wheelDebounceTime: 40,
+
+ // @option wheelPxPerZoomLevel: Number = 60
+ // How many scroll pixels (as reported by [L.DomEvent.getWheelDelta](#domevent-getwheeldelta))
+ // mean a change of one full zoom level. Smaller values will make wheel-zooming
+ // faster (and vice versa).
+ wheelPxPerZoomLevel: 60
});
L.Map.ScrollWheelZoom = L.Handler.extend({
addHooks: function () {
L.DomEvent.on(this._map._container, 'mousewheel', this._onWheelScroll, this);
- L.DomEvent.on(this._map._container, 'MozMousePixelScroll', L.DomEvent.preventDefault);
+
this._delta = 0;
},
removeHooks: function () {
- L.DomEvent.off(this._map._container, 'mousewheel', this._onWheelScroll);
- L.DomEvent.off(this._map._container, 'MozMousePixelScroll', L.DomEvent.preventDefault);
+ L.DomEvent.off(this._map._container, 'mousewheel', this._onWheelScroll, this);
},
_onWheelScroll: function (e) {
var delta = L.DomEvent.getWheelDelta(e);
+ var debounce = this._map.options.wheelDebounceTime;
+
this._delta += delta;
this._lastMousePos = this._map.mouseEventToContainerPoint(e);
this._startTime = +new Date();
}
- var left = Math.max(40 - (+new Date() - this._startTime), 0);
+ var left = Math.max(debounce - (+new Date() - this._startTime), 0);
clearTimeout(this._timer);
this._timer = setTimeout(L.bind(this._performZoom, this), left);
- L.DomEvent.preventDefault(e);
- L.DomEvent.stopPropagation(e);
+ L.DomEvent.stop(e);
},
_performZoom: function () {
var map = this._map,
- delta = this._delta,
- zoom = map.getZoom();
+ zoom = map.getZoom(),
+ snap = this._map.options.zoomSnap || 0;
- delta = delta > 0 ? Math.ceil(delta) : Math.floor(delta);
- delta = Math.max(Math.min(delta, 4), -4);
- delta = map._limitZoom(zoom + delta) - zoom;
+ map._stop(); // stop panning and fly animations if any
+
+ // map the delta with a sigmoid function to -4..4 range leaning on -1..1
+ var d2 = this._delta / (this._map.options.wheelPxPerZoomLevel * 4),
+ d3 = 4 * Math.log(2 / (1 + Math.exp(-Math.abs(d2)))) / Math.LN2,
+ d4 = snap ? Math.ceil(d3 / snap) * snap : d3,
+ delta = map._limitZoom(zoom + (this._delta > 0 ? d4 : -d4)) - zoom;
this._delta = 0;
this._startTime = null;
}
});
+// @section Handlers
+// @property scrollWheelZoom: Handler
+// Scroll wheel zoom handler.
L.Map.addInitHook('addHandler', 'scrollWheelZoom', L.Map.ScrollWheelZoom);
+
/*
* Extends the event handling code with double tap support for mobile browsers.
*/
// inspired by Zepto touch code by Thomas Fuchs
addDoubleTapListener: function (obj, handler, id) {
- var last,
+ var last, touch,
doubleTap = false,
- delay = 250,
- touch,
- pre = '_leaflet_',
- touchstart = this._touchstart,
- touchend = this._touchend,
- trackedTouches = [];
+ delay = 250;
function onTouchStart(e) {
var count;
if (L.Browser.pointer) {
- trackedTouches.push(e.pointerId);
- count = trackedTouches.length;
+ count = L.DomEvent._pointersCount;
} else {
count = e.touches.length;
}
- if (count > 1) {
- return;
- }
+
+ if (count > 1) { return; }
var now = Date.now(),
- delta = now - (last || now);
+ delta = now - (last || now);
touch = e.touches ? e.touches[0] : e;
doubleTap = (delta > 0 && delta <= delay);
last = now;
}
- function onTouchEnd(e) {
- if (L.Browser.pointer) {
- var idx = trackedTouches.indexOf(e.pointerId);
- if (idx === -1) {
- return;
- }
- trackedTouches.splice(idx, 1);
- }
-
- if (doubleTap) {
+ function onTouchEnd() {
+ if (doubleTap && !touch.cancelBubble) {
if (L.Browser.pointer) {
// work around .type being readonly with MSPointer* events
- var newTouch = { },
- prop;
+ var newTouch = {},
+ prop, i;
- // jshint forin:false
- for (var i in touch) {
+ for (i in touch) {
prop = touch[i];
- if (typeof prop === 'function') {
- newTouch[i] = prop.bind(touch);
- } else {
- newTouch[i] = prop;
- }
+ newTouch[i] = prop && prop.bind ? prop.bind(touch) : prop;
}
touch = newTouch;
}
last = null;
}
}
+
+ var pre = '_leaflet_',
+ touchstart = this._touchstart,
+ touchend = this._touchend;
+
obj[pre + touchstart + id] = onTouchStart;
obj[pre + touchend + id] = onTouchEnd;
-
- // on pointer we need to listen on the document, otherwise a drag starting on the map and moving off screen
- // will not come through to us, so we will lose track of how many touches are ongoing
- var endElement = L.Browser.pointer ? document.documentElement : obj;
+ obj[pre + 'dblclick' + id] = handler;
obj.addEventListener(touchstart, onTouchStart, false);
- endElement.addEventListener(touchend, onTouchEnd, false);
+ obj.addEventListener(touchend, onTouchEnd, false);
- if (L.Browser.pointer) {
- endElement.addEventListener(L.DomEvent.POINTER_CANCEL, onTouchEnd, false);
+ // On some platforms (notably, chrome on win10 + touchscreen + mouse),
+ // the browser doesn't fire touchend/pointerup events but does fire
+ // native dblclicks. See #4127.
+ if (!L.Browser.edge) {
+ obj.addEventListener('dblclick', handler, false);
}
return this;
},
removeDoubleTapListener: function (obj, id) {
- var pre = '_leaflet_';
-
- obj.removeEventListener(this._touchstart, obj[pre + this._touchstart + id], false);
- (L.Browser.pointer ? document.documentElement : obj).removeEventListener(
- this._touchend, obj[pre + this._touchend + id], false);
+ var pre = '_leaflet_',
+ touchstart = obj[pre + this._touchstart + id],
+ touchend = obj[pre + this._touchend + id],
+ dblclick = obj[pre + 'dblclick' + id];
- if (L.Browser.pointer) {
- document.documentElement.removeEventListener(L.DomEvent.POINTER_CANCEL, obj[pre + this._touchend + id],
- false);
+ obj.removeEventListener(this._touchstart, touchstart, false);
+ obj.removeEventListener(this._touchend, touchend, false);
+ if (!L.Browser.edge) {
+ obj.removeEventListener('dblclick', dblclick, false);
}
return this;
});
+
/*
* Extends L.DomEvent to provide touch support for Internet Explorer and Windows-based devices.
*/
L.extend(L.DomEvent, {
- //static
- POINTER_DOWN: L.Browser.msPointer ? 'MSPointerDown' : 'pointerdown',
- POINTER_MOVE: L.Browser.msPointer ? 'MSPointerMove' : 'pointermove',
- POINTER_UP: L.Browser.msPointer ? 'MSPointerUp' : 'pointerup',
+ POINTER_DOWN: L.Browser.msPointer ? 'MSPointerDown' : 'pointerdown',
+ POINTER_MOVE: L.Browser.msPointer ? 'MSPointerMove' : 'pointermove',
+ POINTER_UP: L.Browser.msPointer ? 'MSPointerUp' : 'pointerup',
POINTER_CANCEL: L.Browser.msPointer ? 'MSPointerCancel' : 'pointercancel',
+ TAG_WHITE_LIST: ['INPUT', 'SELECT', 'OPTION'],
- _pointers: [],
- _pointerDocumentListener: false,
+ _pointers: {},
+ _pointersCount: 0,
// Provides a touch events wrapper for (ms)pointer events.
- // Based on changes by veproza https://github.com/CloudMade/Leaflet/pull/1019
- //ref http://www.w3.org/TR/pointerevents/ https://www.w3.org/Bugs/Public/show_bug.cgi?id=22890
+ // ref http://www.w3.org/TR/pointerevents/ https://www.w3.org/Bugs/Public/show_bug.cgi?id=22890
addPointerListener: function (obj, type, handler, id) {
- switch (type) {
- case 'touchstart':
- return this.addPointerListenerStart(obj, type, handler, id);
- case 'touchend':
- return this.addPointerListenerEnd(obj, type, handler, id);
- case 'touchmove':
- return this.addPointerListenerMove(obj, type, handler, id);
- default:
- throw 'Unknown touch event type';
- }
- },
+ if (type === 'touchstart') {
+ this._addPointerStart(obj, handler, id);
- addPointerListenerStart: function (obj, type, handler, id) {
- var pre = '_leaflet_',
- pointers = this._pointers;
+ } else if (type === 'touchmove') {
+ this._addPointerMove(obj, handler, id);
- var cb = function (e) {
- if (e.pointerType !== 'mouse' && e.pointerType !== e.MSPOINTER_TYPE_MOUSE) {
- L.DomEvent.preventDefault(e);
- }
+ } else if (type === 'touchend') {
+ this._addPointerEnd(obj, handler, id);
+ }
- var alreadyInArray = false;
- for (var i = 0; i < pointers.length; i++) {
- if (pointers[i].pointerId === e.pointerId) {
- alreadyInArray = true;
- break;
- }
- }
- if (!alreadyInArray) {
- pointers.push(e);
- }
+ return this;
+ },
- e.touches = pointers.slice();
- e.changedTouches = [e];
+ removePointerListener: function (obj, type, id) {
+ var handler = obj['_leaflet_' + type + id];
- handler(e);
- };
+ if (type === 'touchstart') {
+ obj.removeEventListener(this.POINTER_DOWN, handler, false);
- obj[pre + 'touchstart' + id] = cb;
- obj.addEventListener(this.POINTER_DOWN, cb, false);
-
- // need to also listen for end events to keep the _pointers list accurate
- // this needs to be on the body and never go away
- if (!this._pointerDocumentListener) {
- var internalCb = function (e) {
- for (var i = 0; i < pointers.length; i++) {
- if (pointers[i].pointerId === e.pointerId) {
- pointers.splice(i, 1);
- break;
- }
- }
- };
- //We listen on the documentElement as any drags that end by moving the touch off the screen get fired there
- document.documentElement.addEventListener(this.POINTER_UP, internalCb, false);
- document.documentElement.addEventListener(this.POINTER_CANCEL, internalCb, false);
+ } else if (type === 'touchmove') {
+ obj.removeEventListener(this.POINTER_MOVE, handler, false);
- this._pointerDocumentListener = true;
+ } else if (type === 'touchend') {
+ obj.removeEventListener(this.POINTER_UP, handler, false);
+ obj.removeEventListener(this.POINTER_CANCEL, handler, false);
}
return this;
},
- addPointerListenerMove: function (obj, type, handler, id) {
- var pre = '_leaflet_',
- touches = this._pointers;
+ _addPointerStart: function (obj, handler, id) {
+ var onDown = L.bind(function (e) {
+ if (e.pointerType !== 'mouse' && e.pointerType !== e.MSPOINTER_TYPE_MOUSE) {
+ // In IE11, some touch events needs to fire for form controls, or
+ // the controls will stop working. We keep a whitelist of tag names that
+ // need these events. For other target tags, we prevent default on the event.
+ if (this.TAG_WHITE_LIST.indexOf(e.target.tagName) < 0) {
+ L.DomEvent.preventDefault(e);
+ } else {
+ return;
+ }
+ }
- function cb(e) {
+ this._handlePointer(e, handler);
+ }, this);
- // don't fire touch moves when mouse isn't down
- if ((e.pointerType === e.MSPOINTER_TYPE_MOUSE || e.pointerType === 'mouse') && e.buttons === 0) { return; }
+ obj['_leaflet_touchstart' + id] = onDown;
+ obj.addEventListener(this.POINTER_DOWN, onDown, false);
- for (var i = 0; i < touches.length; i++) {
- if (touches[i].pointerId === e.pointerId) {
- touches[i] = e;
- break;
- }
- }
+ // need to keep track of what pointers and how many are active to provide e.touches emulation
+ if (!this._pointerDocListener) {
+ var pointerUp = L.bind(this._globalPointerUp, this);
- e.touches = touches.slice();
- e.changedTouches = [e];
+ // we listen documentElement as any drags that end by moving the touch off the screen get fired there
+ document.documentElement.addEventListener(this.POINTER_DOWN, L.bind(this._globalPointerDown, this), true);
+ document.documentElement.addEventListener(this.POINTER_MOVE, L.bind(this._globalPointerMove, this), true);
+ document.documentElement.addEventListener(this.POINTER_UP, pointerUp, true);
+ document.documentElement.addEventListener(this.POINTER_CANCEL, pointerUp, true);
- handler(e);
+ this._pointerDocListener = true;
}
+ },
- obj[pre + 'touchmove' + id] = cb;
- obj.addEventListener(this.POINTER_MOVE, cb, false);
+ _globalPointerDown: function (e) {
+ this._pointers[e.pointerId] = e;
+ this._pointersCount++;
+ },
- return this;
+ _globalPointerMove: function (e) {
+ if (this._pointers[e.pointerId]) {
+ this._pointers[e.pointerId] = e;
+ }
},
- addPointerListenerEnd: function (obj, type, handler, id) {
- var pre = '_leaflet_',
- touches = this._pointers;
+ _globalPointerUp: function (e) {
+ delete this._pointers[e.pointerId];
+ this._pointersCount--;
+ },
- var cb = function (e) {
- for (var i = 0; i < touches.length; i++) {
- if (touches[i].pointerId === e.pointerId) {
- touches.splice(i, 1);
- break;
- }
- }
+ _handlePointer: function (e, handler) {
+ e.touches = [];
+ for (var i in this._pointers) {
+ e.touches.push(this._pointers[i]);
+ }
+ e.changedTouches = [e];
- e.touches = touches.slice();
- e.changedTouches = [e];
+ handler(e);
+ },
- handler(e);
- };
+ _addPointerMove: function (obj, handler, id) {
+ var onMove = L.bind(function (e) {
+ // don't fire touch moves when mouse isn't down
+ if ((e.pointerType === e.MSPOINTER_TYPE_MOUSE || e.pointerType === 'mouse') && e.buttons === 0) { return; }
- obj[pre + 'touchend' + id] = cb;
- obj.addEventListener(this.POINTER_UP, cb, false);
- obj.addEventListener(this.POINTER_CANCEL, cb, false);
+ this._handlePointer(e, handler);
+ }, this);
- return this;
+ obj['_leaflet_touchmove' + id] = onMove;
+ obj.addEventListener(this.POINTER_MOVE, onMove, false);
},
- removePointerListener: function (obj, type, id) {
- var pre = '_leaflet_',
- cb = obj[pre + type + id];
-
- switch (type) {
- case 'touchstart':
- obj.removeEventListener(this.POINTER_DOWN, cb, false);
- break;
- case 'touchmove':
- obj.removeEventListener(this.POINTER_MOVE, cb, false);
- break;
- case 'touchend':
- obj.removeEventListener(this.POINTER_UP, cb, false);
- obj.removeEventListener(this.POINTER_CANCEL, cb, false);
- break;
- }
+ _addPointerEnd: function (obj, handler, id) {
+ var onUp = L.bind(function (e) {
+ this._handlePointer(e, handler);
+ }, this);
- return this;
+ obj['_leaflet_touchend' + id] = onUp;
+ obj.addEventListener(this.POINTER_UP, onUp, false);
+ obj.addEventListener(this.POINTER_CANCEL, onUp, false);
}
});
+
/*
* L.Handler.TouchZoom is used by L.Map to add pinch zoom on supported mobile browsers.
*/
+// @namespace Map
+// @section Interaction Options
L.Map.mergeOptions({
+ // @section Touch interaction options
+ // @option touchZoom: Boolean|String = *
+ // Whether the map can be zoomed by touch-dragging with two fingers. If
+ // passed `'center'`, it will zoom to the center of the view regardless of
+ // where the touch events (fingers) were. Enabled for touch-capable web
+ // browsers except for old Androids.
touchZoom: L.Browser.touch && !L.Browser.android23,
+
+ // @option bounceAtZoomLimits: Boolean = true
+ // Set it to false if you don't want the map to zoom beyond min/max zoom
+ // and then bounce back when pinch-zooming.
bounceAtZoomLimits: true
});
L.Map.TouchZoom = L.Handler.extend({
addHooks: function () {
+ L.DomUtil.addClass(this._map._container, 'leaflet-touch-zoom');
L.DomEvent.on(this._map._container, 'touchstart', this._onTouchStart, this);
},
removeHooks: function () {
+ L.DomUtil.removeClass(this._map._container, 'leaflet-touch-zoom');
L.DomEvent.off(this._map._container, 'touchstart', this._onTouchStart, this);
},
_onTouchStart: function (e) {
var map = this._map;
-
if (!e.touches || e.touches.length !== 2 || map._animatingZoom || this._zooming) { return; }
- var p1 = map.mouseEventToLayerPoint(e.touches[0]),
- p2 = map.mouseEventToLayerPoint(e.touches[1]),
- viewCenter = map._getCenterLayerPoint();
+ var p1 = map.mouseEventToContainerPoint(e.touches[0]),
+ p2 = map.mouseEventToContainerPoint(e.touches[1]);
+
+ this._centerPoint = map.getSize()._divideBy(2);
+ this._startLatLng = map.containerPointToLatLng(this._centerPoint);
+ if (map.options.touchZoom !== 'center') {
+ this._pinchStartLatLng = map.containerPointToLatLng(p1.add(p2)._divideBy(2));
+ }
- this._startCenter = p1.add(p2)._divideBy(2);
this._startDist = p1.distanceTo(p2);
+ this._startZoom = map.getZoom();
this._moved = false;
this._zooming = true;
- this._centerOffset = viewCenter.subtract(this._startCenter);
-
- if (map._panAnim) {
- map._panAnim.stop();
- }
+ map._stop();
L.DomEvent
.on(document, 'touchmove', this._onTouchMove, this)
},
_onTouchMove: function (e) {
- var map = this._map;
-
if (!e.touches || e.touches.length !== 2 || !this._zooming) { return; }
- var p1 = map.mouseEventToLayerPoint(e.touches[0]),
- p2 = map.mouseEventToLayerPoint(e.touches[1]);
+ var map = this._map,
+ p1 = map.mouseEventToContainerPoint(e.touches[0]),
+ p2 = map.mouseEventToContainerPoint(e.touches[1]),
+ scale = p1.distanceTo(p2) / this._startDist;
+
- this._scale = p1.distanceTo(p2) / this._startDist;
- this._delta = p1._add(p2)._divideBy(2)._subtract(this._startCenter);
+ this._zoom = map.getScaleZoom(scale, this._startZoom);
- if (this._scale === 1) { return; }
+ if (!map.options.bounceAtZoomLimits && (
+ (this._zoom < map.getMinZoom() && scale < 1) ||
+ (this._zoom > map.getMaxZoom() && scale > 1))) {
+ this._zoom = map._limitZoom(this._zoom);
+ }
- if (!map.options.bounceAtZoomLimits) {
- if ((map.getZoom() === map.getMinZoom() && this._scale < 1) ||
- (map.getZoom() === map.getMaxZoom() && this._scale > 1)) { return; }
+ if (map.options.touchZoom === 'center') {
+ this._center = this._startLatLng;
+ if (scale === 1) { return; }
+ } else {
+ // Get delta from pinch to center, so centerLatLng is delta applied to initial pinchLatLng
+ var delta = p1._add(p2)._divideBy(2)._subtract(this._centerPoint);
+ if (scale === 1 && delta.x === 0 && delta.y === 0) { return; }
+ this._center = map.unproject(map.project(this._pinchStartLatLng, this._zoom).subtract(delta), this._zoom);
}
if (!this._moved) {
- L.DomUtil.addClass(map._mapPane, 'leaflet-touching');
-
- map
- .fire('movestart')
- .fire('zoomstart');
-
+ map._moveStart(true);
this._moved = true;
}
L.Util.cancelAnimFrame(this._animRequest);
- this._animRequest = L.Util.requestAnimFrame(
- this._updateOnMove, this, true, this._map._container);
-
- L.DomEvent.preventDefault(e);
- },
- _updateOnMove: function () {
- var map = this._map,
- origin = this._getScaleOrigin(),
- center = map.layerPointToLatLng(origin),
- zoom = map.getScaleZoom(this._scale);
+ var moveFn = L.bind(map._move, map, this._center, this._zoom, {pinch: true, round: false});
+ this._animRequest = L.Util.requestAnimFrame(moveFn, this, true);
- map._animateZoom(center, zoom, this._startCenter, this._scale, this._delta, false, true);
+ L.DomEvent.preventDefault(e);
},
_onTouchEnd: function () {
return;
}
- var map = this._map;
-
this._zooming = false;
- L.DomUtil.removeClass(map._mapPane, 'leaflet-touching');
L.Util.cancelAnimFrame(this._animRequest);
L.DomEvent
.off(document, 'touchmove', this._onTouchMove)
.off(document, 'touchend', this._onTouchEnd);
- var origin = this._getScaleOrigin(),
- center = map.layerPointToLatLng(origin),
-
- oldZoom = map.getZoom(),
- floatZoomDelta = map.getScaleZoom(this._scale) - oldZoom,
- roundZoomDelta = (floatZoomDelta > 0 ?
- Math.ceil(floatZoomDelta) : Math.floor(floatZoomDelta)),
-
- zoom = map._limitZoom(oldZoom + roundZoomDelta),
- scale = map.getZoomScale(zoom) / this._scale;
-
- map._animateZoom(center, zoom, origin, scale);
- },
-
- _getScaleOrigin: function () {
- var centerOffset = this._centerOffset.subtract(this._delta).divideBy(this._scale);
- return this._startCenter.add(centerOffset);
+ // Pinch updates GridLayers' levels only when zoomSnap is off, so zoomSnap becomes noUpdate.
+ if (this._map.options.zoomAnimation) {
+ this._map._animateZoom(this._center, this._map._limitZoom(this._zoom), true, this._map.options.zoomSnap);
+ } else {
+ this._map._resetView(this._center, this._map._limitZoom(this._zoom));
+ }
}
});
+// @section Handlers
+// @property touchZoom: Handler
+// Touch zoom handler.
L.Map.addInitHook('addHandler', 'touchZoom', L.Map.TouchZoom);
+
/*
* L.Map.Tap is used to enable mobile hacks like quick taps and long hold.
*/
+// @namespace Map
+// @section Interaction Options
L.Map.mergeOptions({
+ // @section Touch interaction options
+ // @option tap: Boolean = true
+ // Enables mobile hacks for supporting instant taps (fixing 200ms click
+ // delay on iOS/Android) and touch holds (fired as `contextmenu` events).
tap: true,
+
+ // @option tapTolerance: Number = 15
+ // The max number of pixels a user can shift his finger during touch
+ // for it to be considered a valid tap.
tapTolerance: 15
});
}
}, this), 1000);
- L.DomEvent
- .on(document, 'touchmove', this._onMove, this)
- .on(document, 'touchend', this._onUp, this);
+ this._simulateEvent('mousedown', first);
+
+ L.DomEvent.on(document, {
+ touchmove: this._onMove,
+ touchend: this._onUp
+ }, this);
},
_onUp: function (e) {
clearTimeout(this._holdTimeout);
- L.DomEvent
- .off(document, 'touchmove', this._onMove, this)
- .off(document, 'touchend', this._onUp, this);
+ L.DomEvent.off(document, {
+ touchmove: this._onMove,
+ touchend: this._onUp
+ }, this);
if (this._fireClick && e && e.changedTouches) {
L.DomUtil.removeClass(el, 'leaflet-active');
}
+ this._simulateEvent('mouseup', first);
+
// simulate click if the touch didn't move too much
if (this._isTapValid()) {
this._simulateEvent('click', first);
_onMove: function (e) {
var first = e.touches[0];
this._newPos = new L.Point(first.clientX, first.clientY);
+ this._simulateEvent('mousemove', first);
},
_simulateEvent: function (type, e) {
}
});
+// @section Handlers
+// @property tap: Handler
+// Mobile touch hacks (quick tap and touch hold) handler.
if (L.Browser.touch && !L.Browser.pointer) {
L.Map.addInitHook('addHandler', 'tap', L.Map.Tap);
}
+
/*
- * L.Handler.ShiftDragZoom is used to add shift-drag zoom interaction to the map
- * (zoom to a selected bounding box), enabled by default.
+ * L.Handler.BoxZoom is used to add shift-drag zoom interaction to the map
+ * (zoom to a selected bounding box), enabled by default.
*/
+// @namespace Map
+// @section Interaction Options
L.Map.mergeOptions({
+ // @option boxZoom: Boolean = true
+ // Whether the map can be zoomed to a rectangular area specified by
+ // dragging the mouse while pressing the shift key.
boxZoom: true
});
this._map = map;
this._container = map._container;
this._pane = map._panes.overlayPane;
- this._moved = false;
},
addHooks: function () {
},
removeHooks: function () {
- L.DomEvent.off(this._container, 'mousedown', this._onMouseDown);
- this._moved = false;
+ L.DomEvent.off(this._container, 'mousedown', this._onMouseDown, this);
},
moved: function () {
return this._moved;
},
- _onMouseDown: function (e) {
+ _resetState: function () {
this._moved = false;
+ },
+ _onMouseDown: function (e) {
if (!e.shiftKey || ((e.which !== 1) && (e.button !== 1))) { return false; }
+ this._resetState();
+
L.DomUtil.disableTextSelection();
L.DomUtil.disableImageDrag();
- this._startLayerPoint = this._map.mouseEventToLayerPoint(e);
+ this._startPoint = this._map.mouseEventToContainerPoint(e);
- L.DomEvent
- .on(document, 'mousemove', this._onMouseMove, this)
- .on(document, 'mouseup', this._onMouseUp, this)
- .on(document, 'keydown', this._onKeyDown, this);
+ L.DomEvent.on(document, {
+ contextmenu: L.DomEvent.stop,
+ mousemove: this._onMouseMove,
+ mouseup: this._onMouseUp,
+ keydown: this._onKeyDown
+ }, this);
},
_onMouseMove: function (e) {
if (!this._moved) {
- this._box = L.DomUtil.create('div', 'leaflet-zoom-box', this._pane);
- L.DomUtil.setPosition(this._box, this._startLayerPoint);
+ this._moved = true;
+
+ this._box = L.DomUtil.create('div', 'leaflet-zoom-box', this._container);
+ L.DomUtil.addClass(this._container, 'leaflet-crosshair');
- //TODO refactor: move cursor to styles
- this._container.style.cursor = 'crosshair';
this._map.fire('boxzoomstart');
}
- var startPoint = this._startLayerPoint,
- box = this._box,
+ this._point = this._map.mouseEventToContainerPoint(e);
- layerPoint = this._map.mouseEventToLayerPoint(e),
- offset = layerPoint.subtract(startPoint),
+ var bounds = new L.Bounds(this._point, this._startPoint),
+ size = bounds.getSize();
- newPos = new L.Point(
- Math.min(layerPoint.x, startPoint.x),
- Math.min(layerPoint.y, startPoint.y));
+ L.DomUtil.setPosition(this._box, bounds.min);
- L.DomUtil.setPosition(box, newPos);
-
- this._moved = true;
-
- // TODO refactor: remove hardcoded 4 pixels
- box.style.width = (Math.max(0, Math.abs(offset.x) - 4)) + 'px';
- box.style.height = (Math.max(0, Math.abs(offset.y) - 4)) + 'px';
+ this._box.style.width = size.x + 'px';
+ this._box.style.height = size.y + 'px';
},
_finish: function () {
if (this._moved) {
- this._pane.removeChild(this._box);
- this._container.style.cursor = '';
+ L.DomUtil.remove(this._box);
+ L.DomUtil.removeClass(this._container, 'leaflet-crosshair');
}
L.DomUtil.enableTextSelection();
L.DomUtil.enableImageDrag();
- L.DomEvent
- .off(document, 'mousemove', this._onMouseMove)
- .off(document, 'mouseup', this._onMouseUp)
- .off(document, 'keydown', this._onKeyDown);
+ L.DomEvent.off(document, {
+ contextmenu: L.DomEvent.stop,
+ mousemove: this._onMouseMove,
+ mouseup: this._onMouseUp,
+ keydown: this._onKeyDown
+ }, this);
},
_onMouseUp: function (e) {
+ if ((e.which !== 1) && (e.button !== 1)) { return; }
this._finish();
- var map = this._map,
- layerPoint = map.mouseEventToLayerPoint(e);
-
- if (this._startLayerPoint.equals(layerPoint)) { return; }
+ if (!this._moved) { return; }
+ // Postpone to next JS tick so internal click event handling
+ // still see it as "moved".
+ setTimeout(L.bind(this._resetState, this), 0);
var bounds = new L.LatLngBounds(
- map.layerPointToLatLng(this._startLayerPoint),
- map.layerPointToLatLng(layerPoint));
+ this._map.containerPointToLatLng(this._startPoint),
+ this._map.containerPointToLatLng(this._point));
- map.fitBounds(bounds);
-
- map.fire('boxzoomend', {
- boxZoomBounds: bounds
- });
+ this._map
+ .fitBounds(bounds)
+ .fire('boxzoomend', {boxZoomBounds: bounds});
},
_onKeyDown: function (e) {
}
});
+// @section Handlers
+// @property boxZoom: Handler
+// Box (shift-drag with mouse) zoom handler.
L.Map.addInitHook('addHandler', 'boxZoom', L.Map.BoxZoom);
+
/*
* L.Map.Keyboard is handling keyboard interaction with the map, enabled by default.
*/
+// @namespace Map
+// @section Keyboard Navigation Options
L.Map.mergeOptions({
+ // @option keyboard: Boolean = true
+ // Makes the map focusable and allows users to navigate the map with keyboard
+ // arrows and `+`/`-` keys.
keyboard: true,
- keyboardPanOffset: 80,
- keyboardZoomOffset: 1
+
+ // @option keyboardPanDelta: Number = 80
+ // Amount of pixels to pan when pressing an arrow key.
+ keyboardPanDelta: 80
});
L.Map.Keyboard = L.Handler.extend({
down: [40],
up: [38],
zoomIn: [187, 107, 61, 171],
- zoomOut: [189, 109, 173]
+ zoomOut: [189, 109, 54, 173]
},
initialize: function (map) {
this._map = map;
- this._setPanOffset(map.options.keyboardPanOffset);
- this._setZoomOffset(map.options.keyboardZoomOffset);
+ this._setPanDelta(map.options.keyboardPanDelta);
+ this._setZoomDelta(map.options.zoomDelta);
},
addHooks: function () {
var container = this._map._container;
// make the container focusable by tabbing
- if (container.tabIndex === -1) {
+ if (container.tabIndex <= 0) {
container.tabIndex = '0';
}
- L.DomEvent
- .on(container, 'focus', this._onFocus, this)
- .on(container, 'blur', this._onBlur, this)
- .on(container, 'mousedown', this._onMouseDown, this);
+ L.DomEvent.on(container, {
+ focus: this._onFocus,
+ blur: this._onBlur,
+ mousedown: this._onMouseDown
+ }, this);
- this._map
- .on('focus', this._addHooks, this)
- .on('blur', this._removeHooks, this);
+ this._map.on({
+ focus: this._addHooks,
+ blur: this._removeHooks
+ }, this);
},
removeHooks: function () {
this._removeHooks();
- var container = this._map._container;
-
- L.DomEvent
- .off(container, 'focus', this._onFocus, this)
- .off(container, 'blur', this._onBlur, this)
- .off(container, 'mousedown', this._onMouseDown, this);
+ L.DomEvent.off(this._map._container, {
+ focus: this._onFocus,
+ blur: this._onBlur,
+ mousedown: this._onMouseDown
+ }, this);
- this._map
- .off('focus', this._addHooks, this)
- .off('blur', this._removeHooks, this);
+ this._map.off({
+ focus: this._addHooks,
+ blur: this._removeHooks
+ }, this);
},
_onMouseDown: function () {
this._map.fire('blur');
},
- _setPanOffset: function (pan) {
+ _setPanDelta: function (panDelta) {
var keys = this._panKeys = {},
codes = this.keyCodes,
i, len;
for (i = 0, len = codes.left.length; i < len; i++) {
- keys[codes.left[i]] = [-1 * pan, 0];
+ keys[codes.left[i]] = [-1 * panDelta, 0];
}
for (i = 0, len = codes.right.length; i < len; i++) {
- keys[codes.right[i]] = [pan, 0];
+ keys[codes.right[i]] = [panDelta, 0];
}
for (i = 0, len = codes.down.length; i < len; i++) {
- keys[codes.down[i]] = [0, pan];
+ keys[codes.down[i]] = [0, panDelta];
}
for (i = 0, len = codes.up.length; i < len; i++) {
- keys[codes.up[i]] = [0, -1 * pan];
+ keys[codes.up[i]] = [0, -1 * panDelta];
}
},
- _setZoomOffset: function (zoom) {
+ _setZoomDelta: function (zoomDelta) {
var keys = this._zoomKeys = {},
codes = this.keyCodes,
i, len;
for (i = 0, len = codes.zoomIn.length; i < len; i++) {
- keys[codes.zoomIn[i]] = zoom;
+ keys[codes.zoomIn[i]] = zoomDelta;
}
for (i = 0, len = codes.zoomOut.length; i < len; i++) {
- keys[codes.zoomOut[i]] = -zoom;
+ keys[codes.zoomOut[i]] = -zoomDelta;
}
},
},
_onKeyDown: function (e) {
+ if (e.altKey || e.ctrlKey || e.metaKey) { return; }
+
var key = e.keyCode,
- map = this._map;
+ map = this._map,
+ offset;
if (key in this._panKeys) {
if (map._panAnim && map._panAnim._inProgress) { return; }
- map.panBy(this._panKeys[key]);
+ offset = this._panKeys[key];
+ if (e.shiftKey) {
+ offset = L.point(offset).multiplyBy(3);
+ }
+
+ map.panBy(offset);
if (map.options.maxBounds) {
map.panInsideBounds(map.options.maxBounds);
}
} else if (key in this._zoomKeys) {
- map.setZoom(map.getZoom() + this._zoomKeys[key]);
+ map.setZoom(map.getZoom() + (e.shiftKey ? 3 : 1) * this._zoomKeys[key]);
+
+ } else if (key === 27) {
+ map.closePopup();
} else {
return;
}
});
+// @section Handlers
+// @section Handlers
+// @property keyboard: Handler
+// Keyboard navigation handler.
L.Map.addInitHook('addHandler', 'keyboard', L.Map.Keyboard);
+
/*
* L.Handler.MarkerDrag is used internally by L.Marker to make the markers draggable.
*/
+
+/* @namespace Marker
+ * @section Interaction handlers
+ *
+ * Interaction handlers are properties of a marker instance that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging (see `Handler` methods). Example:
+ *
+ * ```js
+ * marker.dragging.disable();
+ * ```
+ *
+ * @property dragging: Handler
+ * Marker dragging handler (by both mouse and touch).
+ */
+
L.Handler.MarkerDrag = L.Handler.extend({
initialize: function (marker) {
this._marker = marker;
addHooks: function () {
var icon = this._marker._icon;
+
if (!this._draggable) {
- this._draggable = new L.Draggable(icon, icon);
+ this._draggable = new L.Draggable(icon, icon, true);
}
- this._draggable
- .on('dragstart', this._onDragStart, this)
- .on('drag', this._onDrag, this)
- .on('dragend', this._onDragEnd, this);
- this._draggable.enable();
- L.DomUtil.addClass(this._marker._icon, 'leaflet-marker-draggable');
+ this._draggable.on({
+ dragstart: this._onDragStart,
+ drag: this._onDrag,
+ dragend: this._onDragEnd
+ }, this).enable();
+
+ L.DomUtil.addClass(icon, 'leaflet-marker-draggable');
},
removeHooks: function () {
- this._draggable
- .off('dragstart', this._onDragStart, this)
- .off('drag', this._onDrag, this)
- .off('dragend', this._onDragEnd, this);
+ this._draggable.off({
+ dragstart: this._onDragStart,
+ drag: this._onDrag,
+ dragend: this._onDragEnd
+ }, this).disable();
- this._draggable.disable();
- L.DomUtil.removeClass(this._marker._icon, 'leaflet-marker-draggable');
+ if (this._marker._icon) {
+ L.DomUtil.removeClass(this._marker._icon, 'leaflet-marker-draggable');
+ }
},
moved: function () {
},
_onDragStart: function () {
+ // @section Dragging events
+ // @event dragstart: Event
+ // Fired when the user starts dragging the marker.
+
+ // @event movestart: Event
+ // Fired when the marker starts moving (because of dragging).
+
+ this._oldLatLng = this._marker.getLatLng();
this._marker
.closePopup()
.fire('movestart')
.fire('dragstart');
},
- _onDrag: function () {
+ _onDrag: function (e) {
var marker = this._marker,
shadow = marker._shadow,
iconPos = L.DomUtil.getPosition(marker._icon),
}
marker._latlng = latlng;
+ e.latlng = latlng;
+ e.oldLatLng = this._oldLatLng;
+ // @event drag: Event
+ // Fired repeatedly while the user drags the marker.
marker
- .fire('move', {latlng: latlng})
- .fire('drag');
+ .fire('move', e)
+ .fire('drag', e);
},
_onDragEnd: function (e) {
+ // @event dragend: DragEndEvent
+ // Fired when the user stops dragging the marker.
+
+ // @event moveend: Event
+ // Fired when the marker stops moving (because of dragging).
+ delete this._oldLatLng;
this._marker
.fire('moveend')
.fire('dragend', e);
});
+
/*
+ * @class Control
+ * @aka L.Control
+ *
* L.Control is a base class for implementing map controls. Handles positioning.
* All other controls extend from this class.
*/
L.Control = L.Class.extend({
+ // @section
+ // @aka Control options
options: {
+ // @option position: String = 'topright'
+ // The position of the control (one of the map corners). Possible values are `'topleft'`,
+ // `'topright'`, `'bottomleft'` or `'bottomright'`
position: 'topright'
},
L.setOptions(this, options);
},
+ /* @section
+ * Classes extending L.Control will inherit the following methods:
+ *
+ * @method getPosition: string
+ * Returns the position of the control.
+ */
getPosition: function () {
return this.options.position;
},
+ // @method setPosition(position: string): this
+ // Sets the position of the control.
setPosition: function (position) {
var map = this._map;
return this;
},
+ // @method getContainer: HTMLElement
+ // Returns the HTMLElement that contains the control.
getContainer: function () {
return this._container;
},
+ // @method addTo(map: Map): this
+ // Adds the control to the given map.
addTo: function (map) {
+ this.remove();
this._map = map;
var container = this._container = this.onAdd(map),
return this;
},
- removeFrom: function (map) {
- var pos = this.getPosition(),
- corner = map._controlCorners[pos];
+ // @method remove: this
+ // Removes the control from the map it is currently active on.
+ remove: function () {
+ if (!this._map) {
+ return this;
+ }
- corner.removeChild(this._container);
- this._map = null;
+ L.DomUtil.remove(this._container);
if (this.onRemove) {
- this.onRemove(map);
+ this.onRemove(this._map);
}
+ this._map = null;
+
return this;
},
- _refocusOnMap: function () {
- if (this._map) {
+ _refocusOnMap: function (e) {
+ // if map exists and event is not a keyboard event
+ if (this._map && e && e.screenX > 0 && e.screenY > 0) {
this._map.getContainer().focus();
}
}
return new L.Control(options);
};
+/* @section Extension methods
+ * @uninheritable
+ *
+ * Every control should extend from `L.Control` and (re-)implement the following methods.
+ *
+ * @method onAdd(map: Map): HTMLElement
+ * Should return the container DOM element for the control and add listeners on relevant map events. Called on [`control.addTo(map)`](#control-addTo).
+ *
+ * @method onRemove(map: Map)
+ * Optional method. Should contain all clean up code that removes the listeners previously added in [`onAdd`](#control-onadd). Called on [`control.remove()`](#control-remove).
+ */
-// adds control-related methods to L.Map
-
+/* @namespace Map
+ * @section Methods for Layers and Controls
+ */
L.Map.include({
+ // @method addControl(control: Control): this
+ // Adds the given control to the map
addControl: function (control) {
control.addTo(this);
return this;
},
+ // @method removeControl(control: Control): this
+ // Removes the given control from the map
removeControl: function (control) {
- control.removeFrom(this);
+ control.remove();
return this;
},
},
_clearControlPos: function () {
- this._container.removeChild(this._controlContainer);
+ L.DomUtil.remove(this._controlContainer);
}
});
+
/*
- * L.Control.Zoom is used for the default zoom buttons on the map.
+ * @class Control.Zoom
+ * @aka L.Control.Zoom
+ * @inherits Control
+ *
+ * A basic zoom control with two buttons (zoom in and zoom out). It is put on the map by default unless you set its [`zoomControl` option](#map-zoomcontrol) to `false`. Extends `Control`.
*/
L.Control.Zoom = L.Control.extend({
+ // @section
+ // @aka Control.Zoom options
options: {
position: 'topleft',
+
+ // @option zoomInText: String = '+'
+ // The text set on the 'zoom in' button.
zoomInText: '+',
+
+ // @option zoomInTitle: String = 'Zoom in'
+ // The title set on the 'zoom in' button.
zoomInTitle: 'Zoom in',
+
+ // @option zoomOutText: String = '-'
+ // The text set on the 'zoom out' button.
zoomOutText: '-',
+
+ // @option zoomOutTitle: String = 'Zoom out'
+ // The title set on the 'zoom out' button.
zoomOutTitle: 'Zoom out'
},
onAdd: function (map) {
var zoomName = 'leaflet-control-zoom',
- container = L.DomUtil.create('div', zoomName + ' leaflet-bar');
-
- this._map = map;
+ container = L.DomUtil.create('div', zoomName + ' leaflet-bar'),
+ options = this.options;
- this._zoomInButton = this._createButton(
- this.options.zoomInText, this.options.zoomInTitle,
- zoomName + '-in', container, this._zoomIn, this);
- this._zoomOutButton = this._createButton(
- this.options.zoomOutText, this.options.zoomOutTitle,
- zoomName + '-out', container, this._zoomOut, this);
+ this._zoomInButton = this._createButton(options.zoomInText, options.zoomInTitle,
+ zoomName + '-in', container, this._zoomIn);
+ this._zoomOutButton = this._createButton(options.zoomOutText, options.zoomOutTitle,
+ zoomName + '-out', container, this._zoomOut);
this._updateDisabled();
map.on('zoomend zoomlevelschange', this._updateDisabled, this);
map.off('zoomend zoomlevelschange', this._updateDisabled, this);
},
+ disable: function () {
+ this._disabled = true;
+ this._updateDisabled();
+ return this;
+ },
+
+ enable: function () {
+ this._disabled = false;
+ this._updateDisabled();
+ return this;
+ },
+
_zoomIn: function (e) {
- this._map.zoomIn(e.shiftKey ? 3 : 1);
+ if (!this._disabled && this._map._zoom < this._map.getMaxZoom()) {
+ this._map.zoomIn(this._map.options.zoomDelta * (e.shiftKey ? 3 : 1));
+ }
},
_zoomOut: function (e) {
- this._map.zoomOut(e.shiftKey ? 3 : 1);
+ if (!this._disabled && this._map._zoom > this._map.getMinZoom()) {
+ this._map.zoomOut(this._map.options.zoomDelta * (e.shiftKey ? 3 : 1));
+ }
},
- _createButton: function (html, title, className, container, fn, context) {
+ _createButton: function (html, title, className, container, fn) {
var link = L.DomUtil.create('a', className, container);
link.innerHTML = html;
link.href = '#';
link.title = title;
- var stop = L.DomEvent.stopPropagation;
-
L.DomEvent
- .on(link, 'click', stop)
- .on(link, 'mousedown', stop)
- .on(link, 'dblclick', stop)
- .on(link, 'click', L.DomEvent.preventDefault)
- .on(link, 'click', fn, context)
- .on(link, 'click', this._refocusOnMap, context);
+ .on(link, 'mousedown dblclick', L.DomEvent.stopPropagation)
+ .on(link, 'click', L.DomEvent.stop)
+ .on(link, 'click', fn, this)
+ .on(link, 'click', this._refocusOnMap, this);
return link;
},
_updateDisabled: function () {
var map = this._map,
- className = 'leaflet-disabled';
+ className = 'leaflet-disabled';
L.DomUtil.removeClass(this._zoomInButton, className);
L.DomUtil.removeClass(this._zoomOutButton, className);
- if (map._zoom === map.getMinZoom()) {
+ if (this._disabled || map._zoom === map.getMinZoom()) {
L.DomUtil.addClass(this._zoomOutButton, className);
}
- if (map._zoom === map.getMaxZoom()) {
+ if (this._disabled || map._zoom === map.getMaxZoom()) {
L.DomUtil.addClass(this._zoomInButton, className);
}
}
});
+// @namespace Map
+// @section Control options
+// @option zoomControl: Boolean = true
+// Whether a [zoom control](#control-zoom) is added to the map by default.
L.Map.mergeOptions({
zoomControl: true
});
}
});
+// @namespace Control.Zoom
+// @factory L.control.zoom(options: Control.Zoom options)
+// Creates a zoom control
L.control.zoom = function (options) {
return new L.Control.Zoom(options);
};
/*
- * L.Control.Attribution is used for displaying attribution on the map (added by default).
+ * @class Control.Attribution
+ * @aka L.Control.Attribution
+ * @inherits Control
+ *
+ * The attribution control allows you to display attribution data in a small text box on a map. It is put on the map by default unless you set its [`attributionControl` option](#map-attributioncontrol) to `false`, and it fetches attribution texts from layers with the [`getAttribution` method](#layer-getattribution) automatically. Extends Control.
*/
L.Control.Attribution = L.Control.extend({
+ // @section
+ // @aka Control.Attribution options
options: {
position: 'bottomright',
+
+ // @option prefix: String = 'Leaflet'
+ // The HTML text shown before the attributions. Pass `false` to disable.
prefix: '<a href="http://leafletjs.com" title="A JS library for interactive maps">Leaflet</a>'
},
},
onAdd: function (map) {
+ map.attributionControl = this;
this._container = L.DomUtil.create('div', 'leaflet-control-attribution');
- L.DomEvent.disableClickPropagation(this._container);
+ if (L.DomEvent) {
+ L.DomEvent.disableClickPropagation(this._container);
+ }
+ // TODO ugly, refactor
for (var i in map._layers) {
if (map._layers[i].getAttribution) {
this.addAttribution(map._layers[i].getAttribution());
}
}
-
- map
- .on('layeradd', this._onLayerAdd, this)
- .on('layerremove', this._onLayerRemove, this);
this._update();
return this._container;
},
- onRemove: function (map) {
- map
- .off('layeradd', this._onLayerAdd)
- .off('layerremove', this._onLayerRemove);
-
- },
-
+ // @method setPrefix(prefix: String): this
+ // Sets the text before the attributions.
setPrefix: function (prefix) {
this.options.prefix = prefix;
this._update();
return this;
},
+ // @method addAttribution(text: String): this
+ // Adds an attribution text (e.g. `'Vector data © Mapbox'`).
addAttribution: function (text) {
- if (!text) { return; }
+ if (!text) { return this; }
if (!this._attributions[text]) {
this._attributions[text] = 0;
return this;
},
+ // @method removeAttribution(text: String): this
+ // Removes an attribution text.
removeAttribution: function (text) {
- if (!text) { return; }
+ if (!text) { return this; }
if (this._attributions[text]) {
this._attributions[text]--;
}
this._container.innerHTML = prefixAndAttribs.join(' | ');
- },
-
- _onLayerAdd: function (e) {
- if (e.layer.getAttribution) {
- this.addAttribution(e.layer.getAttribution());
- }
- },
-
- _onLayerRemove: function (e) {
- if (e.layer.getAttribution) {
- this.removeAttribution(e.layer.getAttribution());
- }
}
});
+// @namespace Map
+// @section Control options
+// @option attributionControl: Boolean = true
+// Whether a [attribution control](#control-attribution) is added to the map by default.
L.Map.mergeOptions({
attributionControl: true
});
L.Map.addInitHook(function () {
if (this.options.attributionControl) {
- this.attributionControl = (new L.Control.Attribution()).addTo(this);
+ new L.Control.Attribution().addTo(this);
}
});
+// @namespace Control.Attribution
+// @factory L.control.attribution(options: Control.Attribution options)
+// Creates an attribution control.
L.control.attribution = function (options) {
return new L.Control.Attribution(options);
};
+
/*
- * L.Control.Scale is used for displaying metric/imperial scale on the map.
+ * @class Control.Scale
+ * @aka L.Control.Scale
+ * @inherits Control
+ *
+ * A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems. Extends `Control`.
+ *
+ * @example
+ *
+ * ```js
+ * L.control.scale().addTo(map);
+ * ```
*/
L.Control.Scale = L.Control.extend({
+ // @section
+ // @aka Control.Scale options
options: {
position: 'bottomleft',
+
+ // @option maxWidth: Number = 100
+ // Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500).
maxWidth: 100,
+
+ // @option metric: Boolean = True
+ // Whether to show the metric scale line (m/km).
metric: true,
- imperial: true,
- updateWhenIdle: false
+
+ // @option imperial: Boolean = True
+ // Whether to show the imperial scale line (mi/ft).
+ imperial: true
+
+ // @option updateWhenIdle: Boolean = false
+ // If `true`, the control is updated on [`moveend`](#map-moveend), otherwise it's always up-to-date (updated on [`move`](#map-move)).
},
onAdd: function (map) {
- this._map = map;
-
var className = 'leaflet-control-scale',
container = L.DomUtil.create('div', className),
options = this.options;
- this._addScales(options, className, container);
+ this._addScales(options, className + '-line', container);
map.on(options.updateWhenIdle ? 'moveend' : 'move', this._update, this);
map.whenReady(this._update, this);
_addScales: function (options, className, container) {
if (options.metric) {
- this._mScale = L.DomUtil.create('div', className + '-line', container);
+ this._mScale = L.DomUtil.create('div', className, container);
}
if (options.imperial) {
- this._iScale = L.DomUtil.create('div', className + '-line', container);
+ this._iScale = L.DomUtil.create('div', className, container);
}
},
_update: function () {
- var bounds = this._map.getBounds(),
- centerLat = bounds.getCenter().lat,
- halfWorldMeters = 6378137 * Math.PI * Math.cos(centerLat * Math.PI / 180),
- dist = halfWorldMeters * (bounds.getNorthEast().lng - bounds.getSouthWest().lng) / 180,
-
- size = this._map.getSize(),
- options = this.options,
- maxMeters = 0;
+ var map = this._map,
+ y = map.getSize().y / 2;
- if (size.x > 0) {
- maxMeters = dist * (options.maxWidth / size.x);
- }
+ var maxMeters = map.distance(
+ map.containerPointToLatLng([0, y]),
+ map.containerPointToLatLng([this.options.maxWidth, y]));
- this._updateScales(options, maxMeters);
+ this._updateScales(maxMeters);
},
- _updateScales: function (options, maxMeters) {
- if (options.metric && maxMeters) {
+ _updateScales: function (maxMeters) {
+ if (this.options.metric && maxMeters) {
this._updateMetric(maxMeters);
}
-
- if (options.imperial && maxMeters) {
+ if (this.options.imperial && maxMeters) {
this._updateImperial(maxMeters);
}
},
_updateMetric: function (maxMeters) {
- var meters = this._getRoundNum(maxMeters);
+ var meters = this._getRoundNum(maxMeters),
+ label = meters < 1000 ? meters + ' m' : (meters / 1000) + ' km';
- this._mScale.style.width = this._getScaleWidth(meters / maxMeters) + 'px';
- this._mScale.innerHTML = meters < 1000 ? meters + ' m' : (meters / 1000) + ' km';
+ this._updateScale(this._mScale, label, meters / maxMeters);
},
_updateImperial: function (maxMeters) {
var maxFeet = maxMeters * 3.2808399,
- scale = this._iScale,
maxMiles, miles, feet;
if (maxFeet > 5280) {
maxMiles = maxFeet / 5280;
miles = this._getRoundNum(maxMiles);
-
- scale.style.width = this._getScaleWidth(miles / maxMiles) + 'px';
- scale.innerHTML = miles + ' mi';
+ this._updateScale(this._iScale, miles + ' mi', miles / maxMiles);
} else {
feet = this._getRoundNum(maxFeet);
-
- scale.style.width = this._getScaleWidth(feet / maxFeet) + 'px';
- scale.innerHTML = feet + ' ft';
+ this._updateScale(this._iScale, feet + ' ft', feet / maxFeet);
}
},
- _getScaleWidth: function (ratio) {
- return Math.round(this.options.maxWidth * ratio) - 10;
+ _updateScale: function (scale, text, ratio) {
+ scale.style.width = Math.round(this.options.maxWidth * ratio) + 'px';
+ scale.innerHTML = text;
},
_getRoundNum: function (num) {
var pow10 = Math.pow(10, (Math.floor(num) + '').length - 1),
d = num / pow10;
- d = d >= 10 ? 10 : d >= 5 ? 5 : d >= 3 ? 3 : d >= 2 ? 2 : 1;
+ d = d >= 10 ? 10 :
+ d >= 5 ? 5 :
+ d >= 3 ? 3 :
+ d >= 2 ? 2 : 1;
return pow10 * d;
}
});
+
+// @factory L.control.scale(options?: Control.Scale options)
+// Creates an scale control with the given options.
L.control.scale = function (options) {
return new L.Control.Scale(options);
};
+
/*
- * L.Control.Layers is a control to allow users to switch between different layers on the map.
+ * @class Control.Layers
+ * @aka L.Control.Layers
+ * @inherits Control
+ *
+ * The layers control gives users the ability to switch between different base layers and switch overlays on/off (check out the [detailed example](http://leafletjs.com/examples/layers-control.html)). Extends `Control`.
+ *
+ * @example
+ *
+ * ```js
+ * var baseLayers = {
+ * "Mapbox": mapbox,
+ * "OpenStreetMap": osm
+ * };
+ *
+ * var overlays = {
+ * "Marker": marker,
+ * "Roads": roadsLayer
+ * };
+ *
+ * L.control.layers(baseLayers, overlays).addTo(map);
+ * ```
+ *
+ * The `baseLayers` and `overlays` parameters are object literals with layer names as keys and `Layer` objects as values:
+ *
+ * ```js
+ * {
+ * "<someName1>": layer1,
+ * "<someName2>": layer2
+ * }
+ * ```
+ *
+ * The layer names can contain HTML, which allows you to add additional styling to the items:
+ *
+ * ```js
+ * {"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}
+ * ```
*/
+
L.Control.Layers = L.Control.extend({
+ // @section
+ // @aka Control.Layers options
options: {
+ // @option collapsed: Boolean = true
+ // If `true`, the control will be collapsed into an icon and expanded on mouse hover or touch.
collapsed: true,
position: 'topright',
- autoZIndex: true
+
+ // @option autoZIndex: Boolean = true
+ // If `true`, the control will assign zIndexes in increasing order to all of its layers so that the order is preserved when switching them on/off.
+ autoZIndex: true,
+
+ // @option hideSingleBase: Boolean = false
+ // If `true`, the base layers in the control will be hidden when there is only one.
+ hideSingleBase: false
},
initialize: function (baseLayers, overlays, options) {
L.setOptions(this, options);
- this._layers = {};
+ this._layers = [];
this._lastZIndex = 0;
this._handlingClick = false;
this._initLayout();
this._update();
- map
- .on('layeradd', this._onLayerChange, this)
- .on('layerremove', this._onLayerChange, this);
+ this._map = map;
+ map.on('zoomend', this._checkDisabledLayers, this);
return this._container;
},
- onRemove: function (map) {
- map
- .off('layeradd', this._onLayerChange, this)
- .off('layerremove', this._onLayerChange, this);
+ onRemove: function () {
+ this._map.off('zoomend', this._checkDisabledLayers, this);
+
+ for (var i = 0; i < this._layers.length; i++) {
+ this._layers[i].layer.off('add remove', this._onLayerChange, this);
+ }
},
+ // @method addBaseLayer(layer: Layer, name: String): this
+ // Adds a base layer (radio button entry) with the given name to the control.
addBaseLayer: function (layer, name) {
this._addLayer(layer, name);
- this._update();
- return this;
+ return (this._map) ? this._update() : this;
},
+ // @method addOverlay(layer: Layer, name: String): this
+ // Adds an overlay (checkbox entry) with the given name to the control.
addOverlay: function (layer, name) {
this._addLayer(layer, name, true);
- this._update();
- return this;
+ return (this._map) ? this._update() : this;
},
+ // @method removeLayer(layer: Layer): this
+ // Remove the given layer from the control.
removeLayer: function (layer) {
- var id = L.stamp(layer);
- delete this._layers[id];
- this._update();
+ layer.off('add remove', this._onLayerChange, this);
+
+ var obj = this._getLayer(L.stamp(layer));
+ if (obj) {
+ this._layers.splice(this._layers.indexOf(obj), 1);
+ }
+ return (this._map) ? this._update() : this;
+ },
+
+ // @method expand(): this
+ // Expand the control container if collapsed.
+ expand: function () {
+ L.DomUtil.addClass(this._container, 'leaflet-control-layers-expanded');
+ this._form.style.height = null;
+ var acceptableHeight = this._map.getSize().y - (this._container.offsetTop + 50);
+ if (acceptableHeight < this._form.clientHeight) {
+ L.DomUtil.addClass(this._form, 'leaflet-control-layers-scrollbar');
+ this._form.style.height = acceptableHeight + 'px';
+ } else {
+ L.DomUtil.removeClass(this._form, 'leaflet-control-layers-scrollbar');
+ }
+ this._checkDisabledLayers();
+ return this;
+ },
+
+ // @method collapse(): this
+ // Collapse the control container if expanded.
+ collapse: function () {
+ L.DomUtil.removeClass(this._container, 'leaflet-control-layers-expanded');
return this;
},
var className = 'leaflet-control-layers',
container = this._container = L.DomUtil.create('div', className);
- //Makes this work on IE10 Touch devices by stopping it from firing a mouseout event when the touch is released
+ // makes this work on IE touch devices by stopping it from firing a mouseout event when the touch is released
container.setAttribute('aria-haspopup', true);
+ L.DomEvent.disableClickPropagation(container);
if (!L.Browser.touch) {
- L.DomEvent
- .disableClickPropagation(container)
- .disableScrollPropagation(container);
- } else {
- L.DomEvent.on(container, 'click', L.DomEvent.stopPropagation);
+ L.DomEvent.disableScrollPropagation(container);
}
var form = this._form = L.DomUtil.create('form', className + '-list');
if (this.options.collapsed) {
if (!L.Browser.android) {
- L.DomEvent
- .on(container, 'mouseover', this._expand, this)
- .on(container, 'mouseout', this._collapse, this);
+ L.DomEvent.on(container, {
+ mouseenter: this.expand,
+ mouseleave: this.collapse
+ }, this);
}
+
var link = this._layersLink = L.DomUtil.create('a', className + '-toggle', container);
link.href = '#';
link.title = 'Layers';
if (L.Browser.touch) {
L.DomEvent
.on(link, 'click', L.DomEvent.stop)
- .on(link, 'click', this._expand, this);
- }
- else {
- L.DomEvent.on(link, 'focus', this._expand, this);
+ .on(link, 'click', this.expand, this);
+ } else {
+ L.DomEvent.on(link, 'focus', this.expand, this);
}
- //Work around for Firefox android issue https://github.com/Leaflet/Leaflet/issues/2033
+
+ // work around for Firefox Android issue https://github.com/Leaflet/Leaflet/issues/2033
L.DomEvent.on(form, 'click', function () {
setTimeout(L.bind(this._onInputClick, this), 0);
}, this);
- this._map.on('click', this._collapse, this);
+ this._map.on('click', this.collapse, this);
// TODO keyboard accessibility
} else {
- this._expand();
+ this.expand();
}
this._baseLayersList = L.DomUtil.create('div', className + '-base', form);
container.appendChild(form);
},
+ _getLayer: function (id) {
+ for (var i = 0; i < this._layers.length; i++) {
+
+ if (this._layers[i] && L.stamp(this._layers[i].layer) === id) {
+ return this._layers[i];
+ }
+ }
+ },
+
_addLayer: function (layer, name, overlay) {
- var id = L.stamp(layer);
+ layer.on('add remove', this._onLayerChange, this);
- this._layers[id] = {
+ this._layers.push({
layer: layer,
name: name,
overlay: overlay
- };
+ });
if (this.options.autoZIndex && layer.setZIndex) {
this._lastZIndex++;
},
_update: function () {
- if (!this._container) {
- return;
- }
+ if (!this._container) { return this; }
- this._baseLayersList.innerHTML = '';
- this._overlaysList.innerHTML = '';
+ L.DomUtil.empty(this._baseLayersList);
+ L.DomUtil.empty(this._overlaysList);
- var baseLayersPresent = false,
- overlaysPresent = false,
- i, obj;
+ var baseLayersPresent, overlaysPresent, i, obj, baseLayersCount = 0;
- for (i in this._layers) {
+ for (i = 0; i < this._layers.length; i++) {
obj = this._layers[i];
this._addItem(obj);
overlaysPresent = overlaysPresent || obj.overlay;
baseLayersPresent = baseLayersPresent || !obj.overlay;
+ baseLayersCount += !obj.overlay ? 1 : 0;
+ }
+
+ // Hide base layers section if there's only one layer.
+ if (this.options.hideSingleBase) {
+ baseLayersPresent = baseLayersPresent && baseLayersCount > 1;
+ this._baseLayersList.style.display = baseLayersPresent ? '' : 'none';
}
this._separator.style.display = overlaysPresent && baseLayersPresent ? '' : 'none';
+
+ return this;
},
_onLayerChange: function (e) {
- var obj = this._layers[L.stamp(e.layer)];
-
- if (!obj) { return; }
-
if (!this._handlingClick) {
this._update();
}
+ var obj = this._getLayer(L.stamp(e.target));
+
+ // @namespace Map
+ // @section Layer events
+ // @event baselayerchange: LayersControlEvent
+ // Fired when the base layer is changed through the [layer control](#control-layers).
+ // @event overlayadd: LayersControlEvent
+ // Fired when an overlay is selected through the [layer control](#control-layers).
+ // @event overlayremove: LayersControlEvent
+ // Fired when an overlay is deselected through the [layer control](#control-layers).
+ // @namespace Control.Layers
var type = obj.overlay ?
- (e.type === 'layeradd' ? 'overlayadd' : 'overlayremove') :
- (e.type === 'layeradd' ? 'baselayerchange' : null);
+ (e.type === 'add' ? 'overlayadd' : 'overlayremove') :
+ (e.type === 'add' ? 'baselayerchange' : null);
if (type) {
this._map.fire(type, obj);
// IE7 bugs out if you create a radio dynamically, so you have to do it this hacky way (see http://bit.ly/PqYLBe)
_createRadioElement: function (name, checked) {
- var radioHtml = '<input type="radio" class="leaflet-control-layers-selector" name="' + name + '"';
- if (checked) {
- radioHtml += ' checked="checked"';
- }
- radioHtml += '/>';
+ var radioHtml = '<input type="radio" class="leaflet-control-layers-selector" name="' +
+ name + '"' + (checked ? ' checked="checked"' : '') + '/>';
var radioFragment = document.createElement('div');
radioFragment.innerHTML = radioHtml;
_addItem: function (obj) {
var label = document.createElement('label'),
- input,
- checked = this._map.hasLayer(obj.layer);
+ checked = this._map.hasLayer(obj.layer),
+ input;
if (obj.overlay) {
input = document.createElement('input');
var name = document.createElement('span');
name.innerHTML = ' ' + obj.name;
- label.appendChild(input);
- label.appendChild(name);
+ // Helps from preventing layer control flicker when checkboxes are disabled
+ // https://github.com/Leaflet/Leaflet/issues/2771
+ var holder = document.createElement('div');
+
+ label.appendChild(holder);
+ holder.appendChild(input);
+ holder.appendChild(name);
var container = obj.overlay ? this._overlaysList : this._baseLayersList;
container.appendChild(label);
+ this._checkDisabledLayers();
return label;
},
_onInputClick: function () {
- var i, input, obj,
- inputs = this._form.getElementsByTagName('input'),
- inputsLen = inputs.length;
+ var inputs = this._form.getElementsByTagName('input'),
+ input, layer, hasLayer;
+ var addedLayers = [],
+ removedLayers = [];
this._handlingClick = true;
- for (i = 0; i < inputsLen; i++) {
+ for (var i = inputs.length - 1; i >= 0; i--) {
input = inputs[i];
- obj = this._layers[input.layerId];
+ layer = this._getLayer(input.layerId).layer;
+ hasLayer = this._map.hasLayer(layer);
- if (input.checked && !this._map.hasLayer(obj.layer)) {
- this._map.addLayer(obj.layer);
+ if (input.checked && !hasLayer) {
+ addedLayers.push(layer);
- } else if (!input.checked && this._map.hasLayer(obj.layer)) {
- this._map.removeLayer(obj.layer);
+ } else if (!input.checked && hasLayer) {
+ removedLayers.push(layer);
}
}
+ // Bugfix issue 2318: Should remove all old layers before readding new ones
+ for (i = 0; i < removedLayers.length; i++) {
+ this._map.removeLayer(removedLayers[i]);
+ }
+ for (i = 0; i < addedLayers.length; i++) {
+ this._map.addLayer(addedLayers[i]);
+ }
+
this._handlingClick = false;
this._refocusOnMap();
},
+ _checkDisabledLayers: function () {
+ var inputs = this._form.getElementsByTagName('input'),
+ input,
+ layer,
+ zoom = this._map.getZoom();
+
+ for (var i = inputs.length - 1; i >= 0; i--) {
+ input = inputs[i];
+ layer = this._getLayer(input.layerId).layer;
+ input.disabled = (layer.options.minZoom !== undefined && zoom < layer.options.minZoom) ||
+ (layer.options.maxZoom !== undefined && zoom > layer.options.maxZoom);
+
+ }
+ },
+
_expand: function () {
- L.DomUtil.addClass(this._container, 'leaflet-control-layers-expanded');
+ // Backward compatibility, remove me in 1.1.
+ return this.expand();
},
_collapse: function () {
- this._container.className = this._container.className.replace(' leaflet-control-layers-expanded', '');
+ // Backward compatibility, remove me in 1.1.
+ return this.collapse();
}
+
});
+
+// @factory L.control.layers(baselayers?: Object, overlays?: Object, options?: Control.Layers options)
+// Creates an attribution control with the given layers. Base layers will be switched with radio buttons, while overlays will be switched with checkboxes. Note that all base layers should be passed in the base layers object, but only one should be added to the map during map instantiation.
L.control.layers = function (baseLayers, overlays, options) {
return new L.Control.Layers(baseLayers, overlays, options);
};
+
/*
- * L.PosAnimation is used by Leaflet internally for pan animations.
+ * @class PosAnimation
+ * @aka L.PosAnimation
+ * @inherits Evented
+ * Used internally for panning animations, utilizing CSS3 Transitions for modern browsers and a timer fallback for IE6-9.
+ *
+ * @example
+ * ```js
+ * var fx = new L.PosAnimation();
+ * fx.run(el, [300, 500], 0.5);
+ * ```
+ *
+ * @constructor L.PosAnimation()
+ * Creates a `PosAnimation` object.
+ *
*/
-L.PosAnimation = L.Class.extend({
- includes: L.Mixin.Events,
+L.PosAnimation = L.Evented.extend({
- run: function (el, newPos, duration, easeLinearity) { // (HTMLElement, Point[, Number, Number])
+ // @method run(el: HTMLElement, newPos: Point, duration?: Number, easeLinearity?: Number)
+ // Run an animation of a given element to a new position, optionally setting
+ // duration in seconds (`0.25` by default) and easing linearity factor (3rd
+ // argument of the [cubic bezier curve](http://cubic-bezier.com/#0,0,.5,1),
+ // `0.5` by default).
+ run: function (el, newPos, duration, easeLinearity) {
this.stop();
this._el = el;
this._inProgress = true;
- this._newPos = newPos;
-
- this.fire('start');
-
- el.style[L.DomUtil.TRANSITION] = 'all ' + (duration || 0.25) +
- 's cubic-bezier(0,0,' + (easeLinearity || 0.5) + ',1)';
+ this._duration = duration || 0.25;
+ this._easeOutPower = 1 / Math.max(easeLinearity || 0.5, 0.2);
- L.DomEvent.on(el, L.DomUtil.TRANSITION_END, this._onTransitionEnd, this);
- L.DomUtil.setPosition(el, newPos);
+ this._startPos = L.DomUtil.getPosition(el);
+ this._offset = newPos.subtract(this._startPos);
+ this._startTime = +new Date();
- // toggle reflow, Chrome flickers for some reason if you don't do this
- L.Util.falseFn(el.offsetWidth);
+ // @event start: Event
+ // Fired when the animation starts
+ this.fire('start');
- // there's no native way to track value updates of transitioned properties, so we imitate this
- this._stepTimer = setInterval(L.bind(this._onStep, this), 50);
+ this._animate();
},
+ // @method stop()
+ // Stops the animation (if currently running).
stop: function () {
if (!this._inProgress) { return; }
- // if we just removed the transition property, the element would jump to its final position,
- // so we need to make it stay at the current position
-
- L.DomUtil.setPosition(this._el, this._getPos());
- this._onTransitionEnd();
- L.Util.falseFn(this._el.offsetWidth); // force reflow in case we are about to start a new animation
+ this._step(true);
+ this._complete();
},
- _onStep: function () {
- var stepPos = this._getPos();
- if (!stepPos) {
- this._onTransitionEnd();
- return;
- }
- // jshint camelcase: false
- // make L.DomUtil.getPosition return intermediate position value during animation
- this._el._leaflet_pos = stepPos;
-
- this.fire('step');
+ _animate: function () {
+ // animation loop
+ this._animId = L.Util.requestAnimFrame(this._animate, this);
+ this._step();
},
- // you can't easily get intermediate values of properties animated with CSS3 Transitions,
- // we need to parse computed style (in case of transform it returns matrix string)
-
- _transformRe: /([-+]?(?:\d*\.)?\d+)\D*, ([-+]?(?:\d*\.)?\d+)\D*\)/,
-
- _getPos: function () {
- var left, top, matches,
- el = this._el,
- style = window.getComputedStyle(el);
+ _step: function (round) {
+ var elapsed = (+new Date()) - this._startTime,
+ duration = this._duration * 1000;
- if (L.Browser.any3d) {
- matches = style[L.DomUtil.TRANSFORM].match(this._transformRe);
- if (!matches) { return; }
- left = parseFloat(matches[1]);
- top = parseFloat(matches[2]);
+ if (elapsed < duration) {
+ this._runFrame(this._easeOut(elapsed / duration), round);
} else {
- left = parseFloat(style.left);
- top = parseFloat(style.top);
+ this._runFrame(1);
+ this._complete();
}
-
- return new L.Point(left, top, true);
},
- _onTransitionEnd: function () {
- L.DomEvent.off(this._el, L.DomUtil.TRANSITION_END, this._onTransitionEnd, this);
-
- if (!this._inProgress) { return; }
- this._inProgress = false;
+ _runFrame: function (progress, round) {
+ var pos = this._startPos.add(this._offset.multiplyBy(progress));
+ if (round) {
+ pos._round();
+ }
+ L.DomUtil.setPosition(this._el, pos);
- this._el.style[L.DomUtil.TRANSITION] = '';
+ // @event step: Event
+ // Fired continuously during the animation.
+ this.fire('step');
+ },
- // jshint camelcase: false
- // make sure L.DomUtil.getPosition returns the final position value after animation
- this._el._leaflet_pos = this._newPos;
+ _complete: function () {
+ L.Util.cancelAnimFrame(this._animId);
- clearInterval(this._stepTimer);
+ this._inProgress = false;
+ // @event end: Event
+ // Fired when the animation ends.
+ this.fire('end');
+ },
- this.fire('step').fire('end');
+ _easeOut: function (t) {
+ return 1 - Math.pow(1 - t, this._easeOutPower);
}
-
});
+
/*
* Extends L.Map to handle panning animations.
*/
center = this._limitCenter(L.latLng(center), zoom, this.options.maxBounds);
options = options || {};
- if (this._panAnim) {
- this._panAnim.stop();
- }
+ this._stop();
if (this._loaded && !options.reset && options !== true) {
if (options.animate !== undefined) {
options.zoom = L.extend({animate: options.animate}, options.zoom);
- options.pan = L.extend({animate: options.animate}, options.pan);
+ options.pan = L.extend({animate: options.animate, duration: options.duration}, options.pan);
}
// try animating pan or zoom
- var animated = (this._zoom !== zoom) ?
+ var moved = (this._zoom !== zoom) ?
this._tryAnimatedZoom && this._tryAnimatedZoom(center, zoom, options.zoom) :
this._tryAnimatedPan(center, options.pan);
- if (animated) {
+ if (moved) {
// prevent resize handler call, the view will refresh after animation anyway
clearTimeout(this._sizeTimer);
return this;
options = options || {};
if (!offset.x && !offset.y) {
+ return this.fire('moveend');
+ }
+ // If we pan too far, Chrome gets issues with tiles
+ // and makes them disappear or appear in the wrong place (slightly offset) #2602
+ if (options.animate !== true && !this.getSize().contains(offset)) {
+ this._resetView(this.unproject(this.project(this.getCenter()).add(offset)), this.getZoom());
return this;
}
if (options.animate !== false) {
L.DomUtil.addClass(this._mapPane, 'leaflet-pan-anim');
- var newPos = this._getMapPanePos().subtract(offset);
+ var newPos = this._getMapPanePos().subtract(offset).round();
this._panAnim.run(this._mapPane, newPos, options.duration || 0.25, options.easeLinearity);
} else {
this._rawPanBy(offset);
});
-/*
- * L.PosAnimation fallback implementation that powers Leaflet pan animations
- * in browsers that don't support CSS3 Transitions.
- */
-
-L.PosAnimation = L.DomUtil.TRANSITION ? L.PosAnimation : L.PosAnimation.extend({
-
- run: function (el, newPos, duration, easeLinearity) { // (HTMLElement, Point[, Number, Number])
- this.stop();
-
- this._el = el;
- this._inProgress = true;
- this._duration = duration || 0.25;
- this._easeOutPower = 1 / Math.max(easeLinearity || 0.5, 0.2);
-
- this._startPos = L.DomUtil.getPosition(el);
- this._offset = newPos.subtract(this._startPos);
- this._startTime = +new Date();
-
- this.fire('start');
-
- this._animate();
- },
-
- stop: function () {
- if (!this._inProgress) { return; }
-
- this._step();
- this._complete();
- },
-
- _animate: function () {
- // animation loop
- this._animId = L.Util.requestAnimFrame(this._animate, this);
- this._step();
- },
-
- _step: function () {
- var elapsed = (+new Date()) - this._startTime,
- duration = this._duration * 1000;
-
- if (elapsed < duration) {
- this._runFrame(this._easeOut(elapsed / duration));
- } else {
- this._runFrame(1);
- this._complete();
- }
- },
-
- _runFrame: function (progress) {
- var pos = this._startPos.add(this._offset.multiplyBy(progress));
- L.DomUtil.setPosition(this._el, pos);
-
- this.fire('step');
- },
-
- _complete: function () {
- L.Util.cancelAnimFrame(this._animId);
-
- this._inProgress = false;
- this.fire('end');
- },
-
- _easeOut: function (t) {
- return 1 - Math.pow(1 - t, this._easeOutPower);
- }
-});
-
/*
* Extends L.Map to handle zoom animations.
*/
+// @namespace Map
+// @section Animation Options
L.Map.mergeOptions({
+ // @option zoomAnimation: Boolean = true
+ // Whether the map zoom animation is enabled. By default it's enabled
+ // in all browsers that support CSS3 Transitions except Android.
zoomAnimation: true,
+
+ // @option zoomAnimationThreshold: Number = 4
+ // Won't animate zoom if the zoom difference exceeds this value.
zoomAnimationThreshold: 4
});
-if (L.DomUtil.TRANSITION) {
+var zoomAnimated = L.DomUtil.TRANSITION && L.Browser.any3d && !L.Browser.mobileOpera;
+
+if (zoomAnimated) {
L.Map.addInitHook(function () {
// don't animate on browsers without hardware-accelerated transitions or old Android/Opera
- this._zoomAnimated = this.options.zoomAnimation && L.DomUtil.TRANSITION &&
- L.Browser.any3d && !L.Browser.android23 && !L.Browser.mobileOpera;
+ this._zoomAnimated = this.options.zoomAnimation;
// zoom transitions run with the same duration for all layers, so if one of transitionend events
// happens after starting zoom animation (propagating to the map pane), we know that it ended globally
if (this._zoomAnimated) {
- L.DomEvent.on(this._mapPane, L.DomUtil.TRANSITION_END, this._catchTransitionEnd, this);
+
+ this._createAnimProxy();
+
+ L.DomEvent.on(this._proxy, L.DomUtil.TRANSITION_END, this._catchTransitionEnd, this);
}
});
}
-L.Map.include(!L.DomUtil.TRANSITION ? {} : {
+L.Map.include(!zoomAnimated ? {} : {
+
+ _createAnimProxy: function () {
+
+ var proxy = this._proxy = L.DomUtil.create('div', 'leaflet-proxy leaflet-zoom-animated');
+ this._panes.mapPane.appendChild(proxy);
+
+ this.on('zoomanim', function (e) {
+ var prop = L.DomUtil.TRANSFORM,
+ transform = proxy.style[prop];
+
+ L.DomUtil.setTransform(proxy, this.project(e.center, e.zoom), this.getZoomScale(e.zoom, 1));
+
+ // workaround for case when transform is the same and so transitionend event is not fired
+ if (transform === proxy.style[prop] && this._animatingZoom) {
+ this._onZoomTransitionEnd();
+ }
+ }, this);
+
+ this.on('load moveend', function () {
+ var c = this.getCenter(),
+ z = this.getZoom();
+ L.DomUtil.setTransform(proxy, this.project(c, z), this.getZoomScale(z, 1));
+ }, this);
+ },
_catchTransitionEnd: function (e) {
if (this._animatingZoom && e.propertyName.indexOf('transform') >= 0) {
// offset is the pixel coords of the zoom origin relative to the current center
var scale = this.getZoomScale(zoom),
- offset = this._getCenterOffset(center)._divideBy(1 - 1 / scale),
- origin = this._getCenterLayerPoint()._add(offset);
+ offset = this._getCenterOffset(center)._divideBy(1 - 1 / scale);
// don't animate if the zoom origin isn't within one screen from the current center, unless forced
if (options.animate !== true && !this.getSize().contains(offset)) { return false; }
- this
- .fire('movestart')
- .fire('zoomstart');
-
- this._animateZoom(center, zoom, origin, scale, null, true);
+ L.Util.requestAnimFrame(function () {
+ this
+ ._moveStart(true)
+ ._animateZoom(center, zoom, true);
+ }, this);
return true;
},
- _animateZoom: function (center, zoom, origin, scale, delta, backwards, forTouchZoom) {
-
- if (!forTouchZoom) {
+ _animateZoom: function (center, zoom, startAnim, noUpdate) {
+ if (startAnim) {
this._animatingZoom = true;
- }
-
- // put transform transition on all layers with leaflet-zoom-animated class
- L.DomUtil.addClass(this._mapPane, 'leaflet-zoom-anim');
- // remember what center/zoom to set after animation
- this._animateToCenter = center;
- this._animateToZoom = zoom;
+ // remember what center/zoom to set after animation
+ this._animateToCenter = center;
+ this._animateToZoom = zoom;
- // disable any dragging during animation
- if (L.Draggable) {
- L.Draggable._disabled = true;
+ L.DomUtil.addClass(this._mapPane, 'leaflet-zoom-anim');
}
- L.Util.requestAnimFrame(function () {
- this.fire('zoomanim', {
- center: center,
- zoom: zoom,
- origin: origin,
- scale: scale,
- delta: delta,
- backwards: backwards
- });
- // horrible hack to work around a Chrome bug https://github.com/Leaflet/Leaflet/issues/3689
- setTimeout(L.bind(this._onZoomTransitionEnd, this), 250);
- }, this);
+ // @event zoomanim: ZoomAnimEvent
+ // Fired on every frame of a zoom animation
+ this.fire('zoomanim', {
+ center: center,
+ zoom: zoom,
+ noUpdate: noUpdate
+ });
+
+ // Work around webkit not firing 'transitionend', see https://github.com/Leaflet/Leaflet/issues/3689, 2693
+ setTimeout(L.bind(this._onZoomTransitionEnd, this), 250);
},
_onZoomTransitionEnd: function () {
if (!this._animatingZoom) { return; }
+ L.DomUtil.removeClass(this._mapPane, 'leaflet-zoom-anim');
+
this._animatingZoom = false;
- L.DomUtil.removeClass(this._mapPane, 'leaflet-zoom-anim');
+ this._move(this._animateToCenter, this._animateToZoom);
+ // This anim frame should prevent an obscure iOS webkit tile loading race condition.
L.Util.requestAnimFrame(function () {
- this._resetView(this._animateToCenter, this._animateToZoom, true, true);
-
- if (L.Draggable) {
- L.Draggable._disabled = false;
- }
+ this._moveEnd(true);
}, this);
}
});
-/*
- Zoom animation logic for L.TileLayer.
-*/
-L.TileLayer.include({
- _animateZoom: function (e) {
- if (!this._animating) {
- this._animating = true;
- this._prepareBgBuffer();
- }
+// @namespace Map
+// @section Methods for modifying map state
+L.Map.include({
- var bg = this._bgBuffer,
- transform = L.DomUtil.TRANSFORM,
- initialTransform = e.delta ? L.DomUtil.getTranslateString(e.delta) : bg.style[transform],
- scaleStr = L.DomUtil.getScaleString(e.scale, e.origin);
+ // @method flyTo(latlng: LatLng, zoom?: Number, options?: Zoom/pan options): this
+ // Sets the view of the map (geographical center and zoom) performing a smooth
+ // pan-zoom animation.
+ flyTo: function (targetCenter, targetZoom, options) {
- bg.style[transform] = e.backwards ?
- scaleStr + ' ' + initialTransform :
- initialTransform + ' ' + scaleStr;
- },
+ options = options || {};
+ if (options.animate === false || !L.Browser.any3d) {
+ return this.setView(targetCenter, targetZoom, options);
+ }
- _endZoomAnim: function () {
- var front = this._tileContainer,
- bg = this._bgBuffer;
+ this._stop();
- front.style.visibility = '';
- front.parentNode.appendChild(front); // Bring to fore
+ var from = this.project(this.getCenter()),
+ to = this.project(targetCenter),
+ size = this.getSize(),
+ startZoom = this._zoom;
- // force reflow
- L.Util.falseFn(bg.offsetWidth);
+ targetCenter = L.latLng(targetCenter);
+ targetZoom = targetZoom === undefined ? startZoom : targetZoom;
- var zoom = this._map.getZoom();
- if (zoom > this.options.maxZoom || zoom < this.options.minZoom) {
- this._clearBgBuffer();
- }
+ var w0 = Math.max(size.x, size.y),
+ w1 = w0 * this.getZoomScale(startZoom, targetZoom),
+ u1 = (to.distanceTo(from)) || 1,
+ rho = 1.42,
+ rho2 = rho * rho;
- this._animating = false;
- },
+ function r(i) {
+ var s1 = i ? -1 : 1,
+ s2 = i ? w1 : w0,
+ t1 = w1 * w1 - w0 * w0 + s1 * rho2 * rho2 * u1 * u1,
+ b1 = 2 * s2 * rho2 * u1,
+ b = t1 / b1,
+ sq = Math.sqrt(b * b + 1) - b;
- _clearBgBuffer: function () {
- var map = this._map;
+ // workaround for floating point precision bug when sq = 0, log = -Infinite,
+ // thus triggering an infinite loop in flyTo
+ var log = sq < 0.000000001 ? -18 : Math.log(sq);
- if (map && !map._animatingZoom && !map.touchZoom._zooming) {
- this._bgBuffer.innerHTML = '';
- this._bgBuffer.style[L.DomUtil.TRANSFORM] = '';
+ return log;
}
- },
-
- _prepareBgBuffer: function () {
-
- var front = this._tileContainer,
- bg = this._bgBuffer;
- // if foreground layer doesn't have many tiles but bg layer does,
- // keep the existing bg layer and just zoom it some more
+ function sinh(n) { return (Math.exp(n) - Math.exp(-n)) / 2; }
+ function cosh(n) { return (Math.exp(n) + Math.exp(-n)) / 2; }
+ function tanh(n) { return sinh(n) / cosh(n); }
- var bgLoaded = this._getLoadedTilesPercentage(bg),
- frontLoaded = this._getLoadedTilesPercentage(front);
+ var r0 = r(0);
- if (bg && bgLoaded > 0.5 && frontLoaded < 0.5) {
+ function w(s) { return w0 * (cosh(r0) / cosh(r0 + rho * s)); }
+ function u(s) { return w0 * (cosh(r0) * tanh(r0 + rho * s) - sinh(r0)) / rho2; }
- front.style.visibility = 'hidden';
- this._stopLoadingImages(front);
- return;
- }
+ function easeOut(t) { return 1 - Math.pow(1 - t, 1.5); }
- // prepare the buffer to become the front tile pane
- bg.style.visibility = 'hidden';
- bg.style[L.DomUtil.TRANSFORM] = '';
+ var start = Date.now(),
+ S = (r(1) - r0) / rho,
+ duration = options.duration ? 1000 * options.duration : 1000 * S * 0.8;
- // switch out the current layer to be the new bg layer (and vice-versa)
- this._tileContainer = bg;
- bg = this._bgBuffer = front;
+ function frame() {
+ var t = (Date.now() - start) / duration,
+ s = easeOut(t) * S;
- this._stopLoadingImages(bg);
-
- //prevent bg buffer from clearing right after zoom
- clearTimeout(this._clearBgBufferTimer);
- },
+ if (t <= 1) {
+ this._flyToFrame = L.Util.requestAnimFrame(frame, this);
- _getLoadedTilesPercentage: function (container) {
- var tiles = container.getElementsByTagName('img'),
- i, len, count = 0;
+ this._move(
+ this.unproject(from.add(to.subtract(from).multiplyBy(u(s) / u1)), startZoom),
+ this.getScaleZoom(w0 / w(s), startZoom),
+ {flyTo: true});
- for (i = 0, len = tiles.length; i < len; i++) {
- if (tiles[i].complete) {
- count++;
+ } else {
+ this
+ ._move(targetCenter, targetZoom)
+ ._moveEnd(true);
}
}
- return count / len;
- },
-
- // stops loading all tiles in the background layer
- _stopLoadingImages: function (container) {
- var tiles = Array.prototype.slice.call(container.getElementsByTagName('img')),
- i, len, tile;
- for (i = 0, len = tiles.length; i < len; i++) {
- tile = tiles[i];
+ this._moveStart(true);
- if (!tile.complete) {
- tile.onload = L.Util.falseFn;
- tile.onerror = L.Util.falseFn;
- tile.src = L.Util.emptyImageUrl;
+ frame.call(this);
+ return this;
+ },
- tile.parentNode.removeChild(tile);
- }
- }
+ // @method flyToBounds(bounds: LatLngBounds, options?: fitBounds options): this
+ // Sets the view of the map with a smooth animation like [`flyTo`](#map-flyto),
+ // but takes a bounds parameter like [`fitBounds`](#map-fitbounds).
+ flyToBounds: function (bounds, options) {
+ var target = this._getBoundsCenterZoom(bounds, options);
+ return this.flyTo(target.center, target.zoom, options);
}
});
+
/*
* Provides L.Map with convenient shortcuts for using browser geolocation features.
*/
+// @namespace Map
+
L.Map.include({
+ // @section Geolocation methods
_defaultLocateOptions: {
- watch: false,
- setView: false,
- maxZoom: Infinity,
timeout: 10000,
- maximumAge: 0,
- enableHighAccuracy: false
- },
-
- locate: function (/*Object*/ options) {
-
- options = this._locateOptions = L.extend(this._defaultLocateOptions, options);
-
- if (!navigator.geolocation) {
+ watch: false
+ // setView: false
+ // maxZoom: <Number>
+ // maximumAge: 0
+ // enableHighAccuracy: false
+ },
+
+ // @method locate(options?: Locate options): this
+ // Tries to locate the user using the Geolocation API, firing a [`locationfound`](#map-locationfound)
+ // event with location data on success or a [`locationerror`](#map-locationerror) event on failure,
+ // and optionally sets the map view to the user's location with respect to
+ // detection accuracy (or to the world view if geolocation failed).
+ // Note that, if your page doesn't use HTTPS, this method will fail in
+ // modern browsers ([Chrome 50 and newer](https://sites.google.com/a/chromium.org/dev/Home/chromium-security/deprecating-powerful-features-on-insecure-origins))
+ // See `Locate options` for more details.
+ locate: function (options) {
+
+ options = this._locateOptions = L.extend({}, this._defaultLocateOptions, options);
+
+ if (!('geolocation' in navigator)) {
this._handleGeolocationError({
code: 0,
message: 'Geolocation not supported.'
}
var onResponse = L.bind(this._handleGeolocationResponse, this),
- onError = L.bind(this._handleGeolocationError, this);
+ onError = L.bind(this._handleGeolocationError, this);
if (options.watch) {
this._locationWatchId =
return this;
},
+ // @method stopLocate(): this
+ // Stops watching location previously initiated by `map.locate({watch: true})`
+ // and aborts resetting the map view if map.locate was called with
+ // `{setView: true}`.
stopLocate: function () {
- if (navigator.geolocation) {
+ if (navigator.geolocation && navigator.geolocation.clearWatch) {
navigator.geolocation.clearWatch(this._locationWatchId);
}
if (this._locateOptions) {
this.fitWorld();
}
+ // @section Location events
+ // @event locationerror: ErrorEvent
+ // Fired when geolocation (using the [`locate`](#map-locate) method) failed.
this.fire('locationerror', {
code: c,
message: 'Geolocation error: ' + message + '.'
var lat = pos.coords.latitude,
lng = pos.coords.longitude,
latlng = new L.LatLng(lat, lng),
-
- latAccuracy = 180 * pos.coords.accuracy / 40075017,
- lngAccuracy = latAccuracy / Math.cos(L.LatLng.DEG_TO_RAD * lat),
-
- bounds = L.latLngBounds(
- [lat - latAccuracy, lng - lngAccuracy],
- [lat + latAccuracy, lng + lngAccuracy]),
-
+ bounds = latlng.toBounds(pos.coords.accuracy),
options = this._locateOptions;
if (options.setView) {
- var zoom = Math.min(this.getBoundsZoom(bounds), options.maxZoom);
- this.setView(latlng, zoom);
+ var zoom = this.getBoundsZoom(bounds);
+ this.setView(latlng, options.maxZoom ? Math.min(zoom, options.maxZoom) : zoom);
}
var data = {
}
}
+ // @event locationfound: LocationEvent
+ // Fired when geolocation (using the [`locate`](#map-locate) method)
+ // went successfully.
this.fire('locationfound', data);
}
});
-}(window, document));
\ No newline at end of file
+
+}(window, document));
+//# sourceMappingURL=leaflet-src.map
\ No newline at end of file
projects / rails.git / commitdiff
