cartodb/Leaflet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Let's say I'm @IvanSanchez for once

Browse Source
This commit is contained in:
Yohan Boniface 2016-04-02 14:12:02 +02:00 committed by Iván Sánchez Ortega
parent 560e73bac5
commit 1b1d21b1bf
70 changed files with 1030 additions and 1032 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
build/docs.js
View File

@ -8,7 +8,8 @@ function buildDocs() {
var LeafDoc = require('leafdoc');
var doc = new LeafDoc({
templateDir: 'build/leafdoc-templates',
showInheritancesWhenEmpty: true
showInheritancesWhenEmpty: true,
leadingCharacter: '@'
});
// Note to Vladimir: Iván's never gonna uncomment the following line. He's
@ -33,4 +34,4 @@ function buildDocs() {
fs.writeFileSync('dist/reference-' + packageDef.version + '.html', out);
}
module.exports = buildDocs;
module.exports = buildDocs;

28
src/control/Control.Attribution.js
View File

@ -1,18 +1,18 @@
/*
* 🍂class Control.Attribution
* 🍂aka L.Control.Attribution
* 🍂inherits Control
* @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
// @section
// @aka Control.Attribution options
options: {
position: 'bottomright',
// 🍂option prefix: String = 'Leaflet'
// @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>'
},
@ -42,7 +42,7 @@ L.Control.Attribution = L.Control.extend({
return this._container;
},
// 🍂method setPrefix(prefix: String): this
// @method setPrefix(prefix: String): this
// Sets the text before the attributions.
setPrefix: function (prefix) {
this.options.prefix = prefix;
@ -50,7 +50,7 @@ L.Control.Attribution = L.Control.extend({
return this;
},
// 🍂method addAttribution(text: String): this
// @method addAttribution(text: String): this
// Adds an attribution text (e.g. `'Vector data &copy; Mapbox'`).
addAttribution: function (text) {
if (!text) { return this; }
@ -65,7 +65,7 @@ L.Control.Attribution = L.Control.extend({
return this;
},
// 🍂method removeAttribution(text: String): this
// @method removeAttribution(text: String): this
// Removes an attribution text.
removeAttribution: function (text) {
if (!text) { return this; }
@ -102,9 +102,9 @@ L.Control.Attribution = L.Control.extend({
}
});
// 🍂namespace Map
// 🍂section Control options
// 🍂option attributionControl: Boolean = true
// @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
@ -116,8 +116,8 @@ L.Map.addInitHook(function () {
}
});
// 🍂namespace Control.Attribution
// 🍂factory L.control.attribution(options: Control.Attribution options)
// @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);

38
src/control/Control.Layers.js
View File

@ -1,11 +1,11 @@
/*
* 🍂class Control.Layers
* 🍂aka L.Control.Layers
* 🍂inherits Control
* @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
* @example
*
* ```js
* var baseLayers = {
@ -39,19 +39,19 @@
L.Control.Layers = L.Control.extend({
// 🍂section
// 🍂aka Control.Layers options
// @section
// @aka Control.Layers options
options: {
// 🍂option collapsed: Boolean = true
// @option collapsed: Boolean = true
// If `true`, the control will be collapsed into an icon and expanded on mouse hover or touch.
collapsed: true,
position: 'topright',
// 🍂option autoZIndex: Boolean = true
// @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
// @option hideSingleBase: Boolean = false
// If `true`, the base layers in the control will be hidden when there is only one.
hideSingleBase: false
},
@ -90,21 +90,21 @@ L.Control.Layers = L.Control.extend({
}
},
// 🍂method addBaseLayer(layer: Layer, name: String): 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);
return (this._map) ? this._update() : this;
},
// 🍂method addOverlay(layer: Layer, name: String): this
// @method addOverlay(layer: Layer, name: String): this
// Adds an overlay (checkbox entry) with the given name to the control.
addOverlay: function (layer, name) {
this._addLayer(layer, name, true);
return (this._map) ? this._update() : this;
},
// 🍂method removeLayer(layer: Layer): this
// @method removeLayer(layer: Layer): this
// Remove the given layer from the control.
removeLayer: function (layer) {
layer.off('add remove', this._onLayerChange, this);
@ -216,15 +216,15 @@ L.Control.Layers = L.Control.extend({
var obj = this._layers[L.stamp(e.target)];
// 🍂namespace Map
// 🍂section Layer events
// 🍂event baselayerchange: LayersControlEvent
// @namespace Map
// @section Layer events
// @event baselayerchange: LayersControlEvent
// Fired when the base layer is changed through the [layer control](#control-layers).
// 🍂event overlayadd: LayersControlEvent
// @event overlayadd: LayersControlEvent
// Fired when an overlay is selected through the [layer control](#control-layers).
// 🍂event overlayremove: LayersControlEvent
// @event overlayremove: LayersControlEvent
// Fired when an overlay is deselected through the [layer control](#control-layers).
// 🍂namespace Control.Layers
// @namespace Control.Layers
var type = obj.overlay ?
(e.type === 'add' ? 'overlayadd' : 'overlayremove') :
(e.type === 'add' ? 'baselayerchange' : null);
@ -350,7 +350,7 @@ L.Control.Layers = L.Control.extend({
});
// 🍂factory L.control.layers(baselayers?: Object, overlays?: Object, options?: Control.Layers options)
// @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);

22
src/control/Control.Scale.js
View File

@ -1,11 +1,11 @@
/*
* 🍂class Control.Scale
* 🍂aka L.Control.Scale
* 🍂inherits Control
* @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
* @example
*
* ```js
* L.control.scale().addTo(map);
@ -13,24 +13,24 @@
*/
L.Control.Scale = L.Control.extend({
// 🍂section
// 🍂aka Control.Scale options
// @section
// @aka Control.Scale options
options: {
position: 'bottomleft',
// 🍂option maxWidth: Number = 100
// @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
// @option metric: Boolean = True
// Whether to show the metric scale line (m/km).
metric: true,
// 🍂option imperial: Boolean = True
// @option imperial: Boolean = True
// Whether to show the imperial scale line (mi/ft).
imperial: true
// 🍂option updateWhenIdle: Boolean = false
// @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)).
},
@ -121,7 +121,7 @@ L.Control.Scale = L.Control.extend({
});
// 🍂factory L.control.scale(options?: Control.Scale options)
// @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);

28
src/control/Control.Zoom.js
View File

@ -1,28 +1,28 @@
/*
* 🍂class Control.Zoom
* 🍂aka L.Control.Zoom
* 🍂inherits Control
* @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
// @section
// @aka Control.Zoom options
options: {
// 🍂option zoomInText: String = '+'
// @option zoomInText: String = '+'
// The text set on the 'zoom in' button.
zoomInText: '+',
// 🍂option zoomInTitle: String = 'Zoom in'
// @option zoomInTitle: String = 'Zoom in'
// The title set on the 'zoom in' button.
zoomInTitle: 'Zoom in',
// 🍂option zoomOutText: String = '-'
// @option zoomOutText: String = '-'
// The text set on the 'zoom out' button.
zoomOutText: '-',
// 🍂option zoomOutTitle: String = 'Zoom out'
// @option zoomOutTitle: String = 'Zoom out'
// The title set on the 'zoom out' button.
zoomOutTitle: 'Zoom out'
},
@ -102,9 +102,9 @@ L.Control.Zoom = L.Control.extend({
}
});
// 🍂namespace Map
// 🍂section Control options
// 🍂option zoomControl: Boolean = true
// @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
@ -117,8 +117,8 @@ L.Map.addInitHook(function () {
}
});
// 🍂namespace Control.Zoom
// 🍂factory L.control.zoom(options: Control.Zoom options)
// @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);

10
src/control/Control.js
View File

@ -1,16 +1,16 @@
/*
* 🍂class Control
* 🍂aka L.Control
* @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
// @section
// @aka Control options
options: {
// 🍂option position: String = 'topleft'
// @option position: String = 'topleft'
// The position of the control (one of the map corners). Possible values are `'topleft'`,
// `'topright'`, `'bottomleft'` or `'bottomright'`
position: 'topright'

52
src/core/Browser.js
View File

@ -1,10 +1,10 @@
/*
* 🍂namespace Browser
* 🍂aka L.Browser
* @namespace Browser
* @aka L.Browser
*
* A namespace with static properties for browser/feature detection used by Leaflet internally.
*
* 🍂example
* @example
*
* ```js
* if (L.Browser.ielt9) {
@ -40,99 +40,99 @@
L.Browser = {
// 🍂property ie: Boolean
// @property ie: Boolean
// `true` for all Internet Explorer versions (not Edge).
ie: ie,
// 🍂property ielt9: Boolean
// @property ielt9: Boolean
// `true` for Internet Explorer versions less than 9.
ielt9: ie && !document.addEventListener,
// 🍂property edge: Boolean
// @property edge: Boolean
// `true` for the Edge web browser.
edge: 'msLaunchUri' in navigator && !('documentMode' in document),
// 🍂property webkit: Boolean
// @property webkit: Boolean
// `true` for webkit-based browsers like Chrome and Safari (including mobile versions).
webkit: webkit,
// 🍂property gecko: Boolean
// @property gecko: Boolean
// `true` for gecko-based browsers like Firefox.
gecko: gecko,
// 🍂property android: Boolean
// @property android: Boolean
// `true` for any browser running on an Android platform.
android: ua.indexOf('android') !== -1,
// 🍂property android23: Boolean
// @property android23: Boolean
// `true` for browsers running on Android 2 or Android 3.
android23: android23,
// 🍂property chrome: Boolean
// @property chrome: Boolean
// `true` for the Chrome browser.
chrome: chrome,
// 🍂property safari: Boolean
// @property safari: Boolean
// `true` for the Safari browser.
safari: !chrome && ua.indexOf('safari') !== -1,
// 🍂property ie3d: Boolean
// @property ie3d: Boolean
// `true` for all Internet Explorer versions supporting CSS transforms.
ie3d: ie3d,
// 🍂property webkit3d: Boolean
// @property webkit3d: Boolean
// `true` for webkit-based browsers supporting CSS transforms.
webkit3d: webkit3d,
// 🍂property gecko3d: Boolean
// @property gecko3d: Boolean
// `true` for gecko-based browsers supporting CSS transforms.
gecko3d: gecko3d,
// 🍂property opera12: Boolean
// @property opera12: Boolean
// `true` for the Opera browser supporting CSS transforms (version 12 or later).
opera12: opera12,
// 🍂property any3d: Boolean
// @property any3d: Boolean
// `true` for all browsers supporting CSS transforms.
any3d: !window.L_DISABLE_3D && (ie3d || webkit3d || gecko3d) && !opera12 && !phantomjs,
// 🍂property ie: Boolean
// @property ie: Boolean
// `true` for all browsers running in a mobile devide.
mobile: mobile,
// 🍂property mobileWebkit: Boolean
// @property mobileWebkit: Boolean
// `true` for all webkit-based browsers in a mobile device.
mobileWebkit: mobile && webkit,
// 🍂property mobileWebkit3d: Boolean
// @property mobileWebkit3d: Boolean
// `true` for all webkit-based browsers in a mobile device supporting CSS transforms.
mobileWebkit3d: mobile && webkit3d,
// 🍂property mobileOpera: Boolean
// @property mobileOpera: Boolean
// `true` for the Opera browser in a mobile device.
mobileOpera: mobile && window.opera,
// 🍂property mobileGecko: Boolean
// @property mobileGecko: Boolean
// `true` for gecko-based browsers running in a mobile device.
mobileGecko: mobile && gecko,
// 🍂property touch: Boolean
// @property touch: Boolean
// `true` for all browsers supporting [touch events](https://developer.mozilla.org/docs/Web/API/Touch_events).
touch: !!touch,
// 🍂property msPointer: Boolean
// @property msPointer: Boolean
// `true` for browsers implementing the Microsoft touch events model (notably IE10).
msPointer: !!msPointer,
// 🍂property pointer: Boolean
// @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
// @property retina: Boolean
// `true` for browsers on a high-resolution "retina" screen.
retina: (window.devicePixelRatio || (window.screen.deviceXDPI / window.screen.logicalXDPI)) > 1
};

16
src/core/Class.js
View File

@ -1,9 +1,9 @@
// 🍂class Class
// 🍂aka L.Class
// @class Class
// @aka L.Class
// 🍂section
// 🍂uninheritable
// @section
// @uninheritable
// Thanks to John Resig and Dean Edwards for inspiration!
@ -11,7 +11,7 @@ L.Class = function () {};
L.Class.extend = function (props) {
// 🍂function extend(props: Object): Function
// @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 () {
@ -81,21 +81,21 @@ L.Class.extend = function (props) {
};
// 🍂function include(properties: Object)
// @function include(properties: Object)
// [Includes a mixin](#class-includes) into the current class.
L.Class.include = function (props) {
L.extend(this.prototype, props);
return this;
};
// 🍂function mergeOptions(options: Object)
// @function mergeOptions(options: Object)
// [Merges `options`](#class-options) into the defaults of the class.
L.Class.mergeOptions = function (options) {
L.extend(this.prototype.options, options);
return this;
};
// 🍂function addInitHook(fn: Function)
// @function addInitHook(fn: Function)
// 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);

26
src/core/Class.leafdoc
View File

@ -1,13 +1,13 @@
🍂class Class
🍂aka L.Class
@class Class
@aka L.Class
L.Class powers the OOP facilities of Leaflet and is used to create almost all of the Leaflet classes documented here.
In addition to implementing a simple classical inheritance model, it introduces several special properties for convenient code organization — options, includes and statics.
🍂example
@example
```js
var MyClass = L.Class.extend({
@ -28,8 +28,8 @@ var a = new MyClass("Hello");
a.greet("World");
```
🍂section Class Factories
🍂example
@section Class Factories
@example
You may have noticed that Leaflet objects are created without using
the `new` keyword. This is achieved by complementing each class with a
@ -47,8 +47,8 @@ L.map = function (id, options) {
return new L.Map(id, options);
};
```
🍂section Inheritance
🍂example
@section Inheritance
@example
You use L.Class.extend to define new classes, but you can use the same method on any class to inherit from it:
@ -83,8 +83,8 @@ var a = new MyChildClass();
a.greet('Jason'); // alerts "Yo, bro Jason!"
```
🍂section Options
🍂example
@section Options
@example
`options` is a special property that unlike other objects that you pass
to `extend` will be merged with the parent one instead of overriding it
@ -133,8 +133,8 @@ var a = new MyClass({bla: 10});
a.options; // {foo: 'bar', bla: 10}
```
🍂section Includes
🍂example
@section Includes
@example
`includes` is a special class property that merges all specified objects into the class (such objects are called mixins).
@ -172,8 +172,8 @@ MyClass.FOO; // 'bar'
```
🍂section Constructor hooks
🍂example
@section Constructor hooks
@example
If you're a plugin developer, you often need to add additional initialization code to existing classes (e.g. editing hooks for `L.Polyline`). Leaflet comes with a way to do it easily using the `addInitHook` method:

46
src/core/Events.js
View File

@ -1,11 +1,11 @@
/*
* 🍂class Evented
* 🍂aka L.Evented
* 🍂inherits Class
* @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
* @example
*
* ```js
* map.on('click', function(e) {
@ -26,11 +26,11 @@
L.Evented = L.Class.extend({
/* 🍂method on(type: String, fn: Function, context?: Object): this
/* @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
* @alternative
* @method on(eventMap: Object): this
* Adds a set of type/listener pairs, e.g. `{click: onClick, mousemove: onMouseMove}`
*/
on: function (types, fn, context) {
@ -55,15 +55,15 @@ L.Evented = L.Class.extend({
return this;
},
/* 🍂method off(type: String, fn?: Function, context?: Object): this
/* @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
* @alternative
* @method off(eventMap: Object): this
* Removes a set of type/listener pairs.
*
* 🍂alternative
* 🍂method off: this
* @alternative
* @method off: this
* Removes all listeners to all events on the object.
*/
off: function (types, fn, context) {
@ -167,7 +167,7 @@ L.Evented = L.Class.extend({
}
},
// 🍂method fire(type: String, data?: Object, propagate?: Boolean): this
// @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.
@ -204,7 +204,7 @@ L.Evented = L.Class.extend({
return this;
},
// 🍂method listens(type: String): Boolean
// @method listens(type: String): Boolean
// Returns `true` if a particular event type has any listeners attached to it.
listens: function (type, propagate) {
var events = this._events;
@ -220,7 +220,7 @@ L.Evented = L.Class.extend({
return false;
},
// 🍂method once(…): this
// @method once(…): this
// Behaves as [`on(…)`](#evented-on), except the listener will only get fired once and then removed.
once: function (types, fn, context) {
@ -243,7 +243,7 @@ L.Evented = L.Class.extend({
.on(types, handler, context);
},
// 🍂method addEventParent(obj: Evented): this
// @method addEventParent(obj: Evented): this
// Adds an event parent - an `Evented` that will receive propagated events
addEventParent: function (obj) {
this._eventParents = this._eventParents || {};
@ -251,7 +251,7 @@ L.Evented = L.Class.extend({
return this;
},
// 🍂method removeEventParent(obj: Evented): this
// @method removeEventParent(obj: Evented): this
// Removes an event parent, so it will stop receiving propagated events
removeEventParent: function (obj) {
if (this._eventParents) {
@ -271,26 +271,26 @@ var proto = L.Evented.prototype;
// aliases; we should ditch those eventually
// 🍂method addEventListener(…): this
// @method addEventListener(…): this
// Alias to [`on(…)`](#evented-on)
proto.addEventListener = proto.on;
// 🍂method removeEventListener(…): this
// @method removeEventListener(…): this
// Alias to [`off(…)`](#evented-off)
// 🍂method clearAllEventListeners(…): this
// @method clearAllEventListeners(…): this
// Alias to [`off()`](#evented-off)
proto.removeEventListener = proto.clearAllEventListeners = proto.off;
// 🍂method addOneTimeEventListener(…): this
// @method addOneTimeEventListener(…): this
// Alias to [`once(…)`](#evented-once)
proto.addOneTimeEventListener = proto.once;
// 🍂method fireEvent(…): this
// @method fireEvent(…): this
// Alias to [`fire(…)`](#evented-fire)
proto.fireEvent = proto.fire;
// 🍂method hasEventListeners(…): this
// @method hasEventListeners(…): this
// Alias to [`listens(…)`](#evented-listens)
proto.hasEventListeners = proto.listens;

108
src/core/Events.leafdoc
View File

@ -1,5 +1,5 @@
🍂namespace Event objects
@namespace Event objects
Whenever a class inheriting from `Evented` fires an event, a listener function
@ -15,102 +15,102 @@ map.on('click', function(ev) {
The information available depends on the event type:
🍂miniclass Event (Event objects)
🍂section
@miniclass Event (Event objects)
@section
The base event object. All other event objects contain these properties too.
🍂property type: String
@property type: String
The event type (e.g. `'click'`).
🍂property target: Object
@property target: Object
The object that fired the event.
🍂miniclass MouseEvent (Event objects)
🍂inherits Event
🍂property latlng: LatLng
@miniclass MouseEvent (Event objects)
@inherits Event
@property latlng: LatLng
The geographical point where the mouse event occured.
🍂property layerPoint: Point
@property layerPoint: Point
Pixel coordinates of the point where the mouse event occured relative to the map layer.
🍂property containerPoint: Point
@property containerPoint: Point
Pixel coordinates of the point where the mouse event occured relative to the map сontainer.
🍂property originalEvent: DOMMouseEvent
@property originalEvent: DOMMouseEvent
The original DOM mouse event fired by the browser.
🍂miniclass LocationEvent (Event objects)
🍂inherits Event
🍂property latlng: LatLng
@miniclass LocationEvent (Event objects)
@inherits Event
@property latlng: LatLng
Detected geographical location of the user.
🍂property bounds: LatLngBounds
@property bounds: LatLngBounds
Geographical bounds of the area user is located in (with respect to the accuracy of location).
🍂property accuracy: Number
@property accuracy: Number
Accuracy of location in meters.
🍂property altitude: Number
@property altitude: Number
Height of the position above the WGS84 ellipsoid in meters.
🍂property altitudeAccuracy: Number
@property altitudeAccuracy: Number
Accuracy of altitude in meters.
🍂property heading: Number
@property heading: Number
The direction of travel in degrees counting clockwise from true North.
🍂property speed: Number
@property speed: Number
Current velocity in meters per second.
🍂property timestamp: Number
@property timestamp: Number
The time when the position was acquired.
🍂miniclass ErrorEvent (Event objects)
🍂inherits Event
🍂property message: String
@miniclass ErrorEvent (Event objects)
@inherits Event
@property message: String
Error message.
🍂property code: Number
@property code: Number
Error code (if applicable).
🍂miniclass LayerEvent (Event objects)
🍂inherits Event
🍂property layer: ILayer
@miniclass LayerEvent (Event objects)
@inherits Event
@property layer: ILayer
The layer that was added or removed.
🍂miniclass LayersControlEvent (Event objects)
🍂inherits Event
🍂property layer: ILayer
@miniclass LayersControlEvent (Event objects)
@inherits Event
@property layer: ILayer
The layer that was added or removed.
🍂property name: String
@property name: String
The name of the layer that was added or removed.
🍂miniclass TileEvent (Event objects)
🍂inherits Event
🍂property tile: HTMLElement
@miniclass TileEvent (Event objects)
@inherits Event
@property tile: HTMLElement
The tile element (image).
🍂miniclass TileErrorEvent (Event objects)
🍂inherits Event
🍂property tile: HTMLElement
@miniclass TileErrorEvent (Event objects)
@inherits Event
@property tile: HTMLElement
The tile element (image).
🍂miniclass ResizeEvent (Event objects)
🍂inherits Event
🍂property oldSize: Point
@miniclass ResizeEvent (Event objects)
@inherits Event
@property oldSize: Point
The old size before resize event.
🍂property newSize: Point
@property newSize: Point
The new size after the resize event.
🍂miniclass GeoJSON event (Event objects)
🍂inherits Event
🍂property layer: ILayer
@miniclass GeoJSON event (Event objects)
@inherits Event
@property layer: ILayer
The layer for the GeoJSON feature that is being added to the map.
🍂property properties: Object
@property properties: Object
GeoJSON properties of the feature.
🍂property geometryType: String
@property geometryType: String
GeoJSON geometry type of the feature.
🍂property id: String
@property id: String
GeoJSON ID of the feature (if present).
🍂miniclass Popup event (Event objects)
🍂inherits Event
🍂property popup: Popup
@miniclass Popup event (Event objects)
@inherits Event
@property popup: Popup
The popup that was opened or closed.
🍂miniclass DragEndEvent (Event objects)
🍂inherits Event
🍂property distance: Number
@miniclass DragEndEvent (Event objects)
@inherits Event
@property distance: Number
The distance in pixels the draggable element was moved by.

16
src/core/Handler.js
View File

@ -3,8 +3,8 @@
interaction features like dragging to classes like Map and Marker.
*/
// 🍂class Handler
// 🍂aka L.Handler
// @class Handler
// @aka L.Handler
// Abstract class for map interaction handlers
L.Handler = L.Class.extend({
@ -12,7 +12,7 @@ L.Handler = L.Class.extend({
this._map = map;
},
// 🍂method enable()
// @method enable()
// Enables the handler
enable: function () {
if (this._enabled) { return; }
@ -21,7 +21,7 @@ L.Handler = L.Class.extend({
this.addHooks();
},
// 🍂method disable()
// @method disable()
// Disables the handler
disable: function () {
if (!this._enabled) { return; }
@ -30,16 +30,16 @@ L.Handler = L.Class.extend({
this.removeHooks();
},
// 🍂method enabled(): Boolean
// @method enabled(): Boolean
// Returns `true` if the handler is enabled
enabled: function () {
return !!this._enabled;
}
// 🍂section Extension methods
// @section Extension methods
// Classes inheriting from `Handler` must implement the two following methods:
// 🍂method addHooks()
// @method addHooks()
// Called when the handler is enabled, should add event hooks.
// 🍂method removeHooks()
// @method removeHooks()
// Called when the handler is disabled, should remove the event hooks added previously.
});

40
src/core/Util.js
View File

@ -1,12 +1,12 @@
/*
* 🍂namespace Util
* @namespace Util
*
* Various utility functions, used by Leaflet internally.
*/
L.Util = {
// 🍂function extend(dest: Object, src?: Object): Object
// @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;
@ -20,7 +20,7 @@ L.Util = {
return dest;
},
// 🍂function create(proto: Object, properties?: Object): Object
// @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() {}
@ -30,7 +30,7 @@ L.Util = {
};
})(),
// 🍂function bind(fn: Function, …): Function
// @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) {
@ -47,7 +47,7 @@ L.Util = {
};
},
// 🍂function stamp(obj: Object): Number
// @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 */
@ -56,11 +56,11 @@ L.Util = {
/*eslint-enable */
},
// 🍂property lastId: Number
// @property lastId: Number
// Last unique ID used by [`stamp()`](#util-stamp)
lastId: 0,
// 🍂function throttle(fn: Function, time: Number, context: Object): Function
// @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 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) {
@ -91,7 +91,7 @@ L.Util = {
return wrapperFn;
},
// 🍂function wrapNum(num: Number, range: Number[], includeMax?: Boolean): Number
// @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`.
@ -102,30 +102,30 @@ L.Util = {
return x === max && includeMax ? x : ((x - min) % d + d) % d + min;
},
// 🍂function falseFn(): Function
// @function falseFn(): Function
// Returns a function which always returns `false`.
falseFn: function () { return false; },
// 🍂function formatNum(num: Number, digits?: Number): Number
// @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
// @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[]
// @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
// @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) {
if (!obj.hasOwnProperty('options')) {
@ -137,7 +137,7 @@ L.Util = {
return obj.options;
},
// 🍂function getParamString(obj: Object, existingUrl?: String, uppercase?: Boolean): String
// @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
@ -150,7 +150,7 @@ L.Util = {
return ((!existingUrl || existingUrl.indexOf('?') === -1) ? '?' : '&') + params.join('&');
},
// 🍂template (str: String, data: Object)
// @template (str: String, data: Object)
// 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
@ -171,13 +171,13 @@ L.Util = {
templateRe: /\{ *([\w_\-]+) *\}/g,
// 🍂function isArray(obj): Boolean
// @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
// @function indexOf
// 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++) {
@ -186,7 +186,7 @@ L.Util = {
return -1;
},
// 🍂property emptyImageUrl: String
// @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).
@ -216,7 +216,7 @@ L.Util = {
getPrefixed('CancelRequestAnimationFrame') || function (id) { window.clearTimeout(id); };
// 🍂function requestAnimFrame(fn: Function, context?: Object, immediate?: Boolean): requestId: Number
// @function requestAnimFrame(fn: Function, context?: Object, immediate?: Boolean): requestId: 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
@ -230,7 +230,7 @@ L.Util = {
}
};
// 🍂function cancelAnimFrame(id: Number)
// @function cancelAnimFrame(id: Number)
// Cancels a previous `requestAnimFrame`. See also [window.cancelAnimationFrame](https://developer.mozilla.org/docs/Web/API/window/cancelAnimationFrame).
L.Util.cancelAnimFrame = function (id) {
if (id) {

32
src/dom/DomEvent.js
View File

@ -1,5 +1,5 @@
/*
* 🍂namespace DomEvent
* @namespace DomEvent
* Utility functions to work with the [DOM events](https://developer.mozilla.org/docs/Web/API/Event), used by Leaflet internally.
*/
@ -11,14 +11,14 @@ var eventsKey = '_leaflet_events';
L.DomEvent = {
// 🍂function on(el: HTMLElement, types: String, fn: Function, context?: Object): this
// @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
// @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) {
@ -37,14 +37,14 @@ L.DomEvent = {
return this;
},
// 🍂function off(el: HTMLElement, types: String, fn: Function, context?: Object)
// @function off(el: HTMLElement, types: String, fn: Function, context?: Object)
// Removes a previously added listener function. If no function is specified,
// it will remove all the listeners of that particular DOM event from the element.
// Note that if you passed a custom context to on, you must pass the same
// context to `off` in order to remove the listener.
// 🍂alternative
// 🍂function off(el: HTMLElement, types: eventMap: Object, context?: Object): this
// @alternative
// @function off(el: HTMLElement, types: eventMap: Object, context?: Object): this
off: function (obj, types, fn, context) {
if (typeof types === 'object') {
@ -145,7 +145,7 @@ L.DomEvent = {
return this;
},
// 🍂function stopPropagation(ev: DOMEvent): 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) {
@ -166,13 +166,13 @@ L.DomEvent = {
return this;
},
// 🍂function disableScrollPropagation(el: HTMLElement): this
// @function disableScrollPropagation(el: HTMLElement): this
// Adds `stopPropagation` to the element's `'mousewheel'` events (plus browser variants).
disableScrollPropagation: function (el) {
return L.DomEvent.on(el, 'mousewheel', L.DomEvent.stopPropagation);
},
// 🍂function disableClickPropagation(el: HTMLElement): this
// @function disableClickPropagation(el: HTMLElement): this
// Adds `stopPropagation` to the element's `'click'`, `'doubleclick'`,
// `'mousedown'` and `'touchstart'` events (plus browser variants).
disableClickPropagation: function (el) {
@ -186,7 +186,7 @@ L.DomEvent = {
});
},
// 🍂function preventDefault(ev: DOMEvent): this
// @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).
@ -201,7 +201,7 @@ L.DomEvent = {
return this;
},
// 🍂function stop(ev): this
// @function stop(ev): this
// Does `stopPropagation` and `preventDefault` at the same time.
stop: function (e) {
return L.DomEvent
@ -209,7 +209,7 @@ L.DomEvent = {
.stopPropagation(e);
},
// 🍂function getMousePosition(ev: DOMEvent, container?: HTMLElement): Point
// @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) {
@ -224,7 +224,7 @@ L.DomEvent = {
e.clientY - rect.top - container.clientTop);
},
// 🍂function getWheelDelta(ev: DOMEvent): Number
// @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
@ -291,10 +291,10 @@ L.DomEvent = {
}
};
// 🍂function addListener(…): this
// @function addListener(…): this
// Alias to [`L.DomEvent.on`](#domevent-on)
L.DomEvent.addListener = L.DomEvent.on;
// 🍂function removeListener(…): this
// @function removeListener(…): this
// Alias to [`L.DomEvent.off`](#domevent-off)
L.DomEvent.removeListener = L.DomEvent.off;

52
src/dom/DomUtil.js
View File

@ -1,5 +1,5 @@
/*
* 🍂namespace DomUtil
* @namespace DomUtil
*
* Utility functions to work with the [DOM](https://developer.mozilla.org/docs/Web/API/Document_Object_Model)
* tree, used by Leaflet internally.
@ -11,14 +11,14 @@
L.DomUtil = {
// 🍂function get(id: String|HTMLElement): HTMLElement
// @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;
},
// 🍂function getStyle(el: HTMLElement, styleAttrib: String): String
// @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) {
@ -33,7 +33,7 @@ L.DomUtil = {
return value === 'auto' ? null : value;
},
// 🍂function create(tagName: String, className?: String, container?: HTMLElement): HTMLElement
// @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) {
@ -47,7 +47,7 @@ L.DomUtil = {
return el;
},
// 🍂function remove(el: HTMLElement)
// @function remove(el: HTMLElement)
// Removes `el` from its parent element
remove: function (el) {
var parent = el.parentNode;
@ -56,7 +56,7 @@ L.DomUtil = {
}
},
// 🍂function empty(el: HTMLElement)
// @function empty(el: HTMLElement)
// Removes all of `el`'s children elements from `el`
empty: function (el) {
while (el.firstChild) {
@ -64,20 +64,20 @@ L.DomUtil = {
}
},
// 🍂function toFront(el: HTMLElement)
// @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)
// @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
// @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) {
@ -87,7 +87,7 @@ L.DomUtil = {
return className.length > 0 && new RegExp('(^|\\s)' + name + '(\\s|$)').test(className);
},
// 🍂function addClass(el: HTMLElement, name: String)
// @function addClass(el: HTMLElement, name: String)
// Adds `name` to the element's class attribute.
addClass: function (el, name) {
if (el.classList !== undefined) {
@ -101,7 +101,7 @@ L.DomUtil = {
}
},
// 🍂function removeClass(el: HTMLElement, name: String)
// @function removeClass(el: HTMLElement, name: String)
// Removes `name` from the element's class attribute.
removeClass: function (el, name) {
if (el.classList !== undefined) {
@ -111,7 +111,7 @@ L.DomUtil = {
}
},
// 🍂function setClass(el: HTMLElement, name: String)
// @function setClass(el: HTMLElement, name: String)
// Sets the element's class.
setClass: function (el, name) {
if (el.className.baseVal === undefined) {
@ -122,13 +122,13 @@ L.DomUtil = {
}
},
// 🍂function setClass(el: HTMLElement, name: String)
// @function setClass(el: HTMLElement, name: String)
// Sets the element's class.
getClass: function (el) {
return el.className.baseVal === undefined ? el.className : el.className.baseVal;
},
// 🍂function setOpacity(el: HTMLElement, opacity: Number)
// @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) {
@ -164,7 +164,7 @@ L.DomUtil = {
}
},
// 🍂function testProp(props: String[]): String|false
// @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`.
@ -180,7 +180,7 @@ L.DomUtil = {
return false;
},
// 🍂function setTransform(el: HTMLElement, offset: Point, scale?: Number)
// @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.
@ -194,7 +194,7 @@ L.DomUtil = {
(scale ? ' scale(' + scale + ')' : '');
},
// 🍂function setPosition(el: HTMLElement, position: Point)
// @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).
@ -212,7 +212,7 @@ L.DomUtil = {
}
},
// 🍂function getPosition(el: HTMLElement): Point
// @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,
@ -226,7 +226,7 @@ L.DomUtil = {
(function () {
// prefix style property names
// 🍂property TRANSFORM: String
// @property TRANSFORM: String
// Vendor-prefixed fransform style name (e.g. `'webkitTransform'` for WebKit).
L.DomUtil.TRANSFORM = L.DomUtil.testProp(
['transform', 'WebkitTransform', 'OTransform', 'MozTransform', 'msTransform']);
@ -235,7 +235,7 @@ L.DomUtil = {
// 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
// 🍂property TRANSITION: String
// @property TRANSITION: String
// Vendor-prefixed transform style name.
var transition = L.DomUtil.TRANSITION = L.DomUtil.testProp(
['webkitTransition', 'transition', 'OTransition', 'MozTransition', 'msTransition']);
@ -243,13 +243,13 @@ L.DomUtil = {
L.DomUtil.TRANSITION_END =
transition === 'webkitTransition' || transition === 'OTransition' ? transition + 'End' : 'transitionend';
// 🍂function disableTextSelection()
// @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()
// @function enableTextSelection()
// Cancels the effects of a previous [`L.DomUtil.disableTextSelection`](#domutil-disabletextselection).
if ('onselectstart' in document) {
L.DomUtil.disableTextSelection = function () {
@ -278,20 +278,20 @@ L.DomUtil = {
};
}
// 🍂function disableImageDrag()
// @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()
// @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)
// @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
@ -308,7 +308,7 @@ L.DomUtil = {
L.DomEvent.on(window, 'keydown', L.DomUtil.restoreOutline, this);
};
// 🍂function restoreOutline()
// @function restoreOutline()
// Cancels the effects of a previous [`L.DomUtil.preventOutline`]().
L.DomUtil.restoreOutline = function () {
if (!this._outlineElement) { return; }

24
src/dom/Draggable.js
View File

@ -1,13 +1,13 @@
/*
* 🍂class Draggable
* 🍂aka L.Draggable
* 🍂inherits Evented
* @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
* @example
* ```js
* var draggable = new L.Draggable(elementToDrag);
* draggable.enable();
@ -32,7 +32,7 @@ L.Draggable = L.Evented.extend({
}
},
// 🍂constructor L.Draggable(el: HTMLElement, dragHandle?: HTMLElement, preventOutline: Boolean)
// @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;
@ -40,7 +40,7 @@ L.Draggable = L.Evented.extend({
this._preventOutline = preventOutline;
},
// 🍂method enable()
// @method enable()
// Enables the dragging ability
enable: function () {
if (this._enabled) { return; }
@ -50,7 +50,7 @@ L.Draggable = L.Evented.extend({
this._enabled = true;
},
// 🍂method disable()
// @method disable()
// Disables the dragging ability
disable: function () {
if (!this._enabled) { return; }
@ -78,7 +78,7 @@ L.Draggable = L.Evented.extend({
if (this._moving) { return; }
// 🍂event down: Event
// @event down: Event
// Fired when a drag is about to start.
this.fire('down');
@ -108,7 +108,7 @@ L.Draggable = L.Evented.extend({
L.DomEvent.preventDefault(e);
if (!this._moved) {
// 🍂event dragstart: Event
// @event dragstart: Event
// Fired when a drag starts
this.fire('dragstart');
@ -132,13 +132,13 @@ L.Draggable = L.Evented.extend({
_updatePosition: function () {
var e = {originalEvent: this._lastEvent};
// 🍂event predrag: Event
// @event predrag: Event
// Fired continuously during dragging *before* each corresponding
// update of the element's position.
this.fire('predrag', e);
L.DomUtil.setPosition(this._element, this._newPos);
// 🍂event predrag: Event
// @event predrag: Event
// Fired continuously during dragging.
this.fire('drag', e);
},
@ -164,7 +164,7 @@ L.Draggable = L.Evented.extend({
// ensure drag is not fired after dragend
L.Util.cancelAnimFrame(this._animRequest);
// 🍂event dragend: Event
// @event dragend: Event
// Fired when the drag ends.
this.fire('dragend', {
distance: this._newPos.distanceTo(this._startPos)

20
src/dom/PosAnimation.js
View File

@ -1,23 +1,23 @@
/*
* 🍂class PosAnimation
* 🍂aka L.PosAnimation
* 🍂inherits Evented
* @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
* @example
* ```js
* var fx = new L.PosAnimation();
f x.run(el, [300, 500], 0.5);*
* ```
*
* 🍂constructor L.PosAnimation()
* @constructor L.PosAnimation()
* Creates a `PosAnimation` object.
*
*/
L.PosAnimation = L.Evented.extend({
// 🍂method run(el: HTMLElement, newPos: Point, duration?: Number, easeLinearity?: 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),
@ -34,14 +34,14 @@ L.PosAnimation = L.Evented.extend({
this._offset = newPos.subtract(this._startPos);
this._startTime = +new Date();
// 🍂event start: Event
// @event start: Event
// Fired when the animation starts
this.fire('start');
this._animate();
},
// 🍂method stop()
// @method stop()
// Stops the animation (if currently running).
stop: function () {
if (!this._inProgress) { return; }
@ -75,7 +75,7 @@ L.PosAnimation = L.Evented.extend({
}
L.DomUtil.setPosition(this._el, pos);
// 🍂event step: Event
// @event step: Event
// Fired continuously during the animation.
this.fire('step');
},
@ -84,7 +84,7 @@ L.PosAnimation = L.Evented.extend({
L.Util.cancelAnimFrame(this._animId);
this._inProgress = false;
// 🍂event end: Event
// @event end: Event
// Fired when the animation ends.
this.fire('end');
},

32
src/geo/LatLng.js
View File

@ -1,9 +1,9 @@
/* 🍂class LatLng
* 🍂aka L.LatLng
/* @class LatLng
* @aka L.LatLng
*
* Represents a geographical point with a certain latitude and longitude.
*
* 🍂example
* @example
*
* ```
* var latlng = L.latLng(50.5, 30.5);
@ -24,15 +24,15 @@ L.LatLng = function (lat, lng, alt) {
throw new Error('Invalid LatLng object: (' + lat + ', ' + lng + ')');
}
// 🍂property lat: Number
// @property lat: Number
// Latitude in degrees
this.lat = +lat;
// 🍂property lng: Number
// @property lng: Number
// Longitude in degrees
this.lng = +lng;
// 🍂property alt: Number
// @property alt: Number
// Altitude in meters (optional)
if (alt !== undefined) {
this.alt = +alt;
@ -40,7 +40,7 @@ L.LatLng = function (lat, lng, alt) {
};
L.LatLng.prototype = {
// 🍂method equals(otherLatLng: LatLng, maxMargin?: Number): 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; }
@ -54,7 +54,7 @@ L.LatLng.prototype = {
return margin <= (maxMargin === undefined ? 1.0E-9 : maxMargin);
},
// 🍂method toString(): String
// @method toString(): String
// Returns a string representation of the point (for debugging purposes).
toString: function (precision) {
return 'LatLng(' +
@ -62,19 +62,19 @@ L.LatLng.prototype = {
L.Util.formatNum(this.lng, precision) + ')';
},
// 🍂method distanceTo(otherLatLng: LatLng): Number
// @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));
},
// 🍂method wrap(): LatLng
// @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);
},
// 🍂method toBounds(sizeInMeters: Number): LatLngBounds
// @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,
@ -92,15 +92,15 @@ L.LatLng.prototype = {
// 🍂factory L.latLng(latitude: Number, longitude: Number, altitude?: Number): LatLng
// @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
// @alternative
// @factory L.latLng(coords: Array): LatLng
// Expects an array of the form `[Number, Number]` or `[Number, Number, Number]` instead.
// 🍂alternative
// 🍂factory L.latLng(coords: Object): LatLng
// @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) {

54
src/geo/LatLngBounds.js
View File

@ -1,10 +1,10 @@
/*
* 🍂class LatLngBounds
* 🍂aka L.LatLngBounds
* @class LatLngBounds
* @aka L.LatLngBounds
*
* Represents a rectangular geographical area on a map.
*
* 🍂example
* @example
*
* ```js
* var southWest = L.latLng(40.712, -74.227),
@ -34,11 +34,11 @@ L.LatLngBounds = function (southWest, northEast) { // (LatLng, LatLng) or (LatLn
L.LatLngBounds.prototype = {
// 🍂method extend(latlng: LatLng)
// @method extend(latlng: LatLng)
// Extend the bounds to contain the given point
// 🍂alternative
// 🍂method extend(otherBounds: LatLngBounds)
// @alternative
// @method extend(otherBounds: LatLngBounds)
// Extend the bounds to contain the given bounds
extend: function (obj) {
var sw = this._southWest,
@ -72,7 +72,7 @@ L.LatLngBounds.prototype = {
return this;
},
// 🍂method pad(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,
@ -85,7 +85,7 @@ L.LatLngBounds.prototype = {
new L.LatLng(ne.lat + heightBuffer, ne.lng + widthBuffer));
},
// 🍂method getCenter(): LatLng
// @method getCenter(): LatLng
// Returns the center point of the bounds.
getCenter: function () {
return new L.LatLng(
@ -93,59 +93,59 @@ L.LatLngBounds.prototype = {
(this._southWest.lng + this._northEast.lng) / 2);
},
// 🍂method getSouthWest(): LatLng
// @method getSouthWest(): LatLng
// Returns the south-west point of the bounds.
getSouthWest: function () {
return this._southWest;
},
// 🍂method getNorthEast(): LatLng
// @method getNorthEast(): LatLng
// Returns the north-east point of the bounds.
getNorthEast: function () {
return this._northEast;
},
// 🍂method getNorthWest(): LatLng
// @method getNorthWest(): LatLng
// Returns the north-west point of the bounds.
getNorthWest: function () {
return new L.LatLng(this.getNorth(), this.getWest());
},
// 🍂method getSouthEast(): LatLng
// @method getSouthEast(): LatLng
// Returns the south-east point of the bounds.
getSouthEast: function () {
return new L.LatLng(this.getSouth(), this.getEast());
},
// 🍂method getWest(): Number
// @method getWest(): Number
// Returns the west longitude of the bounds
getWest: function () {
return this._southWest.lng;
},
// 🍂method getSouth(): Number
// @method getSouth(): Number
// Returns the south latitude of the bounds
getSouth: function () {
return this._southWest.lat;
},
// 🍂method getEast(): Number
// @method getEast(): Number
// Returns the east longitude of the bounds
getEast: function () {
return this._northEast.lng;
},
// 🍂method getNorth(): Number
// @method getNorth(): Number
// Returns the north latitude of the bounds
getNorth: function () {
return this._northEast.lat;
},
// 🍂method contains(otherBounds: LatLngBounds): Boolean
// @method contains(otherBounds: LatLngBounds): Boolean
// Returns `true` if the rectangle contains the given one.
// 🍂alternative
// 🍂method contains (latlng: LatLng): Boolean
// @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) {
@ -169,7 +169,7 @@ L.LatLngBounds.prototype = {
(sw2.lng >= sw.lng) && (ne2.lng <= ne.lng);
},
// 🍂method intersects(otherBounds: LatLngBounds): Boolean
// @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);
@ -185,7 +185,7 @@ L.LatLngBounds.prototype = {
return latIntersects && lngIntersects;
},
// 🍂method overlaps(otherBounds: Bounds): Boolean
// @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);
@ -201,13 +201,13 @@ L.LatLngBounds.prototype = {
return latOverlaps && lngOverlaps;
},
// 🍂method toBBoxString(): String
// @method toBBoxString(): String
// Returns a string with bounding box coordinates in a 'southwest_lng,southwest_lat,northeast_lng,northeast_lat' format. Useful for sending requests to web services that return geo data.
toBBoxString: function () {
return [this.getWest(), this.getSouth(), this.getEast(), this.getNorth()].join(',');
},
// 🍂method equals(otherBounds: LatLngBounds): Boolean
// @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; }
@ -218,7 +218,7 @@ L.LatLngBounds.prototype = {
this._northEast.equals(bounds.getNorthEast());
},
// 🍂method isValid(): Boolean
// @method isValid(): Boolean
// Returns `true` if the bounds are properly initialized.
isValid: function () {
return !!(this._southWest && this._northEast);
@ -227,11 +227,11 @@ L.LatLngBounds.prototype = {
// TODO International date line?
// 🍂factory L.latLngBounds(southWest: LatLng, northEast: LatLng)
// @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[])
// @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) {

4
src/geo/crs/CRS.EPSG3395.js
View File

@ -1,6 +1,6 @@
/*
* 🍂namespace CRS
* 🍂crs L.CRS.EPSG3395
* @namespace CRS
* @crs L.CRS.EPSG3395
*
* Rarely used by some commercial tile providers. Uses Elliptical Mercator projection.
*/

4
src/geo/crs/CRS.EPSG3857.js
View File

@ -1,6 +1,6 @@
/*
* 🍂namespace CRS
* 🍂crs L.CRS.EPSG3857
* @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

4
src/geo/crs/CRS.EPSG4326.js
View File

@ -1,6 +1,6 @@
/*
* 🍂namespace CRS
* 🍂crs L.CRS.EPSG4326
* @namespace CRS
* @crs L.CRS.EPSG4326
*
* A common CRS among GIS enthusiasts. Uses simple Equirectangular projection.
*/

4
src/geo/crs/CRS.Earth.js
View File

@ -1,6 +1,6 @@
/*
* 🍂namespace CRS
* 🍂crs L.CRS.Earth
* @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,

4
src/geo/crs/CRS.Simple.js
View File

@ -1,6 +1,6 @@
/*
* 🍂namespace CRS
* 🍂crs L.CRS.Simple
* @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`

28
src/geo/crs/CRS.js
View File

@ -1,6 +1,6 @@
/*
* 🍂class CRS
* 🍂aka L.CRS
* @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 services). See
@ -12,7 +12,7 @@
*/
L.CRS = {
// 🍂method latLngToPoint(latlng: LatLng, zoom: 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),
@ -21,7 +21,7 @@ L.CRS = {
return this.transformation._transform(projectedPoint, scale);
},
// 🍂method pointToLatLng(point: Point, zoom: Number): 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) {
@ -31,21 +31,21 @@ L.CRS = {
return this.projection.unproject(untransformedPoint);
},
// 🍂method project(latlng: LatLng): Point
// @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
// @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
// @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.
@ -53,14 +53,14 @@ L.CRS = {
return 256 * Math.pow(2, zoom);
},
// 🍂method zoom(scale: Number): Number
// @method zoom(scale: Number): Number
// Inverse of `scale()`, returns the zoom level correspondingto a scale
// factor of `scale`.
zoom: function (scale) {
return Math.log(scale / 256) / Math.LN2;
},
// 🍂method getProjectedBounds(zoom): Bounds
// @method getProjectedBounds(zoom): Bounds
// Returns the projection's bounds scaled and transformed for the provided `zoom`.
getProjectedBounds: function (zoom) {
if (this.infinite) { return null; }
@ -73,25 +73,25 @@ L.CRS = {
return L.bounds(min, max);
},
// 🍂property code: String
// @property code: String
// Standard code name of the CRS passed into WMS services (e.g. `'EPSG:3857'`)
//
// 🍂property wrapLng: Number[]
// @property wrapLng: Number[]
// An array of two numbers defining whether the longitude coordinate axis
// wraps around a given range and how. Defaults to `[-180, 180]` in most
// geographical CRSs.
//
// 🍂property wrapLat: Number[]
// @property wrapLat: Number[]
// Like `wrapLng`, but for the latitude axis.
// wrapLng: [min, max],
// wrapLat: [min, max],
// 🍂property infinite: Boolean = false
// @property infinite: Boolean = false
// If true, the coordinate space will be unbounded (infinite in both axes)
infinite: false,
// 🍂method wrapLatLng(latlng: LatLng): LatLng
// @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) {

6
src/geo/projection/Projection.LonLat.js
View File

@ -1,9 +1,9 @@
/*
* 🍂namespace Projection
* 🍂section
* @namespace Projection
* @section
* Leaflet comes with a set of already defined Projections out of the box:
*
* 🍂projection L.Projection.LonLat
* @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

4
src/geo/projection/Projection.Mercator.js
View File

@ -1,6 +1,6 @@
/*
* 🍂namespace Projection
* 🍂projection L.Projection.Mercator
* @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.
*/

4
src/geo/projection/Projection.SphericalMercator.js
View File

@ -1,6 +1,6 @@
/*
* 🍂namespace Projection
* 🍂projection L.Projection.SphericalMercator
* @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

8
src/geo/projection/Projection.leafdoc
View File

@ -1,16 +1,16 @@
🍂class Projection
@class Projection
An object with methods for projecting geographical coordinates of the world onto
a flat surface (and back). See [Map projection](http://en.wikipedia.org/wiki/Map_projection).
🍂property bounds: LatLngBounds
@property bounds: LatLngBounds
The bounds where the projection is valid
🍂method project(latlng: LatLng): Point
@method project(latlng: LatLng): Point
Projects geographical coordinates into a 2D point.
🍂method unproject(point: Point): LatLng
@method unproject(point: Point): LatLng
The inverse of `project`. Projects a 2D point into a geographical location.

36
src/geometry/Bounds.js
View File

@ -1,10 +1,10 @@
/*
* 🍂class Bounds
* 🍂aka L.Bounds
* @class Bounds
* @aka L.Bounds
*
* Represents a rectangular area in pixel coordinates.
*
* 🍂example
* @example
*
* ```js
* var p1 = L.point(10, 10),
@ -30,14 +30,14 @@ L.Bounds = function (a, b) {
};
L.Bounds.prototype = {
// 🍂method extend(point: Point): this
// @method extend(point: Point): this
// Extends the bounds to contain the given point.
extend: function (point) { // (Point)
point = L.point(point);
// 🍂property min: Point
// @property min: Point
// The top left corner of the rectangle.
// 🍂property max: Point
// @property max: Point
// The bottom right corner of the rectangle.
if (!this.min && !this.max) {
this.min = point.clone();
@ -51,7 +51,7 @@ L.Bounds.prototype = {
return this;
},
// 🍂method getCenter(): Point
// @method getCenter(): Point
// Returns the center point of the bounds.
getCenter: function (round) {
return new L.Point(
@ -59,28 +59,28 @@ L.Bounds.prototype = {
(this.min.y + this.max.y) / 2, round);
},
// 🍂method getBottomLeft(): 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
// @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
// @method getSize(): Point
// Returns the size of the given bounds
getSize: function () {
return this.max.subtract(this.min);
},
// 🍂method contains(otherBounds: Bounds): Boolean
// @method contains(otherBounds: Bounds): Boolean
// Returns `true` if the rectangle contains the given one.
// 🍂alternative
// 🍂method contains(point: Point): Boolean
// @alternative
// @method contains(point: Point): Boolean
// Returns `true` if the rectangle contains the given poing.
contains: function (obj) {
var min, max;
@ -104,7 +104,7 @@ L.Bounds.prototype = {
(max.y <= this.max.y);
},
// 🍂method intersects(otherBounds: Bounds): Boolean
// @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
@ -120,7 +120,7 @@ L.Bounds.prototype = {
return xIntersects && yIntersects;
},
// 🍂method overlaps(otherBounds: Bounds): Boolean
// @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
@ -142,10 +142,10 @@ L.Bounds.prototype = {
};
// 🍂factory L.bounds(topLeft: Point, bottomRight: 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[])
// @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) {

8
src/geometry/LineUtil.js
View File

@ -1,5 +1,5 @@
/*
* 🍂namespace LineUtil
* @namespace LineUtil
*
* Various utility functions for polyine points processing, used by Leaflet internally to make polylines lightning-fast.
*/
@ -9,7 +9,7 @@ L.LineUtil = {
// Simplify polyline with vertex reduction and Douglas-Peucker simplification.
// Improves rendering performance dramatically by lessening the number of points to draw.
// 🍂function simplify(points: Point[], tolerance: Number): Point[]
// @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).
@ -33,13 +33,13 @@ L.LineUtil = {
return points;
},
// 🍂function pointToSegmentDistance(p: Point, p1: Point, p2: Point): Number
// @function pointToSegmentDistance(p: Point, p1: Point, p2: Point): Number
// Returns the distance between point `p` and segment `p1` to `p2`.
pointToSegmentDistance: function (p, p1, p2) {
return Math.sqrt(this._sqClosestPointOnSegment(p, p1, p2, true));
},
// 🍂function closestPointOnSegment(p: Point, p1: Point, p2: Point): Number
// @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);

40
src/geometry/Point.js
View File

@ -1,10 +1,10 @@
/*
* 🍂class Point
* 🍂aka L.Point
* @class Point
* @aka L.Point
*
* Represents a point with `x` and `y` coordinates in pixels.
*
* 🍂example
* @example
*
* ```js
* var point = L.point(200, 300);
@ -25,13 +25,13 @@ L.Point = function (x, y, round) {
L.Point.prototype = {
// 🍂method clone(): Point
// @method clone(): Point
// Returns a copy of the current point.
clone: function () {
return new L.Point(this.x, this.y);
},
// 🍂method add(otherPoint: Point): 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
@ -45,7 +45,7 @@ L.Point.prototype = {
return this;
},
// 🍂method subtract(otherPoint: Point): Point
// @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));
@ -57,7 +57,7 @@ L.Point.prototype = {
return this;
},
// 🍂method divideBy(num: Number): Point
// @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);
@ -69,7 +69,7 @@ L.Point.prototype = {
return this;
},
// 🍂method multiplyBy(num: Number): Point
// @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);
@ -81,7 +81,7 @@ L.Point.prototype = {
return this;
},
// 🍂method scaleBy(scale: Point): Point
// @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)
@ -90,14 +90,14 @@ L.Point.prototype = {
return new L.Point(this.x * point.x, this.y * point.y);
},
// 🍂method unscaleBy(scale: Point)
// @method unscaleBy(scale: 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
// @method round(): Point
// Returns a copy of the current point with rounded coordinates.
round: function () {
return this.clone()._round();
@ -109,7 +109,7 @@ L.Point.prototype = {
return this;
},
// 🍂method floor(): Point
// @method floor(): Point
// Returns a copy of the current point with floored coordinates (rounded down).
floor: function () {
return this.clone()._floor();
@ -121,7 +121,7 @@ L.Point.prototype = {
return this;
},
// 🍂method ceil(): Point
// @method ceil(): Point
// Returns a copy of the current point with ceiled coordinates (rounded up).
ceil: function () {
return this.clone()._ceil();
@ -133,7 +133,7 @@ L.Point.prototype = {
return this;
},
// 🍂method distanceTo(otherPoint: Point): Number
// @method distanceTo(otherPoint: Point): Number
// Returns the cartesian distance between the current and the given points.
distanceTo: function (point) {
point = L.point(point);
@ -144,7 +144,7 @@ L.Point.prototype = {
return Math.sqrt(x * x + y * y);
},
// 🍂method equals(otherPoint: Point): Boolean
// @method equals(otherPoint: Point): Boolean
// Returns `true` if the given point has the same coordinates.
equals: function (point) {
point = L.point(point);
@ -153,7 +153,7 @@ L.Point.prototype = {
point.y === this.y;
},
// 🍂method contains(otherPoint: Point): Boolean
// @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);
@ -162,7 +162,7 @@ L.Point.prototype = {
Math.abs(point.y) <= Math.abs(this.y);
},
// 🍂method toString(): String
// @method toString(): String
// Returns a string representation of the point for debugging purposes.
toString: function () {
return 'Point(' +
@ -171,11 +171,11 @@ L.Point.prototype = {
}
};
// 🍂factory L.point(x: Number, y: Number, round?: Boolean)
// @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[])
// @alternative
// @factory L.point(coords: Number[])
// Expects an array of the form `[x, y]` instead.
L.point = function (x, y, round) {
if (x instanceof L.Point) {

4
src/geometry/PolyUtil.js
View File

@ -1,11 +1,11 @@
/*
* 🍂namespace PolyUtil
* @namespace PolyUtil
* Various utility functions for polygon geometries.
*/
L.PolyUtil = {};
/* 🍂function clipPolygon(points: Point[], bounds: Bounds, round?: Boolean): Point[]
/* @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

10
src/geometry/Transformation.js
View File

@ -1,12 +1,12 @@
/*
* 🍂class Transformation
* 🍂aka L.Transformation
* @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
* @example
*
* ```js
* var transformation = new L.Transformation(2, 5, -1, 10),
@ -27,7 +27,7 @@ L.Transformation = function (a, b, c, d) {
};
L.Transformation.prototype = {
// 🍂method transform(point: Point, scale?: Number)
// @method transform(point: Point, scale?: Number)
// 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
@ -42,7 +42,7 @@ L.Transformation.prototype = {
return point;
},
// 🍂method untransform(point: Point, scale?: Number)
// @method untransform(point: Point, scale?: Number)
// 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) {

18
src/layer/FeatureGroup.js
View File

@ -1,11 +1,11 @@
/*
* 🍂class FeatureGroup
* 🍂aka L.FeatureGroup
* 🍂inherits LayerGroup
* @class FeatureGroup
* @aka L.FeatureGroup
* @inherits LayerGroup
*
* Extended `LayerGroup` that also has mouse events (propagated from members of the group) and a shared bindPopup method.
*
* 🍂example
* @example
*
* ```js
* L.featureGroup([marker1, marker2, polyline])
@ -44,25 +44,25 @@ L.FeatureGroup = L.LayerGroup.extend({
return this.fire('layerremove', {layer: layer});
},
// 🍂method setStyle(style: Path options): this
// @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
// @method bringToFront(): this
// Brings the layer group to the top of all other layers
bringToFront: function () {
return this.invoke('bringToFront');
},
// 🍂method bringToBack(): this
// @method bringToBack(): this
// Brings the layer group to the top of all other layers
bringToBack: function () {
return this.invoke('bringToBack');
},
// 🍂method getBounds(): LatLngBounds
// @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();
@ -75,7 +75,7 @@ L.FeatureGroup = L.LayerGroup.extend({
}
});
// 🍂factory L.featureGroup(layers: Layer[])
// @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);

56
src/layer/GeoJSON.js
View File

@ -1,12 +1,12 @@
/*
* 🍂class GeoJSON
* 🍂aka L.GeoJSON
* 🍂inherits FeatureGroup
* @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
* @example
*
* ```js
* L.geoJson(data, {
@ -21,10 +21,10 @@
L.GeoJSON = L.FeatureGroup.extend({
/* 🍂section
* 🍂aka GeoJSON options
/* @section
* @aka GeoJSON options
*
* 🍂option pointToLayer: Function = *
* @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`:
@ -34,7 +34,7 @@ L.GeoJSON = L.FeatureGroup.extend({
* }
* ```
*
* 🍂option style: Function = *
* @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:
@ -44,7 +44,7 @@ L.GeoJSON = L.FeatureGroup.extend({
* }
* ```
*
* 🍂option onEachFeature: Function = *
* @option onEachFeature: Function = *
* A `Function` that will be called once for each created `Layer`, 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:
@ -52,7 +52,7 @@ L.GeoJSON = L.FeatureGroup.extend({
* function (layer) {}
* ```
*
* 🍂option filter: Function = *
* @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
@ -61,7 +61,7 @@ L.GeoJSON = L.FeatureGroup.extend({
* }
* ```
*
* 🍂option coordsToLatLng: Function = *
* @option coordsToLatLng: Function = *
* A `Function` that will be used for converting GeoJSON coordinates to `LatLng`s.
* The default is the `coordsToLatLng` static method.
*/
@ -134,10 +134,10 @@ L.GeoJSON = L.FeatureGroup.extend({
}
});
// 🍂section
// @section
// There are several static functions which can be called without instantiating L.GeoJSON:
L.extend(L.GeoJSON, {
// 🍂function geometryToLayer(featureData: Object, options?: GeoJSON options): Layer
// @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.
@ -195,14 +195,14 @@ L.extend(L.GeoJSON, {
}
},
// 🍂function coordsToLatLng(coords: Array): 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]);
},
// 🍂function coordsToLatLngs(coords: Array, levelsDeep: Number, coordsToLatLng?: Function): Array
// @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.
@ -220,7 +220,7 @@ L.extend(L.GeoJSON, {
return latlngs;
},
// 🍂function latLngToCoords(latlng: LatLng): Array
// @function latLngToCoords(latlng: LatLng): Array
// Reverse of [`coordsToLatLng`](#geojson-coordstolatlng)
latLngToCoords: function (latlng) {
return latlng.alt !== undefined ?
@ -228,7 +228,7 @@ L.extend(L.GeoJSON, {
[latlng.lng, latlng.lat];
},
// 🍂function latLngsToCoords(latlngs: Array): Array
// @function latLngsToCoords(latlngs: Array): Array
// Reverse of [`coordsToLatLngs`](#geojson-coordstolatlngs)
latLngsToCoords: function (latlngs, levelsDeep, closed) {
var coords = [];
@ -252,7 +252,7 @@ L.extend(L.GeoJSON, {
L.GeoJSON.asFeature(newGeometry);
},
// 🍂function asFeature(geojson: Object): Object
// @function asFeature(geojson: Object): Object
// Normalize GeoJSON geometries/features into GeoJSON features.
asFeature: function (geojson) {
if (geojson.type === 'Feature') {
@ -278,15 +278,15 @@ var PointToGeoJSON = {
L.Marker.include(PointToGeoJSON);
// 🍂namespace CircleMarker
// 🍂method toGeoJSON(): Object
// @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);
// 🍂namespace Polyline
// 🍂method toGeoJSON(): Object
// @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);
@ -299,8 +299,8 @@ L.Polyline.prototype.toGeoJSON = function () {
});
};
// 🍂namespace Polygon
// 🍂method toGeoJSON(): Object
// @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),
@ -319,7 +319,7 @@ L.Polygon.prototype.toGeoJSON = function () {
};
// 🍂namespace LayerGroup
// @namespace LayerGroup
L.LayerGroup.include({
toMultiPoint: function () {
var coords = [];
@ -334,7 +334,7 @@ L.LayerGroup.include({
});
},
// 🍂method toGeoJSON(): Object
// @method toGeoJSON(): Object
// Returns a [`GeoJSON`](http://en.wikipedia.org/wiki/GeoJSON) representation of the layer group (as a GeoJSON `GeometryCollection`).
toGeoJSON: function () {
@ -368,8 +368,8 @@ L.LayerGroup.include({
}
});
// 🍂namespace GeoJSON
// 🍂factory L.geoJSON(geojson?: Object, options?: GeoJSON options)
// @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.

26
src/layer/ImageOverlay.js
View File

@ -1,11 +1,11 @@
/*
* 🍂class ImageOverlay
* 🍂aka L.ImageOverlay
* 🍂inherits Layer
* @class ImageOverlay
* @aka L.ImageOverlay
* @inherits Layer
*
* Used to load and display a single image over specific bounds of the map. Extends `Layer`.
*
* 🍂example
* @example
*
* ```js
* var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
@ -17,19 +17,19 @@
L.ImageOverlay = L.Layer.extend({
options: {
// 🍂option opacity: Number = 1.0
// @option opacity: Number = 1.0
// The opacity of the image overlay.
opacity: 1,
// 🍂option alt: String = ''
// @option alt: String = ''
// Text for the `alt` attribute of the image (useful for accessibility).
alt: '',
// 🍂option interactive: Boolean = true
// @option interactive: Boolean = true
// If `true`, the image overlay will emit mouse events when clicked or hovered.
interactive: false,
// 🍂option attribution: String = null
// @option attribution: String = null
// An optional string containing HTML to be shown on the `Attribution control`
attribution: null
@ -70,7 +70,7 @@ L.ImageOverlay = L.Layer.extend({
}
},
// 🍂method setOpacity(): this
// @method setOpacity(): this
// Sets the opacity of the overlay.
setOpacity: function (opacity) {
this.options.opacity = opacity;
@ -88,7 +88,7 @@ L.ImageOverlay = L.Layer.extend({
return this;
},
// 🍂method bringToFront(): this
// @method bringToFront(): this
// Brings the layer to the top of all overlays.
bringToFront: function () {
if (this._map) {
@ -97,7 +97,7 @@ L.ImageOverlay = L.Layer.extend({
return this;
},
// 🍂method bringToBack(): this
// @method bringToBack(): this
// Brings the layer to the bottom of all overlays.
bringToBack: function () {
if (this._map) {
@ -106,7 +106,7 @@ L.ImageOverlay = L.Layer.extend({
return this;
},
// 🍂method setUrl(url: String): this
// @method setUrl(url: String): this
// Changes the URL of the image.
setUrl: function (url) {
this._url = url;
@ -193,7 +193,7 @@ L.ImageOverlay = L.Layer.extend({
}
});
// 🍂factory L.imageOverlay(imageUrl: String, bounds: LatLngBounds, options?: ImageOverlay options)
// @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) {

22
src/layer/Layer.Popup.js
View File

@ -1,6 +1,6 @@
/*
* 🍂namespace Layer
* 🍂section Popup methods example
* @namespace Layer
* @section Popup methods example
*
* All layers share a set of methods convenient for binding popups to it.
*
@ -13,10 +13,10 @@
* 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
// @section Popup methods
L.Layer.include({
// 🍂method bindPopup(content: String|HTMLElement|Function|Popup, options?: Popup options): this
// @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`.
@ -48,7 +48,7 @@ L.Layer.include({
return this;
},
// 🍂method unbindPopup(): this
// @method unbindPopup(): this
// Removes the popup previously bound with `bindPopup`.
unbindPopup: function () {
if (this._popup) {
@ -63,7 +63,7 @@ L.Layer.include({
return this;
},
// 🍂method openPopup(latlng?: LatLng): 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)) {
@ -99,7 +99,7 @@ L.Layer.include({
return this;
},
// 🍂method closePopup(): this
// @method closePopup(): this
// Closes the popup bound to this layer if it is open.
closePopup: function () {
if (this._popup) {
@ -108,7 +108,7 @@ L.Layer.include({
return this;
},
// 🍂method closePopup(): this
// @method closePopup(): this
// Opens or closes the popup bound to this layer depending on its current state.
togglePopup: function (target) {
if (this._popup) {
@ -121,13 +121,13 @@ L.Layer.include({
return this;
},
// 🍂method closePopup(): this
// @method closePopup(): this
// Returns `true` if the popup bound to this layer is currently open.
isPopupOpen: function () {
return this._popup.isOpen();
},
// 🍂method setPopupContent(content: String|HTMLElement|Popup, options?: Popup options): this
// @method setPopupContent(content: String|HTMLElement|Popup, options?: Popup options): this
// Sets the content of the popup bound to this layer.
setPopupContent: function (content) {
if (this._popup) {
@ -136,7 +136,7 @@ L.Layer.include({
return this;
},
// 🍂method getPopup(): Popup
// @method getPopup(): Popup
// Returns the popup bound to this layer.
getPopup: function () {
return this._popup;

62
src/layer/Layer.js
View File

@ -1,14 +1,14 @@
/*
* 🍂class Layer
* 🍂inherits Evented
* 🍂aka L.Layer
* 🍂aka ILayer
* @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
* @example
*
* ```js
* var layer = L.Marker(latlng).addTo(map);
@ -16,10 +16,10 @@
* layer.remove();
* ```
*
* 🍂event add: Event
* @event add: Event
* Fired after the layer is added to a map
*
* 🍂event remove: Event
* @event remove: Event
* Fired after the layer is removed from a map
*/
@ -28,16 +28,16 @@ L.Layer = L.Evented.extend({
// Classes extending `L.Layer` will inherit the following options:
options: {
// 🍂option pane: String = 'overlayPane'
// @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
/* @section
* Classes extending `L.Layer` will inherit the following methods:
*
* 🍂method addTo(map: Map): this
* @method addTo(map: Map): this
* Adds the layer to the given map
*/
addTo: function (map) {
@ -45,13 +45,13 @@ L.Layer = L.Evented.extend({
return this;
},
// 🍂method remove: this
// @method remove: this
// Removes the layer from the map it is currently active on.
remove: function () {
return this.removeFrom(this._map || this._mapToAdd);
},
// 🍂method removeFrom(map: Map): this
// @method removeFrom(map: Map): this
// Removes the layer from the given map
removeFrom: function (obj) {
if (obj) {
@ -60,7 +60,7 @@ L.Layer = L.Evented.extend({
return this;
},
// 🍂method getPane(name? : String): HTMLElement
// @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);
@ -100,41 +100,41 @@ L.Layer = L.Evented.extend({
}
});
/* 🍂section Extension methods
* 🍂uninheritable
/* @section Extension methods
* @uninheritable
*
* Every layer should extend from `L.Layer` and (re-)implement the following methods.
*
* 🍂method onAdd(map: Map): this
* @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
* @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
* @method getEvents(): Object
* This optional method should return an object like `{ viewreset: this._reset }` for [`addEventListener`](#event-addeventlistener). These events will be automatically added and removed from the map with your layer.
*
* 🍂method getAttribution(): String
* @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
* @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.
*/
/* 🍂namespace Map
* 🍂section Layer events
/* @namespace Map
* @section Layer events
*
* 🍂event layeradd: LayerEvent
* @event layeradd: LayerEvent
* Fired when a new layer is added to the map.
*
* 🍂event layerremove: LayerEvent
* @event layerremove: LayerEvent
* Fired when some layer is removed from the map
*
* 🍂section Methods for Layers and Controls
* @section Methods for Layers and Controls
*/
L.Map.include({
// 🍂method addLayer(layer: Layer): this
// @method addLayer(layer: Layer): this
// Adds the given layer to the map
addLayer: function (layer) {
var id = L.stamp(layer);
@ -152,7 +152,7 @@ L.Map.include({
return this;
},
// 🍂method removeLayer(layer: Layer): this
// @method removeLayer(layer: Layer): this
// Removes the given layer from the map.
removeLayer: function (layer) {
var id = L.stamp(layer);
@ -183,13 +183,13 @@ L.Map.include({
return this;
},
// 🍂method hasLayer(layer: Layer): Boolean
// @method hasLayer(layer: Layer): Boolean
// Returns `true` if the given layer is currently added to the map
hasLayer: function (layer) {
return !!layer && (L.stamp(layer) in this._layers);
},
/* 🍂method eachLayer(fn: Function, context?: Object): this
/* @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){
@ -243,8 +243,8 @@ L.Map.include({
this._layersMaxZoom = maxZoom === -Infinity ? undefined : maxZoom;
this._layersMinZoom = minZoom === Infinity ? undefined : minZoom;
// 🍂section Map state change events
// 🍂event zoomlevelschange: Event
// @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()) {

34
src/layer/LayerGroup.js
View File

@ -1,13 +1,13 @@
/*
* 🍂class LayerGroup
* 🍂aka L.LayerGroup
* 🍂inherits 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
* @example
*
* ```js
* L.layerGroup([marker1, marker2])
@ -30,7 +30,7 @@ L.LayerGroup = L.Layer.extend({
}
},
// 🍂method addLayer(layer: Layer): this
// @method addLayer(layer: Layer): this
// Adds the given layer to the group.
addLayer: function (layer) {
var id = this.getLayerId(layer);
@ -44,10 +44,10 @@ L.LayerGroup = L.Layer.extend({
return this;
},
// 🍂method removeLayer(layer: Layer): this
// @method removeLayer(layer: Layer): this
// Removes the given layer from the group.
// 🍂alternative
// 🍂method removeLayer(id: Number): this
// @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);
@ -61,13 +61,13 @@ L.LayerGroup = L.Layer.extend({
return this;
},
// 🍂method hasLayer(layer: Layer): Boolean
// @method hasLayer(layer: Layer): Boolean
// Returns `true` if the given layer is currently added to the group.
hasLayer: function (layer) {
return !!layer && (layer in this._layers || this.getLayerId(layer) in this._layers);
},
// 🍂method clearLayers(): this
// @method clearLayers(): this
// Removes all the layers from the group.
clearLayers: function () {
for (var i in this._layers) {
@ -76,7 +76,7 @@ L.LayerGroup = L.Layer.extend({
return this;
},
// 🍂method invoke(methodName: string, …): 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`.
@ -107,7 +107,7 @@ L.LayerGroup = L.Layer.extend({
}
},
// 🍂method eachLayer(fn: Function, context?: Object): this
// @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) {
@ -121,13 +121,13 @@ L.LayerGroup = L.Layer.extend({
return this;
},
// 🍂method getLayer(id: Number): Layer
// @method getLayer(id: Number): Layer
// Returns the layer with the given internal ID.
getLayer: function (id) {
return this._layers[id];
},
// 🍂method getLayers(): Layer[]
// @method getLayers(): Layer[]
// Returns an array of all the layers added to the group.
getLayers: function () {
var layers = [];
@ -138,13 +138,13 @@ L.LayerGroup = L.Layer.extend({
return layers;
},
// 🍂method setZIndex(zIndex): this
// @method setZIndex(zIndex): 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
// @method getLayerId(layer: Layer): Number
// Returns the internal ID for a layer
getLayerId: function (layer) {
return L.stamp(layer);
@ -152,7 +152,7 @@ L.LayerGroup = L.Layer.extend({
});
// 🍂factory L.layerGroup(layers: 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);

120
src/layer/Popup.js
View File

@ -1,12 +1,12 @@
/*
* 🍂class Popup
* 🍂inherits Layer
* 🍂aka L.Popup
* @class Popup
* @inherits Layer
* @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
* @example
*
* If you want to just bind a popup to marker click and then open it, it's really easy:
*
@ -25,83 +25,83 @@
*/
/* 🍂namespace Map
* 🍂section Interaction Options
* 🍂option closePopupOnClick: Boolean = true
/* @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 Popup
// @namespace Popup
L.Popup = L.Layer.extend({
// 🍂section
// 🍂aka Popup options
// @section
// @aka Popup options
options: {
// 🍂option maxWidth: Number = 300
// @option maxWidth: Number = 300
// Max width of the popup, in pixels.
maxWidth: 300,
// 🍂option minWidth: Number = 50
// @option minWidth: Number = 50
// Min width of the popup, in pixels.
minWidth: 50,
// 🍂option maxHeight: Number = null
// @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
// @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
// @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 autoPanPaddingTopLeft: Point = null
// @option autoPanPaddingTopLeft: 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)
// @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
// @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
// @option closeButton: Boolean = true
// Controls the presence of a close button in the popup.
closeButton: true,
// 🍂option offset: Point = Point(0, 7)
// @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 autoClose: Boolean = 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 zoomAnimation: Boolean = true
// @option zoomAnimation: Boolean = true
// Whether to animate the popup on zoom. Disable it if you have
// problems with Flash content inside popups.
zoomAnimation: true,
// 🍂option className: String = ''
// @option className: String = ''
// A custom CSS class name to assign to the popup.
className: '',
// 🍂option pane: String = 'popupPane'
// @option pane: String = 'popupPane'
// `Map pane` where the popup will be added.
pane: 'popupPane'
},
@ -131,24 +131,24 @@ L.Popup = L.Layer.extend({
L.DomUtil.setOpacity(this._container, 1);
}
// 🍂namespace Map
// 🍂section Popup events
// 🍂event popupopen: PopupEvent
// @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
// @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);
this._source.on('preclick', L.DomEvent.stopPropagation);
}
},
// 🍂namespace Popup
// 🍂method openOn(map: Map): this
// @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);
@ -163,31 +163,31 @@ L.Popup = L.Layer.extend({
L.DomUtil.remove(this._container);
}
// 🍂namespace Map
// 🍂section Popup events
// 🍂event popupclose: PopupEvent
// @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
// @namespace Layer
// @section Popup events
// @event popupclose: PopupEvent
// Fired when a popup bound to this layer is closed
// 🍂namespace Popup
// @namespace Popup
this._source.fire('popupclose', {popup: this}, true);
this._source.off('preclick', L.DomEvent.stopPropagation);
}
},
// 🍂namespace Popup
// 🍂method getLatLng: LatLng
// @namespace Popup
// @method getLatLng: LatLng
// Returns the geographical point of popup.
getLatLng: function () {
return this._latlng;
},
// 🍂method setLatLng(latlng: LatLng): this
// @method setLatLng(latlng: LatLng): this
// Sets the geographical point where the popup will open.
setLatLng: function (latlng) {
this._latlng = L.latLng(latlng);
@ -198,13 +198,13 @@ L.Popup = L.Layer.extend({
return this;
},
// 🍂method getContent: String|HTMLElement
// @method getContent: String|HTMLElement
// Returns the content of the popup.
getContent: function () {
return this._content;
},
// 🍂method setContent(htmlContent: String|HTMLElement|Function): this
// @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;
@ -212,13 +212,13 @@ L.Popup = L.Layer.extend({
return this;
},
// 🍂method getElement: String|HTMLElement
// @method getElement: String|HTMLElement
// Alias for [getContent()](#popup-getcontent)
getElement: function () {
return this._container;
},
// 🍂method update: null
// @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; }
@ -252,13 +252,13 @@ L.Popup = L.Layer.extend({
return events;
},
// 🍂method isOpen: Boolean
// @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
// @method bringToFront: this
// Brings this popup in front of other popups (in the same map pane).
bringToFront: function () {
if (this._map) {
@ -267,7 +267,7 @@ L.Popup = L.Layer.extend({
return this;
},
// 🍂method bringToBack: this
// @method bringToBack: this
// Brings this popup to the back of other popups (in the same map pane).
bringToBack: function () {
if (this._map) {
@ -413,9 +413,9 @@ L.Popup = L.Layer.extend({
dy = containerPos.y - paddingTL.y;
}
// 🍂namespace Map
// 🍂section Popup events
// 🍂event autopanstart
// @namespace Map
// @section Popup events
// @event autopanstart
// Fired when the map starts autopanning when opening a popup.
if (dx || dy) {
map
@ -430,21 +430,21 @@ L.Popup = L.Layer.extend({
}
});
// 🍂namespace Popup
// 🍂factory L.popup(options?: Popup options, source?: Layer)
// @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 Methods for Layers and Controls
// @namespace Map
// @section Methods for Layers and Controls
L.Map.include({
// 🍂method openPopup(popup: Popup): this
// @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
// @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)) {
@ -467,7 +467,7 @@ L.Map.include({
return this.addLayer(popup);
},
// 🍂method closePopup(popup?: Popup): this
// @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) {

18
src/layer/marker/DivIcon.js
View File

@ -1,12 +1,12 @@
/*
* 🍂class DivIcon
* 🍂aka L.DivIcon
* 🍂inherits Icon
* @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
* @example
* ```js
* var myIcon = L.divIcon({className: 'my-div-icon'});
* // you can set .my-div-icon styles in CSS
@ -19,18 +19,18 @@
L.DivIcon = L.Icon.extend({
options: {
// 🍂section
// 🍂aka DivIcon options
// @section
// @aka DivIcon options
iconSize: [12, 12], // also can be set through CSS
// iconAnchor: (Point),
// popupAnchor: (Point),
// 🍂option html: String = ''
// @option html: String = ''
// Custom HTML code to put inside the div element, empty by default.
html: false,
// 🍂option bgPos: Point = [0, 0]
// @option bgPos: Point = [0, 0]
// Optional relative position of the background, in pixels
bgPos: null,
@ -57,7 +57,7 @@ L.DivIcon = L.Icon.extend({
}
});
// 🍂factory L.divIcon(options: DivIcon options)
// @factory L.divIcon(options: DivIcon options)
// Creates a `DivIcon` instance with the given options.
L.divIcon = function (options) {
return new L.DivIcon(options);

38
src/layer/marker/Icon.js
View File

@ -1,11 +1,11 @@
/*
* 🍂class Icon
* 🍂aka L.Icon
* 🍂inherits Layer
* @class Icon
* @aka L.Icon
* @inherits Layer
*
* Represents an icon to provide when creating a marker.
*
* 🍂example
* @example
*
* ```js
* var myIcon = L.icon({
@ -29,40 +29,40 @@
L.Icon = L.Class.extend({
/* 🍂section
* 🍂aka Icon options
/* @section
* @aka Icon options
*
* 🍂option iconUrl: String = null
* @option iconUrl: String = null
* **(required)** The URL to the icon image (absolute or relative to your script path).
*
* 🍂option iconRetinaUrl: String = null
* @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
* @option iconSize: Point = null
* Size of the icon image in pixels.
*
* 🍂option iconAnchor: Point = null
* @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
* @option popupAnchor: Point = null
* The coordinates of the point from which popups will "open", relative to the icon anchor.
*
* 🍂option shadowUrl: String = null
* @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 shadowRetinaUrl: String = null
*
* 🍂option shadowSize: Point = null
* @option shadowSize: Point = null
* Size of the shadow image in pixels.
*
* 🍂option shadowAnchor: Point = null
* @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 = ''
* @option className: String = ''
* A custom class name to assign to both icon and shadow images. Empty by default.
*/
@ -70,14 +70,14 @@ L.Icon = L.Class.extend({
L.setOptions(this, options);
},
// 🍂method createIcon(oldIcon: HTMLElement|null): HTMLElement
// @method createIcon(oldIcon: HTMLElement|null): 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);
},
// 🍂method createShadow(oldIcon: HTMLElement|null): HTMLElement
// @method createShadow(oldIcon: HTMLElement|null): HTMLElement
// As `createIcon`, but for the shadow beneath it.
createShadow: function (oldIcon) {
return this._createIcon('shadow', oldIcon);
@ -130,7 +130,7 @@ L.Icon = L.Class.extend({
});
// 🍂factory L.icon(options: Icon options)
// @factory L.icon(options: Icon options)
// Creates an icon instance with the given options.
L.icon = function (options) {
return new L.Icon(options);

18
src/layer/marker/Marker.Drag.js
View File

@ -3,8 +3,8 @@
*/
/* 🍂namespace Marker
* 🍂section Interaction handlers
/* @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:
*
@ -12,7 +12,7 @@
* marker.dragging.disable();
* ```
*
* 🍂property dragging: Handler
* @property dragging: Handler
* Marker dragging handler (by both mouse and touch).
*/
@ -54,11 +54,11 @@ L.Handler.MarkerDrag = L.Handler.extend({
},
_onDragStart: function () {
// 🍂section Dragging events
// 🍂event dragstart: Event
// @section Dragging events
// @event dragstart: Event
// Fired when the user starts dragging the marker.
// 🍂event movestart: Event
// @event movestart: Event
// Fired when the marker starts moving (because of dragging).
this._marker
.closePopup()
@ -80,7 +80,7 @@ L.Handler.MarkerDrag = L.Handler.extend({
marker._latlng = latlng;
e.latlng = latlng;
// 🍂event drag: Event
// @event drag: Event
// Fired repeatedly while the user drags the marker.
marker
.fire('move', e)
@ -88,10 +88,10 @@ L.Handler.MarkerDrag = L.Handler.extend({
},
_onDragEnd: function (e) {
// 🍂event dragend: DragEndEvent
// @event dragend: DragEndEvent
// Fired when the user stops dragging the marker.
// 🍂event moveend: Event
// @event moveend: Event
// Fired when the marker stops moving (because of dragging).
this._marker
.fire('moveend')

60
src/layer/marker/Marker.js
View File

@ -1,10 +1,10 @@
/*
* 🍂class Marker
* 🍂inherits Layer
* 🍂aka L.Marker
* @class Marker
* @inherits Layer
* @aka L.Marker
* L.Marker is used to display clickable/draggable icons on the map. Extends `Layer`.
*
* 🍂example
* @example
*
* ```js
* L.marker([50.5, 30.5]).addTo(map);
@ -14,47 +14,47 @@
L.Marker = L.Layer.extend({
options: {
// 🍂option icon: L.Icon = *
// @option icon: L.Icon = *
// Icon class to use for rendering the marker. See [Icon documentation](#L.Icon) for details on how to customize the marker icon. Set to new `L.Icon.Default()` by default.
icon: new L.Icon.Default(),
// 🍂option interactive: Boolean = true
// @option interactive: Boolean = true
// If `false`, the marker will not emit mouse events and will act as a part of the underlying map.
interactive: true,
// 🍂option draggable: Boolean = false
// @option draggable: Boolean = false
// Whether the marker is draggable with mouse/touch or not.
draggable: false,
// 🍂option keyboard: Boolean = true
// @option keyboard: Boolean = true
// Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.
keyboard: true,
// 🍂option title: String = ''
// @option title: String = ''
// Text for the browser tooltip that appear on marker hover (no tooltip by default).
title: '',
// 🍂option alt: String = ''
// @option alt: String = ''
// Text for the `alt` attribute of the icon image (useful for accessibility).
alt: '',
// 🍂option zIndexOffset: Number = 0
// @option zIndexOffset: Number = 0
// By default, marker images zIndex is set automatically based on its latitude. Use this option if you want to put the marker on top of all others (or below), specifying a high value like `1000` (or high negative value, respectively).
zIndexOffset: 0,
// 🍂option opacity: Number = 1.0
// @option opacity: Number = 1.0
// The opacity of the marker.
opacity: 1,
// 🍂option riseOnHover: Boolean = false
// @option riseOnHover: Boolean = false
// If `true`, the marker will get on top of others when you hover the mouse over it.
riseOnHover: false,
// 🍂option riseOffset: Number = 250
// @option riseOffset: Number = 250
// The z-index offset used for the `riseOnHover` feature.
riseOffset: 250,
// 🍂option pane: String = 'markerPane'
// @option pane: String = 'markerPane'
// `Map pane` where the markers icon will be added.
pane: 'markerPane',
@ -62,32 +62,32 @@ L.Marker = L.Layer.extend({
nonBubblingEvents: ['click', 'dblclick', 'mouseover', 'mouseout', 'contextmenu']
},
/* 🍂section
/* @section
*
* You can subscribe to the following events using [these methods](#evented-method).
*
* 🍂event click: MouseEvent
* @event click: MouseEvent
* Fired when the user clicks (or taps) the marker.
*
* 🍂event dblclick: MouseEvent
* @event dblclick: MouseEvent
* Fired when the user double-clicks (or double-taps) the marker.
*
* 🍂event mousedown: MouseEvent
* @event mousedown: MouseEvent
* Fired when the user pushes the mouse button on the marker.
*
* 🍂event mouseover: MouseEvent
* @event mouseover: MouseEvent
* Fired when the mouse enters the marker.
*
* 🍂event mouseout: MouseEvent
* @event mouseout: MouseEvent
* Fired when the mouse leaves the marker.
*
* 🍂event contextmenu: MouseEvent
* @event contextmenu: MouseEvent
* Fired when the user right-clicks on the marker.
*/
/* 🍂section
/* @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:
*/
@ -127,32 +127,32 @@ L.Marker = L.Layer.extend({
return events;
},
// 🍂method getLatLng: LatLng
// @method getLatLng: LatLng
// Returns the current geographical position of the marker.
getLatLng: function () {
return this._latlng;
},
// 🍂method setLatLng(latlng: LatLng): this
// @method setLatLng(latlng: LatLng): this
// Changes the marker position to the given point.
setLatLng: function (latlng) {
var oldLatLng = this._latlng;
this._latlng = L.latLng(latlng);
this.update();
// 🍂event move: Event
// @event move: Event
// Fired when the marker is moved via [`setLatLng`](#marker-setlatlng) or by [dragging](#marker-dragging). Old and new coordinates are included in event arguments as `oldLatLng`, `latlng`.
return this.fire('move', {oldLatLng: oldLatLng, latlng: this._latlng});
},
// 🍂method setZIndexOffset(offset: Number): 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();
},
// 🍂method setIcon(icon: Icon): this
// @method setIcon(icon: Icon): this
// Changes the marker icon.
setIcon: function (icon) {
@ -315,7 +315,7 @@ L.Marker = L.Layer.extend({
}
},
// 🍂method setOpacity(opacity: Number): this
// @method setOpacity(opacity: Number): this
// Changes the opacity of the marker.
setOpacity: function (opacity) {
this.options.opacity = opacity;
@ -348,7 +348,7 @@ L.Marker = L.Layer.extend({
// factory L.marker(latlng: LatLng, options? : Marker options)
// 🍂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);

76
src/layer/tile/GridLayer.js
View File

@ -1,14 +1,14 @@
/*
* 🍂class GridLayer
* 🍂inherits Layer
* 🍂aka L.GridLayer
* @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
* @section Synchronous usage
* @example
*
* To create a custom layer, extend GridLayer and impliment the `createTile()` method, which will be passed a `Point` object with the `x`, `y`, and `z` (zoom level) coordinates to draw your tile.
*
@ -32,8 +32,8 @@
* });
* ```
*
* 🍂section Asynchrohous usage
* 🍂example
* @section Asynchrohous usage
* @example
*
* Tile creation can also be asyncronous, this is useful when using a third-party drawing library. Once the tile is finsihed drawing it can be passed to the done() callback.
*
@ -56,55 +56,55 @@
* });
* ```
*
* 🍂section
* @section
*/
L.GridLayer = L.Layer.extend({
options: {
// 🍂option tileSize: Number|Point = 256
// @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,
// 🍂option opacity: Number = 1.0
// @option opacity: Number = 1.0
// Opacity of the tiles. Can be used in the `createTile()` function.
opacity: 1,
// 🍂option updateWhenIdle: Boolean = depends
// @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,
// 🍂option updateInterval: Number = 200
// @option updateInterval: Number = 200
// Tiles will not update more than once every `updateInterval` milliseconds.
updateInterval: 200,
// 🍂option attribution: String = null
// @option attribution: String = null
// String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
attribution: null,
// 🍂option zIndex: Number = 1
// @option zIndex: Number = 1
// The explicit zIndex of the tile layer.
zIndex: 1,
// 🍂option bounds: LatLngBounds = undefined
// @option bounds: LatLngBounds = undefined
// If set, tiles will only be loaded inside inside the set `LatLngBounds`.
bounds: null,
// 🍂option minZoom: Number = 0
// @option minZoom: Number = 0
// The minimum zoom level that tiles will be loaded at. By default the entire map.
minZoom: 0,
// 🍂option maxZoom: Number = undefined
// @option maxZoom: Number = undefined
// The maximum zoom level that tiles will be loaded at.
// maxZoom: undefined,
// 🍂option noWrap: Boolean = false
// @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.
noWrap: false,
// 🍂option pane: String = 'tilePane'
// @option pane: String = 'tilePane'
// `Map pane` where the grid layer will be added.
pane: 'tilePane'
},
@ -135,7 +135,7 @@ L.GridLayer = L.Layer.extend({
this._tileZoom = null;
},
// 🍂method bringToFront: this
// @method bringToFront: this
// Brings the tile layer to the top of all tile layers.
bringToFront: function () {
if (this._map) {
@ -145,7 +145,7 @@ L.GridLayer = L.Layer.extend({
return this;
},
// 🍂method bringToBack: this
// @method bringToBack: this
// Brings the tile layer to the bottom of all tile layers.
bringToBack: function () {
if (this._map) {
@ -155,19 +155,19 @@ L.GridLayer = L.Layer.extend({
return this;
},
// 🍂method getAttribution: String
// @method getAttribution: String
// Used by the `attribution control`, returns the [attribution option](#gridlayer-attribution).
getAttribution: function () {
return this.options.attribution;
},
// 🍂method getcontainer: String
// @method getcontainer: String
// Returns the HTML element that contains the tiles for this layer.
getContainer: function () {
return this._container;
},
// 🍂method setOpacity(opacity: Number): this
// @method setOpacity(opacity: Number): this
// Changes the [opacity](#gridlayer-opacity) of the grid layer.
setOpacity: function (opacity) {
this.options.opacity = opacity;
@ -175,7 +175,7 @@ L.GridLayer = L.Layer.extend({
return this;
},
// 🍂method setZIndex(zIndex: Number): this
// @method setZIndex(zIndex: Number): this
// Changes the [zIndex](#gridlayer-zindex) of the grid layer.
setZIndex: function (zIndex) {
this.options.zIndex = zIndex;
@ -184,13 +184,13 @@ L.GridLayer = L.Layer.extend({
return this;
},
// 🍂method isLoading: Boolean
// @method isLoading: Boolean
// Returns `true` if any tile in the grid layer has not finished loading.
isLoading: function () {
return this._loading;
},
// 🍂method redraw: this
// @method redraw: this
// Causes the layer to clear all the tiles and request them again.
redraw: function () {
if (this._map) {
@ -224,9 +224,9 @@ L.GridLayer = L.Layer.extend({
return events;
},
// 🍂section Extension methods
// @section Extension methods
// Layers extending `GridLayer` shall reimplement the following method.
// 🍂method createTile(coords: Object, done?: Function): HTMLElement
// @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.
@ -234,8 +234,8 @@ L.GridLayer = L.Layer.extend({
return document.createElement('div');
},
// 🍂section
// 🍂method getTileSize: Point
// @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;
@ -619,7 +619,7 @@ L.GridLayer = L.Layer.extend({
// if its the first batch of tiles to load
if (!this._loading) {
this._loading = true;
// 🍂event loading: Event
// @event loading: Event
// Fired when the grid layer starts loading tiles
this.fire('loading');
}
@ -692,7 +692,7 @@ L.GridLayer = L.Layer.extend({
delete this._tiles[key];
// 🍂event tileunload: TileEvent
// @event tileunload: TileEvent
// Fired when a tile is removed (e.g. when a tile goes off the screen).
this.fire('tileunload', {
tile: tile.el,
@ -747,7 +747,7 @@ L.GridLayer = L.Layer.extend({
};
container.appendChild(tile);
// 🍂event tileloadstart: TileEvent
// @event tileloadstart: TileEvent
// Fired when a tile is requested and starts loading.
this.fire('tileloadstart', {
tile: tile,
@ -759,7 +759,7 @@ L.GridLayer = L.Layer.extend({
if (!this._map) { return; }
if (err) {
// 🍂event tileerror: TileEvent
// @event tileerror: TileEvent
// Fired when there is an error loading a tile.
this.fire('tileerror', {
error: err,
@ -785,7 +785,7 @@ L.GridLayer = L.Layer.extend({
L.DomUtil.addClass(tile.el, 'leaflet-tile-loaded');
// 🍂event tileload: TileEvent
// @event tileload: TileEvent
// Fired when a tile loads.
this.fire('tileload', {
tile: tile.el,
@ -794,7 +794,7 @@ L.GridLayer = L.Layer.extend({
if (this._noTilesToLoad()) {
this._loading = false;
// 🍂event load: TileEvent
// @event load: TileEvent
// Fired when the grid layer loaded all visible tiles.
this.fire('load');
@ -835,7 +835,7 @@ L.GridLayer = L.Layer.extend({
}
});
// 🍂factory L.gridLayer(options?: GridLayer 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);

30
src/layer/tile/TileLayer.WMS.js
View File

@ -1,10 +1,10 @@
/*
* 🍂class TileLayer.WMS
* 🍂inherits TileLayer
* 🍂aka L.TileLayer.WMS
* @class TileLayer.WMS
* @inherits TileLayer
* @aka L.TileLayer.WMS
* Used to display WMS services as tile layers on the map. Extends `TileLayer`.
*
* 🍂example
* @example
*
* ```js
* var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
@ -18,40 +18,40 @@
L.TileLayer.WMS = L.TileLayer.extend({
// 🍂section
// 🍂aka TileLayer.WMS options
// @section
// @aka TileLayer.WMS options
defaultWmsParams: {
service: 'WMS',
request: 'GetMap',
// 🍂option layers: String = ''
// @option layers: String = ''
// **(required)** Comma-separated list of WMS layers to show.
layers: '',
// 🍂option styles: String = ''
// @option styles: String = ''
// Comma-separated list of WMS styles.
styles: '',
// 🍂option format: String = 'image/jpeg'
// @option format: String = 'image/jpeg'
// WMS image format (use `'image/png'` for layers with transparency).
format: 'image/jpeg',
// 🍂option styles: Boolean = false
// @option styles: Boolean = false
// If `true`, the WMS service will return images with transparency.
transparent: false,
// 🍂option version: String = '1.1.1'
// @option version: String = '1.1.1'
// Version of the WMS service to use
version: '1.1.1'
},
options: {
// 🍂option crs: CRS = null
// @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
// @option uppercase: Boolean = false
// If `true`, WMS request parameter keys will be uppercase.
uppercase: false
},
@ -104,7 +104,7 @@ L.TileLayer.WMS = L.TileLayer.extend({
(this.options.uppercase ? '&BBOX=' : '&bbox=') + bbox;
},
// 🍂method setParams(params: Object, noRedraw?: Boolean): this
// @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) {
@ -119,7 +119,7 @@ L.TileLayer.WMS = L.TileLayer.extend({
});
// 🍂factory L.tileLayer.wms(baseUrl: String, options: TileLayer.WMS options)
// @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);

46
src/layer/tile/TileLayer.js
View File

@ -1,17 +1,17 @@
/*
* 🍂class TileLayer
* 🍂inherits GridLayer
* 🍂aka L.TileLayer
* @class TileLayer
* @inherits GridLayer
* @aka L.TileLayer
* Used to load and display tile layers on the map. Extends `GridLayer`.
*
* 🍂example
* @example
*
* ```js
* L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);
* ```
*
* 🍂section URL template
* 🍂example
* @section URL template
* @example
*
* A string of the following form:
*
@ -27,52 +27,52 @@
* L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});
* ```
*
* 🍂section
* @section
*/
L.TileLayer = L.GridLayer.extend({
options: {
// 🍂option minZoom: Number = 0
// @option minZoom: Number = 0
// Minimum zoom number.
minZoom: 0,
// 🍂option maxZoom: Number = 18
// @option maxZoom: Number = 18
// Maximum zoom number.
maxZoom: 18,
// 🍂option maxNativeZoom: Number = null
// @option maxNativeZoom: Number = null
// Maximum zoom number the tile source has available. If it is specified,
// the tiles on all zoom levels higher than `maxNativeZoom` will be loaded
// from `maxNativeZoom` level and auto-scaled.
maxNativeZoom: null,
// 🍂option subdomains: String|String[] = 'abc'
// @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',
// 🍂option errorTileUrl: String = ''
// @option errorTileUrl: String = ''
// URL to the tile image to show in place of the tile that failed to load.
errorTileUrl: '',
// 🍂option zoomOffset: Number = 0
// @option zoomOffset: Number = 0
// The zoom number used in tile URLs will be offset with this value.
zoomOffset: 0,
// 🍂option tms: Boolean = false
// @option tms: Boolean = false
// If `true`, inverses Y axis numbering for tiles (turn this on for TMS services).
tms: false,
// 🍂option zoomReverse: Boolean = false
// @option zoomReverse: Boolean = false
// If set to true, the zoom number used in tile URLs will be reversed (`maxZoom - zoom` instead of `zoom`)
zoomReverse: false,
// 🍂option detectRetina: Boolean = false
// @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
// @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
},
@ -103,7 +103,7 @@ L.TileLayer = L.GridLayer.extend({
}
},
// 🍂method setUrl(url: String, noRedraw?: Boolean): this
// @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;
@ -114,7 +114,7 @@ L.TileLayer = L.GridLayer.extend({
return this;
},
// 🍂method createTile(coords: Object, done?: Function): HTMLElement
// @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.
@ -139,10 +139,10 @@ L.TileLayer = L.GridLayer.extend({
return tile;
},
// 🍂section Extension methods
// 🍂uninheritable
// @section Extension methods
// @uninheritable
// Layers extending `TileLayer` might reimplement the following method.
// 🍂method getTileUrl(coords: Object): String
// @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) {
@ -236,7 +236,7 @@ L.TileLayer = L.GridLayer.extend({
});
// 🍂factory L.tilelayer(urlTemplate: String, options? TileLayer options)
// @factory L.tilelayer(urlTemplate: String, options? TileLayer options)
// Instantiates a tile layer object given a `URL template` and optionally an options object.
L.tileLayer = function (url, options) {

14
src/layer/vector/Canvas.js
View File

@ -1,7 +1,7 @@
/*
* 🍂class Canvas
* 🍂inherits Renderer
* 🍂aka L.Canvas
* @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`.
@ -10,7 +10,7 @@
* available in all web browsers, notably IE8, and overlapping geometries might
* not display properly in some edge cases.
*
* 🍂example
* @example
*
* Use Canvas by default for all paths in the map:
*
@ -303,14 +303,14 @@ L.Canvas = L.Renderer.extend({
_bringToBack: L.Util.falseFn
});
// 🍂namespace Browser; 🍂property canvas: Boolean
// @namespace Browser; @property canvas: Boolean
// `true` when the browser supports [`<canvas>`](https://developer.mozilla.org/docs/Web/API/Canvas_API).
L.Browser.canvas = (function () {
return !!document.createElement('canvas').getContext;
}());
// 🍂namespace Canvas
// 🍂factory L.canvas(options?: Canvas options)
// @namespace Canvas
// @factory L.canvas(options?: Canvas options)
// Creates a Canvas renderer with the given options.
L.canvas = function (options) {
return L.Browser.canvas ? new L.Canvas(options) : null;

22
src/layer/vector/Circle.js
View File

@ -1,13 +1,13 @@
/*
* 🍂class Circle
* 🍂aka L.Circle
* 🍂inherits CircleMarker
* @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
* @example
*
* ```js
* L.circle([50.5, 30.5], 200).addTo(map);
@ -26,24 +26,24 @@ L.Circle = L.CircleMarker.extend({
if (isNaN(this.options.radius)) { throw new Error('Circle radius cannot be NaN'); }
// 🍂option radius: Number; Radius of the circle, in meters.
// @option radius: Number; Radius of the circle, in meters.
this._mRadius = this.options.radius;
},
// 🍂method setRadius(radius: Number): this
// @method setRadius(radius: Number): this
// Sets the radius of a circle. Units are in meters.
setRadius: function (radius) {
this._mRadius = radius;
return this.redraw();
},
// 🍂method getRadius(): Number
// @method getRadius(): Number
// Returns the current radius of a circle. Units are in meters.
getRadius: function () {
return this._mRadius;
},
// 🍂method getBounds(): LatLngBounds
// @method getBounds(): LatLngBounds
// Returns the `LatLngBounds` of the path.
getBounds: function () {
var half = [this._radius, this._radiusY || this._radius];
@ -91,11 +91,11 @@ L.Circle = L.CircleMarker.extend({
}
});
// 🍂factory L.circle(latlng: LatLng, options?: Path options)
// @factory L.circle(latlng: LatLng, options?: Path 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?: Path options)
// @alternative
// @factory L.circle(latlng: LatLng, radius: Number, options?: Path 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) {

18
src/layer/vector/CircleMarker.js
View File

@ -1,7 +1,7 @@
/*
* 🍂class CircleMarker
* 🍂aka L.CircleMarker
* 🍂inherits Path
* @class CircleMarker
* @aka L.CircleMarker
* @inherits Path
*
* A circle of a fixed size with radius specified in pixels. Extends `Path`.
*/
@ -11,7 +11,7 @@ L.CircleMarker = L.Path.extend({
options: {
fill: true,
// 🍂option radius: Number = 10
// @option radius: Number = 10
// Radius of the circle marker, in pixels
radius: 10
},
@ -22,7 +22,7 @@ L.CircleMarker = L.Path.extend({
this._radius = this.options.radius;
},
// 🍂method setLatLng(latLng: LatLng): this
// @method setLatLng(latLng: LatLng): this
// Sets the position of a circle marker to a new location.
setLatLng: function (latlng) {
this._latlng = L.latLng(latlng);
@ -30,20 +30,20 @@ L.CircleMarker = L.Path.extend({
return this.fire('move', {latlng: this._latlng});
},
// 🍂method getLatLng(): LatLng
// @method getLatLng(): LatLng
// Returns the current geographical position of the circle marker
getLatLng: function () {
return this._latlng;
},
// 🍂method setRadius(radius: Number): this
// @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();
},
// 🍂method getRadius(): Number
// @method getRadius(): Number
// Returns the current radius of the circle
getRadius: function () {
return this._radius;
@ -85,7 +85,7 @@ L.CircleMarker = L.Path.extend({
});
// 🍂factory L.circleMarker(latlng: LatLng, options? CircleMarker options)
// @factory L.circleMarker(latlng: LatLng, options? CircleMarker options)
//
L.circleMarker = function (latlng, options) {
return new L.CircleMarker(latlng, options);

44
src/layer/vector/Path.js
View File

@ -1,7 +1,7 @@
/*
* 🍂class Path
* 🍂aka L.Path
* 🍂inherits Layer
* @class Path
* @aka L.Path
* @inherits Layer
*
* An abstract class that contains options and constants shared between vector
* overlays (Polygon, Polyline, Circle). Do not use it directly. Extends `Layer`.
@ -9,60 +9,60 @@
L.Path = L.Layer.extend({
// 🍂section
// 🍂aka Path options
// @section
// @aka Path options
options: {
// 🍂option stroke: Boolean = true
// @option stroke: Boolean = true
// Whether to draw stroke along the path. Set it to `false` to disable borders on polygons or circles.
stroke: true,
// 🍂option color: String = '#3388ff'
// @option color: String = '#3388ff'
// Stroke color
color: '#3388ff',
// 🍂option weight: Number = 3
// @option weight: Number = 3
// Stroke width in pixels
weight: 3,
// 🍂option opacity: Number = 1.0
// @option opacity: Number = 1.0
// Stroke opacity
opacity: 1,
// 🍂option lineCap: String= 'round'
// @option lineCap: String= 'round'
// A string that defines [shape to be used at the end](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linecap) of the stroke.
lineCap: 'round',
// 🍂option lineJoin: String = 'round'
// @option lineJoin: String = 'round'
// A string that defines [shape to be used at the corners](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-linejoin) of the stroke.
lineJoin: 'round',
// 🍂option dashArray: String = null
// @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 (e.g. Android 2).
dashArray: null,
// 🍂option dashOffset: String = null
// @option dashOffset: String = null
// A string that defines the [distance into the dash pattern to start the dash](https://developer.mozilla.org/docs/Web/SVG/Attribute/stroke-dashoffset). Doesn't work on canvas-powered layers
dashOffset: null,
// 🍂option fill: Boolean = depends
// @option fill: Boolean = depends
// Whether to fill the path with color. Set it to `false` to disable filling on polygons or circles.
fill: false,
// 🍂option fillColor: String = *
// @option fillColor: String = *
// Fill color. Defaults to the value of the [`color`](#path-color) option
fillColor: null,
// 🍂option fillOpacity: Number = 0.2
// @option fillOpacity: Number = 0.2
// Fill opacity.
fillOpacity: 0.2,
// 🍂option fillRule: String = 'evenodd'
// @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 interactive: Boolean = true
// @option interactive: Boolean = true
// If `false`, the vector will not emit mouse events and will act as a part of the underlying map.
interactive: true
},
@ -91,7 +91,7 @@ L.Path = L.Layer.extend({
};
},
// 🍂method redraw(): this
// @method redraw(): this
// Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.
redraw: function () {
if (this._map) {
@ -100,7 +100,7 @@ L.Path = L.Layer.extend({
return this;
},
// 🍂method setStyle(style: Path options): 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);
@ -110,7 +110,7 @@ L.Path = L.Layer.extend({
return this;
},
// 🍂method bringToFront(): this
// @method bringToFront(): this
// Brings the layer to the top of all path layers.
bringToFront: function () {
if (this._renderer) {
@ -119,7 +119,7 @@ L.Path = L.Layer.extend({
return this;
},
// 🍂method bringToBack(): this
// @method bringToBack(): this
// Brings the layer to the bottom of all path layers.
bringToBack: function () {
if (this._renderer) {

10
src/layer/vector/Polygon.js
View File

@ -1,14 +1,14 @@
/*
* 🍂class Polygon
* 🍂aka L.Polygon
* 🍂inherits Polyline
* @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
* @example
*
* ```js
* // create a red polygon from an array of LatLng points
@ -140,7 +140,7 @@ L.Polygon = L.Polyline.extend({
});
// 🍂factory L.polygon(latlngs: LatLng[], options?: Path options)
// @factory L.polygon(latlngs: LatLng[], options?: Path options)
L.polygon = function (latlngs, options) {
return new L.Polygon(latlngs, options);
};

26
src/layer/vector/Polyline.js
View File

@ -1,11 +1,11 @@
/*
* 🍂class Polyline
* 🍂aka L.Polyline
* 🍂inherits Path
* @class Polyline
* @aka L.Polyline
* @inherits Path
*
* A class for drawing polyline overlays on a map. Extends `Path`.
*
* 🍂example
* @example
*
* ```js
* // create a red polyline from an array of LatLng points
@ -39,12 +39,12 @@
L.Polyline = L.Path.extend({
options: {
// 🍂option smoothFactor: Number = 1.0
// @option smoothFactor: Number = 1.0
// How much to simplify the polyline on each zoom level. More means
// better performance and smoother look, and less means more accurate representation.
smoothFactor: 1.0,
// 🍂option noClip: Boolean: false
// @option noClip: Boolean: false
// Disable polyline clipping.
noClip: false
},
@ -54,20 +54,20 @@ L.Polyline = L.Path.extend({
this._setLatLngs(latlngs);
},
// 🍂method getLatLngs(): LatLng[]
// @method getLatLngs(): LatLng[]
// Returns an array of the points in the path, or nested arrays of points in case of multi-polyline.
getLatLngs: function () {
return this._latlngs;
},
// 🍂method setLatLngs(latlngs: LatLng[]): this
// @method setLatLngs(latlngs: LatLng[]): this
// Replaces all the points in the polyline with the given array of geographical points.
setLatLngs: function (latlngs) {
this._setLatLngs(latlngs);
return this.redraw();
},
// 🍂method isEmpty(): Boolean
// @method isEmpty(): Boolean
// Returns `true` if the Polyline has no LatLngs.
isEmpty: function () {
return !this._latlngs.length;
@ -100,7 +100,7 @@ L.Polyline = L.Path.extend({
return minPoint;
},
// 🍂method getCenter(): LatLng
// @method getCenter(): LatLng
// Returns the center ([centroid](http://en.wikipedia.org/wiki/Centroid)) of the polyline.
getCenter: function () {
var i, halfDist, segDist, dist, p1, p2, ratio,
@ -136,13 +136,13 @@ L.Polyline = L.Path.extend({
}
},
// 🍂method getBounds(): LatLngBounds
// @method getBounds(): LatLngBounds
// Returns the `LatLngBounds` of the path.
getBounds: function () {
return this._bounds;
},
// 🍂method addLatLng(latlng: LatLng, latlngs? LatLng[]): this
// @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)).
@ -275,7 +275,7 @@ L.Polyline = L.Path.extend({
}
});
// 🍂factory L.polyline(latlngs: LatLng[], options?: Path options)
// @factory L.polyline(latlngs: LatLng[], options?: Path 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

12
src/layer/vector/Rectangle.js
View File

@ -3,13 +3,13 @@
*/
/*
* 🍂class Rectangle
* 🍂aka L.Retangle
* 🍂inherits Polygon
* @class Rectangle
* @aka L.Retangle
* @inherits Polygon
*
* A class for drawing rectangle overlays on a map. Extends `Polygon`.
*
* 🍂example
* @example
*
* ```js
* // define rectangle geographical bounds
@ -30,7 +30,7 @@ L.Rectangle = L.Polygon.extend({
L.Polygon.prototype.initialize.call(this, this._boundsToLatLngs(latLngBounds), options);
},
// 🍂method setBounds(latLngBounds: LatLngBounds): this
// @method setBounds(latLngBounds: LatLngBounds): this
// Redraws the rectangle with the passed bounds.
setBounds: function (latLngBounds) {
return this.setLatLngs(this._boundsToLatLngs(latLngBounds));
@ -48,7 +48,7 @@ L.Rectangle = L.Polygon.extend({
});
// 🍂factory L.rectangle(latLngBounds: LatLngBounds, options?: Path options)
// @factory L.rectangle(latLngBounds: LatLngBounds, options?: Path options)
L.rectangle = function (latLngBounds, options) {
return new L.Rectangle(latLngBounds, options);
};

16
src/layer/vector/Renderer.js
View File

@ -1,7 +1,7 @@
/*
* 🍂class Renderer
* 🍂inherits Layer
* 🍂aka L.Renderer
* @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.
@ -18,7 +18,7 @@
L.Renderer = L.Layer.extend({
options: {
// 🍂option padding: Number = 0.1
// @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
@ -103,20 +103,20 @@ L.Renderer = L.Layer.extend({
L.Map.include({
// 🍂namespace Map; 🍂method getRenderer(layer: Path): Renderer
// @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 Map; 🍂option renderer: Renderer
// @namespace Map; @option renderer: Renderer
// Use this specific instance of `Renderer` by default for new `Path`s added to the map
// 🍂namespace Path; 🍂option renderer: Renderer
// @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
// @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();

4
src/layer/vector/SVG.VML.js
View File

@ -3,7 +3,7 @@
*/
/*
* 🍂class SVG
* @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.
*
@ -11,7 +11,7 @@
* with old versions of Internet Explorer.
*/
// 🍂namespace Browser; 🍂property vml: Boolean
// @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 {

24
src/layer/vector/SVG.js
View File

@ -1,7 +1,7 @@
/*
* 🍂class SVG
* 🍂inherits Renderer
* 🍂aka L.SVG
* @class SVG
* @inherits Renderer
* @aka L.SVG
*
* Allows vector layers to be displayed with [SVG](https://developer.mozilla.org/docs/Web/SVG).
* Inherits `Renderer`.
@ -14,7 +14,7 @@
* (a now deprecated technology), and the SVG renderer will fall back to VML in
* this case.
*
* 🍂example
* @example
*
* Use SVG by default for all paths in the map:
*
@ -85,8 +85,8 @@ L.SVG = L.Renderer.extend({
_initPath: function (layer) {
var path = layer._path = L.SVG.create('path');
// 🍂namespace Path
// 🍂option className: string = null
// @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);
@ -187,10 +187,10 @@ L.SVG = L.Renderer.extend({
});
// 🍂namespace SVG; 🍂section
// @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
// @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).
@ -198,7 +198,7 @@ L.extend(L.SVG, {
return document.createElementNS('http://www.w3.org/2000/svg', name);
},
// 🍂function pointsToPath(rings: [], closed: Boolean): String
// @function pointsToPath(rings: [], closed: Boolean): String
// Generates a SVG path string for multiple rings, with each ring turning
// into "M..L..L.." instructions
pointsToPath: function (rings, closed) {
@ -222,13 +222,13 @@ L.extend(L.SVG, {
}
});
// 🍂namespace Browser; 🍂property svg: Boolean
// @namespace Browser; @property svg: Boolean
// `true` when the browser supports [SVG](https://developer.mozilla.org/docs/Web/SVG).
L.Browser.svg = !!(document.createElementNS && L.SVG.create('svg').createSVGRect);
// 🍂namespace SVG
// 🍂factory L.svg(options?: SVG options)
// @namespace SVG
// @factory L.svg(options?: SVG 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;

235
src/map/Map.js
View File

@ -1,11 +1,11 @@
/*
* 🍂class Map
* 🍂aka L.Map
* 🍂inherits Evented
* @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
* @example
*
* ```js
* // initialize the map on the "map" div with a given center and zoom
@ -20,58 +20,58 @@
L.Map = L.Evented.extend({
options: {
// 🍂section Map State Options
// 🍂option crs: CRS = L.CRS.EPSG3857
// @section Map State Options
// @option crs: CRS = L.CRS.EPSG3857
// The [Coordinate Reference System](#crs) to use. Don't change this if you're not
// sure what it means.
crs: L.CRS.EPSG3857,
// 🍂option center: LatLng = undefined
// @option center: LatLng = undefined
// Initial geographic center of the map
center: undefined,
// 🍂option zoom: Number = undefined
// @option zoom: Number = undefined
// Initial map zoom level
zoom: undefined,
// 🍂option minZoom: Number = 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
// @option maxZoom: Number = undefined
// Maximum zoom level of the map. Overrides any `maxZoom` option set on map layers.
maxZoom: undefined,
// 🍂option layers: Layer[] = []
// @option layers: Layer[] = []
// Array of layers that will be added to the map initially
layers: [],
// 🍂option maxBounds: LatLngBounds = null
// @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 = *
// @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
// @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
// @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 maxBoundsViscosity: Number = 0.0
// @option maxBoundsViscosity: Number = 0.0
// If `maxBounds` is set, this options 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
@ -79,14 +79,14 @@ L.Map = L.Evented.extend({
// solid, preventing the user from dragging outside the bounds.
maxBoundsViscosity: 0.0,
// 🍂option transform3DLimit: Number = 2^23
// @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
// @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
@ -94,14 +94,14 @@ L.Map = L.Evented.extend({
// means the zoom level will not be snapped after `fitBounds` or a pinch-zoom.
zoomSnap: 1,
// 🍂option zoomDelta: Number = 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
// @option trackResize: Boolean = true
// Whether the map automatically handles browser window resize to update itself.
trackResize: true
},
@ -140,9 +140,9 @@ L.Map = L.Evented.extend({
},
// 🍂section Methods for modifying map state
// @section Methods for modifying map state
// 🍂method setView(center: LatLnt, zoom: Number, options?: Zoom/Pan options): this
// @method setView(center: LatLnt, 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) {
@ -152,7 +152,7 @@ L.Map = L.Evented.extend({
return this;
},
// 🍂method setZoom(zoom: Number, options: Zoom/Pan options): this
// @method setZoom(zoom: Number, options: Zoom/Pan options): this
// Sets the zoom of the map.
setZoom: function (zoom, options) {
if (!this._loaded) {
@ -162,25 +162,25 @@ L.Map = L.Evented.extend({
return this.setView(this.getCenter(), zoom, {zoom: options});
},
// 🍂method zoomIn(delta?: Number, options?: Zoom options): this
// @method zoomIn(delta?: Number, options?: Zoom options): this
// Increases the zoom of the map by `delta` ([`zoomDelta`](#map-zoomdelta) by default).
zoomIn: function (delta, options) {
delta = delta || (L.Browser.any3d ? this.options.zoomDelta : 1);
return this.setZoom(this._zoom + delta, options);
},
// 🍂method zoomOut(delta?: Number, options?: Zoom options): this
// @method zoomOut(delta?: Number, options?: Zoom options): this
// Decreases the zoom of the map by `delta` ([`zoomDelta`](#map-zoomdelta) by default).
zoomOut: function (delta, options) {
delta = delta || (L.Browser.any3d ? this.options.zoomDelta : 1);
return this.setZoom(this._zoom - delta, options);
},
// 🍂method setZoomAround(latlng: LatLng, zoom: Number, options: Zoom options): this
// @method setZoomAround(latlng: LatLng, zoom: Number, options: Zoom options): this
// Zooms the map while keeping a specified geographical point on the map
// stationary (e.g. used internally for scroll zoom and double-click zoom).
// 🍂alternative
// 🍂method setZoomAround(offset: Point, zoom: Number, options: Zoom options): this
// @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),
@ -217,7 +217,7 @@ L.Map = L.Evented.extend({
};
},
// 🍂method fitBounds(bounds: LatLngBounds, options: fitBounds options): this
// @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) {
@ -230,20 +230,20 @@ L.Map = L.Evented.extend({
return this.setView(target.center, target.zoom, options);
},
// 🍂method fitWorld(options?: fitBounds options): this
// @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
// @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
// @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
@ -255,7 +255,7 @@ L.Map = L.Evented.extend({
return this.fire('moveend');
},
// 🍂method setMaxBounds(bounds: Bounds): this
// @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);
@ -275,7 +275,7 @@ L.Map = L.Evented.extend({
return this.on('moveend', this._panInsideMaxBounds);
},
// 🍂method setMinZoom(zoom: Number): 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;
@ -287,7 +287,7 @@ L.Map = L.Evented.extend({
return this;
},
// 🍂method setMaxZoom(zoom: Number): this
// @method setMaxZoom(zoom: Number): this
// Sets the upper limit for the available zoom levels (see the [maxZoom](#map-maxzoom) option).
setMaxZoom: function (zoom) {
this.options.maxZoom = zoom;
@ -299,7 +299,7 @@ L.Map = L.Evented.extend({
return this;
},
// 🍂method panInsideBounds(bounds: LatLngBounds, options?: Pan options): this
// @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;
@ -314,7 +314,7 @@ L.Map = L.Evented.extend({
return this;
},
// 🍂method invalidateSize(options: Zoom/Pan options): 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.
@ -322,8 +322,8 @@ L.Map = L.Evented.extend({
// that it doesn't happen often even if the method is called many
// times in a row.
// 🍂alternative
// 🍂method invalidateSize(animate: Boolean): this
// @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.
@ -364,8 +364,8 @@ L.Map = L.Evented.extend({
}
}
// 🍂section Map state change events
// 🍂event resize: Event
// @section Map state change events
// @event resize: Event
// Fired when the map is resized.
return this.fire('resize', {
oldSize: oldSize,
@ -373,8 +373,8 @@ L.Map = L.Evented.extend({
});
},
// 🍂section Methods for modifying map state
// 🍂method stop(): this
// @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));
@ -384,8 +384,8 @@ L.Map = L.Evented.extend({
// TODO handler.addTo
// TODO Appropiate docs section?
// 🍂section Other Methods
// 🍂method addHandler(name: String, HandlerClass: Function): this
// @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; }
@ -401,7 +401,7 @@ L.Map = L.Evented.extend({
return this;
},
// 🍂method remove(): this
// @method remove(): this
// Destroys the map and clears all related event listeners.
remove: function () {
@ -423,8 +423,8 @@ L.Map = L.Evented.extend({
this._clearHandlers();
if (this._loaded) {
// 🍂section Map state change events
// 🍂event unload: Event
// @section Map state change events
// @event unload: Event
// Fired when the map is destroyed with [remove](#map-remove) method.
this.fire('unload');
}
@ -436,8 +436,8 @@ L.Map = L.Evented.extend({
return this;
},
// 🍂section Other Methods
// 🍂method createPane(name, container?): HTMLElement
// @section Other Methods
// @method createPane(name, container?): HTMLElement
// Creates a new 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.
@ -451,9 +451,9 @@ L.Map = L.Evented.extend({
return pane;
},
// 🍂section Methods for Getting Map State
// @section Methods for Getting Map State
// 🍂method getCenter(): LatLng
// @method getCenter(): LatLng
// Returns the geographical center of the map view
getCenter: function () {
this._checkIfLoaded();
@ -464,13 +464,13 @@ L.Map = L.Evented.extend({
return this.layerPointToLatLng(this._getCenterLayerPoint());
},
// 🍂method getZoom(): Number
// @method getZoom(): Number
// Returns the current zoom level of the map view
getZoom: function () {
return this._zoom;
},
// 🍂method getBounds(): LatLngBounds
// @method getBounds(): LatLngBounds
// Returns the geographical bounds visible in the current map view
getBounds: function () {
var bounds = this.getPixelBounds(),
@ -480,13 +480,13 @@ L.Map = L.Evented.extend({
return new L.LatLngBounds(sw, ne);
},
// 🍂method getMinZoom(): Number
// @method getMinZoom(): Number
// Returns the minimum zoom level of the map (if set in the `minZoom` option of the map or of any layers), or `0` by default.
getMinZoom: function () {
return this.options.minZoom === undefined ? this._layersMinZoom || 0 : this.options.minZoom;
},
// 🍂method getMinZoom(): Number
// @method getMinZoom(): Number
// Returns the minimum zoom level of the map (if set in the `minZoom` option of the map or of any layers).
getMaxZoom: function () {
return this.options.maxZoom === undefined ?
@ -494,7 +494,7 @@ L.Map = L.Evented.extend({
this.options.maxZoom;
},
// 🍂method getBoundsZoom(bounds: LatLngBounds, inside?: Boolean): Number
// @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
@ -522,7 +522,7 @@ L.Map = L.Evented.extend({
return Math.max(min, Math.min(max, zoom));
},
// 🍂method getSize(): Point
// @method getSize(): Point
// Returns the current size of the map container (in pixels).
getSize: function () {
if (!this._size || this._sizeChanged) {
@ -535,7 +535,7 @@ L.Map = L.Evented.extend({
return this._size.clone();
},
// 🍂method getPixelBounds(): Bounds
// @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) {
@ -546,7 +546,7 @@ L.Map = L.Evented.extend({
// 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
// @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 () {
@ -554,38 +554,38 @@ L.Map = L.Evented.extend({
return this._pixelOrigin;
},
// 🍂method getPixelWorldBounds(zoom?): Bounds
// @method getPixelWorldBounds(zoom?): 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);
},
// 🍂section Other Methods
// @section Other Methods
// 🍂method getPane(pane: String|HTMLElement): HTMLElement
// @method getPane(pane: String|HTMLElement): HTMLElement
// Returns a 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
// @method getPanes(): Object
// Returns a plain object containing the names of all panes as keys and
// the panes as values.
getPanes: function () {
return this._panes;
},
// 🍂method getContainer: HTMLElement
// @method getContainer: HTMLElement
// Returns the HTML element that contains the map.
getContainer: function () {
return this._container;
},
// 🍂section Conversion Methods
// @section Conversion Methods
// 🍂method getZoomScale(toZoom: Number, fromZoom: Number): Number
// @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) {
@ -595,7 +595,7 @@ L.Map = L.Evented.extend({
return crs.scale(toZoom) / crs.scale(fromZoom);
},
// 🍂method getScaleZoom(scale: Number, fromZoom: Number): Number
// @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).
@ -605,7 +605,7 @@ L.Map = L.Evented.extend({
return crs.zoom(scale * crs.scale(fromZoom));
},
// 🍂method project(latlng: LatLng, zoom: 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
@ -615,14 +615,14 @@ L.Map = L.Evented.extend({
return this.options.crs.latLngToPoint(L.latLng(latlng), zoom);
},
// 🍂method unproject(point: Point, zoom: 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);
},
// 🍂method layerPointToLatLng(point: Point): LatLng
// @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) {
@ -630,7 +630,7 @@ L.Map = L.Evented.extend({
return this.unproject(projectedPoint);
},
// 🍂method latLngToLayerPoint(latlng: LatLng): Point
// @method latLngToLayerPoint(latlng: LatLng): Point
// Given a geographical coordinate, returns the corresponding pixel coordinate
// relative to the [origin pixel](#map-getpixelorigin).
latLngToLayerPoint: function (latlng) {
@ -638,7 +638,7 @@ L.Map = L.Evented.extend({
return projectedPoint._subtract(this.getPixelOrigin());
},
// 🍂method wrapLatLng(latlng: LatLng): LatLng
// @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.
@ -648,28 +648,28 @@ L.Map = L.Evented.extend({
return this.options.crs.wrapLatLng(L.latLng(latlng));
},
// 🍂method distance(latlng1: LatLng, latlng2: LatLng): Number
// @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
// @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
// @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
// @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) {
@ -677,28 +677,28 @@ L.Map = L.Evented.extend({
return this.layerPointToLatLng(layerPoint);
},
// 🍂method latLngToContainerPoint(latlng: LatLng): Point
// @method latLngToContainerPoint(latlng: LatLng): Point
// Given a geographical coordinate, returns the corresponding pixel coordinate
// relative to the map container.
latLngToContainerPoint: function (latlng) {
return this.layerPointToContainerPoint(this.latLngToLayerPoint(L.latLng(latlng)));
},
// 🍂method mouseEventToContainerPoint(ev: MouseEvent): Point
// @method mouseEventToContainerPoint(ev: MouseEvent): Point
// Given a MouseEvent object, returns the pixel coordinate relative to the
// map container where the event took place.
mouseEventToContainerPoint: function (e) {
return L.DomEvent.getMousePosition(e, this._container);
},
// 🍂method mouseEventToLayerPoint(ev: MouseEvent): Point
// @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
// @method mouseEventToLatLng(ev: MouseEvent): LatLng
// Given a MouseEvent object, returns geographical coordinate where the
// event took place.
mouseEventToLatLng: function (e) { // (MouseEvent)
@ -750,7 +750,7 @@ L.Map = L.Evented.extend({
var panes = this._panes = {};
this._paneRenderers = {};
// 🍂section
// @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
@ -759,25 +759,25 @@ L.Map = L.Evented.extend({
//
// Every map has the following default panes that differ only in zIndex.
//
// 🍂pane mapPane: HTMLElement = 'auto'
// @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 = 2
// @pane tilePane: HTMLElement = 2
// Pane for tile layers
this.createPane('tilePane');
// 🍂pane overlayPane: HTMLElement = 4
// @pane overlayPane: HTMLElement = 4
// Pane for overlays like polylines and polygons
this.createPane('shadowPane');
// 🍂pane shadowPane: HTMLElement = 5
// @pane shadowPane: HTMLElement = 5
// Pane for overlay shadows (e.g. marker shadows)
this.createPane('overlayPane');
// 🍂pane markerPane: HTMLElement = 6
// @pane markerPane: HTMLElement = 6
// Pane for marker icons
this.createPane('markerPane');
// 🍂pane popupPane: HTMLElement = 7
// @pane popupPane: HTMLElement = 7
// Pane for popups.
this.createPane('popupPane');
@ -790,7 +790,7 @@ L.Map = L.Evented.extend({
// private methods that modify map state
// 🍂section Map state change events
// @section Map state change events
_resetView: function (center, zoom) {
L.DomUtil.setPosition(this._mapPane, new L.Point(0, 0));
@ -806,12 +806,12 @@ L.Map = L.Evented.extend({
._move(center, zoom)
._moveEnd(zoomChanged);
// 🍂event viewreset: Event
// @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
// @event load: Event
// Fired when the map is initialized (when its center and zoom are set
// for the first time).
if (loading) {
@ -820,9 +820,9 @@ L.Map = L.Evented.extend({
},
_moveStart: function (zoomChanged) {
// 🍂event zoomstart: Event
// @event zoomstart: Event
// Fired when the map zoom is about to change (e.g. before zoom animation).
// 🍂event movestart: Event
// @event movestart: Event
// Fired when the view of the map starts changing (e.g. user starts dragging the map).
if (zoomChanged) {
this.fire('zoomstart');
@ -840,27 +840,27 @@ L.Map = L.Evented.extend({
this._lastCenter = center;
this._pixelOrigin = this._getNewPixelOrigin(center);
// 🍂event zoom: Event
// @event zoom: Event
// Fired repeteadly during any change in zoom level, including zoom
// and fly animations.
if (zoomChanged || (data && data.pinch)) { // Always fire 'zoom' if pinching because #3530
this.fire('zoom', data);
}
// 🍂event move: Event
// @event move: Event
// Fired repeteadly during any movement of the map, including pan and
// fly animations.
return this.fire('move', data);
},
_moveEnd: function (zoomChanged) {
// 🍂event zoomend: Event
// @event zoomend: Event
// Fired when the map has changed, after any animations.
if (zoomChanged) {
this.fire('zoomend');
}
// 🍂event moveend: Event
// @event moveend: Event
// Fired when the center of the map stops changing (e.g. user stopped
// dragging the map).
return this.fire('moveend');
@ -896,7 +896,7 @@ L.Map = L.Evented.extend({
// DOM event handling
// 🍂section Interaction events
// @section Interaction events
_initEvents: function (remove) {
if (!L.DomEvent) { return; }
@ -905,26 +905,26 @@ L.Map = L.Evented.extend({
var onOff = remove ? 'off' : 'on';
// 🍂event click: MouseEvent
// @event click: MouseEvent
// Fired when the user clicks (or taps) the map.
// 🍂event dblclick: MouseEvent
// @event dblclick: MouseEvent
// Fired when the user double-clicks (or double-taps) the map.
// 🍂event mousedown: MouseEvent
// @event mousedown: MouseEvent
// Fired when the user pushes the mouse button on the map.
// 🍂event mouseup: MouseEvent
// @event mouseup: MouseEvent
// Fired when the user releases the mouse button on the map.
// 🍂event mouseover: MouseEvent
// @event mouseover: MouseEvent
// Fired when the mouse enters the map.
// 🍂event mouseout: MouseEvent
// @event mouseout: MouseEvent
// Fired when the mouse leaves the map.
// 🍂event mousemove: MouseEvent
// @event mousemove: MouseEvent
// Fired while the mouse moves over the map.
// 🍂event contextmenu: MouseEvent
// @event contextmenu: MouseEvent
// Fired when the user pushes the right mouse button on the map, prevents
// default browser context menu from showing if there are listeners on
// this event. Also fired on mobile when the user holds a single touch
// for a second (also called long press).
// 🍂event keypress: Event
// @event keypress: Event
// Fired when the user presses a key from the keyboard while the map is focused.
L.DomEvent[onOff](this._container, 'click dblclick mousedown mouseup ' +
'mouseover mouseout mousemove contextmenu keypress', this._handleDOMEvent, this);
@ -993,7 +993,7 @@ L.Map = L.Evented.extend({
if (e.type === 'click') {
// Fire a synthetic 'preclick' event which propagates up (mainly for closing popups).
// 🍂event preclick: MouseEvent
// @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).
@ -1054,9 +1054,9 @@ L.Map = L.Evented.extend({
}
},
// 🍂section Other Methods
// @section Other Methods
// 🍂method whenReady(fn: Function, context?: Object): this
// @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.
@ -1170,19 +1170,16 @@ L.Map = L.Evented.extend({
}
});
// 🍂section
// @section
// 🍂factory L.map(id: String, options?: Map options)
// @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)
// @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);
};

62
src/map/Map.methodOptions.leafdoc
View File

@ -2,49 +2,49 @@
This file documents the common options passed to several map methods.
🍂miniclass Locate options (Map)
🍂aka locate options
🍂section
@miniclass Locate options (Map)
@aka locate options
@section
Some of the geolocation methods for `Map` take in an `options` parameter. This
is a plain javascript object with the following optional components:
🍂option watch: Boolean = false
@option watch: Boolean = false
If `true`, starts continous watching of location changes (instead of detecting it
once) using W3C `watchPosition` method. You can later stop watching using
`map.stopLocate()` method.
🍂option setView: Boolean = false
@option setView: Boolean = false
If `true`, automatically sets the map view to the user location with respect to
detection accuracy, or to world view if geolocation failed.
🍂option maxZoom: Number = Infinity
@option maxZoom: Number = Infinity
The maximum zoom for automatic view setting when using `setView` option.
🍂option timeout: Number = 10000
@option timeout: Number = 10000
Number of milliseconds to wait for a response from geolocation before firing a
`locationerror` event.
🍂option maximumAge: Number = 0
@option maximumAge: Number = 0
Maximum age of detected location. If less than this amount of milliseconds
passed since last geolocation response, `locate` will return a cached location.
🍂option enableHighAccuracy: Boolean = false
@option enableHighAccuracy: Boolean = false
Enables high accuracy, see [description in the W3C spec](http://dev.w3.org/geo/api/spec-source.html#high-accuracy).
🍂miniclass Zoom options (Map)
🍂aka zoom options
🍂section
@miniclass Zoom options (Map)
@aka zoom options
@section
Some of the `Map` methods which modify the zoom level take in an `options`
parameter. This is a plain javascript object with the following optional
components:
🍂option animate: Boolean
@option animate: Boolean
If not specified, zoom animation will happen if the zoom origin is inside the
current view. If `true`, the map will attempt animating zoom disregarding where
zoom origin is. Setting `false` will make it always reset the view completely
@ -53,56 +53,56 @@ without animation.
🍂miniclass Pan options (Map)
🍂aka pan options
🍂section
@miniclass Pan options (Map)
@aka pan options
@section
Some of the `Map` methods which modify the center of the map take in an `options`
parameter. This is a plain javascript object with the following optional
components:
🍂option animate: Boolean
@option animate: Boolean
If `true`, panning will always be animated if possible. If `false`, it will
not animate panning, either resetting the map view if panning more than a
screen away, or just setting a new offset for the map pane (except for `panBy`
which always does the latter).
🍂option duration: Number = 0.25
@option duration: Number = 0.25
Duration of animated panning, in seconds.
🍂option easeLinearity: Number = 0.25
@option easeLinearity: Number = 0.25
The curvature factor of panning animation easing (third parameter of the
[Cubic Bezier curve](http://cubic-bezier.com/)). 1.0 means linear animation,
the less the more bowed the curve.
🍂option noMoveStart: Boolean = false
@option noMoveStart: Boolean = false
If `true`, panning won't fire `movestart` event on start (used internally for
panning inertia).
🍂miniclass Zoom/pan options (Map)
🍂aka zoom/pan options
🍂inherits Zoom options
🍂inherits Pan options
@miniclass Zoom/pan options (Map)
@aka zoom/pan options
@inherits Zoom options
@inherits Pan options
🍂miniclass FitBounds options (Map)
🍂aka fitBounds options
🍂inherits Zoom/pan options
@miniclass FitBounds options (Map)
@aka fitBounds options
@inherits Zoom/pan options
🍂option paddingTopLeft: Point = [0, 0]
@option paddingTopLeft: Point = [0, 0]
Sets the amount of padding in the top left corner of a map container that
shouldn't be accounted for when setting the view to fit bounds. Useful if you
have some control overlays on the map like a sidebar and you don't want them
to obscure objects you're zooming to.
🍂option paddingBottomRight: Point = [0, 0]
@option paddingBottomRight: Point = [0, 0]
The same for the bottom right corner of the map.
🍂option padding: Point = [0, 0]
@option padding: Point = [0, 0]
Equivalent of setting both top left and bottom right padding to the same value.
🍂option maxZoom: Number = null
@option maxZoom: Number = null
The maximum possible zoom to use.

8
src/map/anim/Map.FlyTo.js
View File

@ -1,8 +1,8 @@
// 🍂namespace Map
// 🍂section Methods for modifying map state
// @namespace Map
// @section Methods for modifying map state
L.Map.include({
// 🍂method flyTo(latlng: LatLng, zoom?: Number, options? Zoom/Pan options): this
// @method flyTo(latlng: LatLng, zoom?: Number, options? Zoom/Pan options): this
// Sets the view of the map (geographical center and zoom) performing a smooth
// pan-zoom animation.
flyTo: function (targetCenter, targetZoom, options) {
@ -73,7 +73,7 @@ L.Map.include({
return this;
},
// 🍂method flyToBounds(bounds: LatLngBounds, options?: fitBounds options): this
// @method flyToBounds(bounds: LatLngBounds, options?: fitBounds options): this
// Sets the view of the map with a smooth animation like [`flyTo`](#map-flyto),
// but takes a bounds parameter like [`fitBounds`](#map-fitbounds).
flyToBounds: function (bounds, options) {

8
src/map/anim/Map.ZoomAnimation.js
View File

@ -2,15 +2,15 @@
* Extends L.Map to handle zoom animations.
*/
// 🍂namespace Map
// 🍂section Animation Options
// @namespace Map
// @section Animation Options
L.Map.mergeOptions({
// 🍂option zoomAnimation: Boolean = true
// @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
// @option zoomAnimationThreshold: Number = 4
// Won't animate zoom if the zoom difference exceeds this value.
zoomAnimationThreshold: 4
});

14
src/map/ext/Map.Geolocation.js
View File

@ -2,10 +2,10 @@
* Provides L.Map with convenient shortcuts for using browser geolocation features.
*/
// 🍂namespace Map
// @namespace Map
L.Map.include({
// 🍂section Geolocation methods
// @section Geolocation methods
_defaultLocateOptions: {
timeout: 10000,
watch: false
@ -15,7 +15,7 @@ L.Map.include({
// enableHighAccuracy: false
},
// 🍂method locate(options?: Locate options): this
// @method locate(options?: Locate options): this
// Tries to locate the user using the Geolocation API, firing a `locationfound`
// event with location data on success or a `locationerror` event on failure,
// and optionally sets the map view to the user's location with respect to
@ -45,7 +45,7 @@ L.Map.include({
return this;
},
// 🍂method stopLocate(): 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}`.
@ -69,8 +69,8 @@ L.Map.include({
this.fitWorld();
}
// 🍂section Location events
// 🍂event locationerror: ErrorEvent
// @section Location events
// @event locationerror: ErrorEvent
// Fired when geolocation (using the [`locate`](#map-locate) method) failed.
this.fire('locationerror', {
code: c,
@ -102,7 +102,7 @@ L.Map.include({
}
}
// 🍂event locationfound: LocationEvent
// @event locationfound: LocationEvent
// Fired when geolocation (using the [`locate`](#map-locate) method)
// went successfully.
this.fire('locationfound', data);

10
src/map/handler/Map.BoxZoom.js
View File

@ -3,10 +3,10 @@
* (zoom to a selected bounding box), enabled by default.
*/
// 🍂namespace Map
// 🍂section Interaction Options
// @namespace Map
// @section Interaction Options
L.Map.mergeOptions({
// 🍂option boxZoom: Boolean = true
// @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
@ -117,7 +117,7 @@ L.Map.BoxZoom = L.Handler.extend({
}
});
// 🍂section Handlers
// 🍂property boxZoom: Handler
// @section Handlers
// @property boxZoom: Handler
// Box (shift-drag with mouse) zoom handler.
L.Map.addInitHook('addHandler', 'boxZoom', L.Map.BoxZoom);

10
src/map/handler/Map.DoubleClickZoom.js
View File

@ -2,11 +2,11 @@
* L.Handler.DoubleClickZoom is used to handle double-click zoom on the map, enabled by default.
*/
// 🍂namespace Map
// 🍂section Interaction Options
// @namespace Map
// @section Interaction Options
L.Map.mergeOptions({
// 🍂option doubleClickZoom: Boolean = true
// @option doubleClickZoom: Boolean = 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
@ -37,7 +37,7 @@ L.Map.DoubleClickZoom = L.Handler.extend({
}
});
// 🍂section Handlers
// @section Handlers
//
// Map properties include interaction handlers that allow you to control
// interaction behavior in runtime, enabling or disabling certain features such
@ -47,6 +47,6 @@ L.Map.DoubleClickZoom = L.Handler.extend({
// map.doubleClickZoom.disable();
// ```
//
// 🍂property doubleClickZoom: Handler
// @property doubleClickZoom: Handler
// Double click zoom handler.
L.Map.addInitHook('addHandler', 'doubleClickZoom', L.Map.DoubleClickZoom);

26
src/map/handler/Map.Drag.js
View File

@ -2,41 +2,41 @@
* L.Handler.MapDrag is used to make the map draggable (with panning inertia), enabled by default.
*/
// 🍂namespace Map
// 🍂section Interaction Options
// @namespace Map
// @section Interaction Options
L.Map.mergeOptions({
// 🍂option dragging: Boolean = true
// @option dragging: Boolean = true
// Whether the map be draggable with mouse/touch or not.
dragging: true,
// 🍂section Panning Inertia Options
// 🍂option inertia: Boolean = *
// @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
// @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
// @option inertiaMaxSpeed: Number = Infinity
// Max speed of the inertial movement, in pixels/second.
inertiaMaxSpeed: Infinity, // px/s
// 🍂option easeLinearity: Number = 0.2
// @option easeLinearity: Number = 0.2
easeLinearity: 0.2,
// TODO refactor, move to CRS
// 🍂option worldCopyJump: Boolean = 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,
// 🍂section Interaction Options
// 🍂option maxBoundsViscosity: Number = 0.0
// @section Interaction Options
// @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
@ -220,7 +220,7 @@ L.Map.Drag = L.Handler.extend({
}
});
// 🍂section Handlers
// 🍂property dragging: Handler
// @section Handlers
// @property dragging: Handler
// Map dragging handler (by both mouse and touch).
L.Map.addInitHook('addHandler', 'dragging', L.Map.Drag);

14
src/map/handler/Map.Keyboard.js
View File

@ -2,15 +2,15 @@
* L.Map.Keyboard is handling keyboard interaction with the map, enabled by default.
*/
// 🍂namespace Map
// 🍂section Keyboard Navigation Options
// @namespace Map
// @section Keyboard Navigation Options
L.Map.mergeOptions({
// 🍂option keyboard: Boolean = true
// @option keyboard: Boolean = true
// Makes the map focusable and allows users to navigate the map with keyboard
// arrows and `+`/`-` keys.
keyboard: true,
// 🍂option keyboardPanDelta: Number = 80
// @option keyboardPanDelta: Number = 80
// Amount of pixels to pan when pressing an arrow key.
keyboardPanDelta: 80
});
@ -167,8 +167,8 @@ L.Map.Keyboard = L.Handler.extend({
}
});
// 🍂section Handlers
// 🍂section Handlers
// 🍂property keyboard: Handler
// @section Handlers
// @section Handlers
// @property keyboard: Handler
// Keyboard navigation handler.
L.Map.addInitHook('addHandler', 'keyboard', L.Map.Keyboard);

16
src/map/handler/Map.ScrollWheelZoom.js
View File

@ -2,21 +2,21 @@
* L.Handler.ScrollWheelZoom is used by L.Map to enable mouse scroll wheel zoom on the map.
*/
// 🍂namespace Map
// 🍂section Interaction Options
// @namespace Map
// @section Interaction Options
L.Map.mergeOptions({
// 🍂section Mousewheel options
// 🍂option scrollWheelZoom: Boolean = true
// @section Mousewheel options
// @option scrollWheelZoom: Boolean = 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
// @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 = 50
// @option wheelPxPerZoomLevel: Number = 50
// 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).
@ -80,7 +80,7 @@ L.Map.ScrollWheelZoom = L.Handler.extend({
}
});
// 🍂section Handlers
// 🍂property scrollWheelZoom: Handler
// @section Handlers
// @property scrollWheelZoom: Handler
// Scroll wheel zoom handler.
L.Map.addInitHook('addHandler', 'scrollWheelZoom', L.Map.ScrollWheelZoom);

14
src/map/handler/Map.Tap.js
View File

@ -2,16 +2,16 @@
* L.Map.Tap is used to enable mobile hacks like quick taps and long hold.
*/
// 🍂namespace Map
// 🍂section Interaction Options
// @namespace Map
// @section Interaction Options
L.Map.mergeOptions({
// 🍂section Touch interaction options
// 🍂option tap: Boolean = true
// @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
// @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
@ -119,8 +119,8 @@ L.Map.Tap = L.Handler.extend({
}
});
// 🍂section Handlers
// 🍂property tap: Handler
// @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);

14
src/map/handler/Map.TouchZoom.js
View File

@ -2,18 +2,18 @@
* L.Handler.TouchZoom is used by L.Map to add pinch zoom on supported mobile browsers.
*/
// 🍂namespace Map
// 🍂section Interaction Options
// @namespace Map
// @section Interaction Options
L.Map.mergeOptions({
// 🍂section Touch interaction options
// 🍂option touchZoom: Boolean = *
// @section Touch interaction options
// @option touchZoom: Boolean = *
// 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
// @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
@ -118,7 +118,7 @@ L.Map.TouchZoom = L.Handler.extend({
}
});
// 🍂section Handlers
// 🍂property touchZoom: Handler
// @section Handlers
// @property touchZoom: Handler
// Touch zoom handler.
L.Map.addInitHook('addHandler', 'touchZoom', L.Map.TouchZoom);