Leaflet API reference
Map
The central class of the API — it is used to create a map on a page and manipulate it.
Usage example
// initialize the map on the "map" div with a given center and zoom var map = L.map('map', { center: [51.505, -0.09], zoom: 13 });
Creation
Factory | Description |
---|---|
L.map( | Instantiates a map object given the DOM ID of a <div> element and optionally an object literal with Map options . |
L.map( | Instantiates a map object given an instance of a <div> HTML element and optionally an object literal with Map options . |
Options
Option | Type | Default | Description |
---|---|---|---|
preferCanvas | Boolean | false | Whether Path s should be rendered on a Canvas renderer. By default, all Path s are rendered in a SVG renderer. |
Control options
Option | Type | Default | Description |
---|---|---|---|
attributionControl | Boolean | true | Whether a attribution control is added to the map by default. |
zoomControl | Boolean | true | Whether a zoom control is added to the map by default. |
Interaction Options
Option | Type | Default | Description |
---|---|---|---|
closePopupOnClick | Boolean | true | Set it to false if you don't want popups to close when user clicks the map. |
zoomSnap | Number | 1 | Forces the map's zoom level to always be a multiple of this, particularly right after a fitBounds() or a pinch-zoom. By default, the zoom level snaps to the nearest integer; lower values (e.g. 0.5 or 0.1 ) allow for greater granularity. A value of 0 means the zoom level will not be snapped after fitBounds or a pinch-zoom. |
zoomDelta | Number | 1 | Controls how much the map's zoom level will change after a zoomIn() , zoomOut() , pressing + or - on the keyboard, or using the zoom controls. Values smaller than 1 (e.g. 0.5 ) allow for greater granularity. |
trackResize | Boolean | true | Whether the map automatically handles browser window resize to update itself. |
boxZoom | Boolean | true | Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing the shift key. |
doubleClickZoom | Boolean|String | true | Whether the map can be zoomed in by double clicking on it and zoomed out by double clicking while holding shift. If passed 'center' , double-click zoom will zoom to the center of the view regardless of where the mouse was. |
dragging | Boolean | true | Whether the map be draggable with mouse/touch or not. |
Map State Options
Option | Type | Default | Description |
---|---|---|---|
crs | CRS | L.CRS.EPSG3857 | The Coordinate Reference System to use. Don't change this if you're not sure what it means. |
center | LatLng | undefined | Initial geographic center of the map |
zoom | Number | undefined | Initial map zoom level |
minZoom | Number | * | Minimum zoom level of the map. If not specified and at least one GridLayer or TileLayer is in the map, the lowest of their minZoom options will be used instead. |
maxZoom | Number | * | Maximum zoom level of the map. If not specified and at least one GridLayer or TileLayer is in the map, the highest of their maxZoom options will be used instead. |
layers | Layer[] | [] | Array of layers that will be added to the map initially |
maxBounds | LatLngBounds | null | When this option is set, the map restricts the view to the given geographical bounds, bouncing the user back if the user tries to pan outside the view. To set the restriction dynamically, use setMaxBounds method. |
renderer | Renderer | * | The default method for drawing vector layers on the map. L.SVG or L.Canvas by default depending on browser support. |
Animation Options
Option | Type | Default | Description |
---|---|---|---|
zoomAnimation | Boolean | true | Whether the map zoom animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android. |
zoomAnimationThreshold | Number | 4 | Won't animate zoom if the zoom difference exceeds this value. |
fadeAnimation | Boolean | true | Whether the tile fade animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android. |
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. |
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 . |
Panning Inertia Options
Option | Type | Default | Description |
---|---|---|---|
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. |
inertiaDeceleration | Number | 3000 | The rate with which the inertial movement slows down, in pixels/second². |
inertiaMaxSpeed | Number | Infinity | Max speed of the inertial movement, in pixels/second. |
easeLinearity | Number | 0.2 | |
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. |
maxBoundsViscosity | Number | 0.0 | If maxBounds is set, this option will control how solid the bounds are when dragging the map around. The default value of 0.0 allows the user to drag outside the bounds at normal speed, higher values will slow down map dragging outside bounds, and 1.0 makes the bounds fully solid, preventing the user from dragging outside the bounds. |
Keyboard Navigation Options
Option | Type | Default | Description |
---|---|---|---|
keyboard | Boolean | true | Makes the map focusable and allows users to navigate the map with keyboard arrows and + /- keys. |
keyboardPanDelta | Number | 80 | Amount of pixels to pan when pressing an arrow key. |
Mouse wheel options
Option | Type | Default | Description |
---|---|---|---|
scrollWheelZoom | Boolean|String | true | Whether the map can be zoomed by using the mouse wheel. If passed 'center' , it will zoom to the center of the view regardless of where the mouse was. |
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. |
wheelPxPerZoomLevel | Number | 60 | How many scroll pixels (as reported by L.DomEvent.getWheelDelta) mean a change of one full zoom level. Smaller values will make wheel-zooming faster (and vice versa). |
Touch interaction options
Option | Type | Default | Description |
---|---|---|---|
tap | Boolean | true | Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as contextmenu events). |
tapTolerance | Number | 15 | The max number of pixels a user can shift his finger during touch for it to be considered a valid tap. |
touchZoom | Boolean|String | * | Whether the map can be zoomed by touch-dragging with two fingers. If passed 'center' , it will zoom to the center of the view regardless of where the touch events (fingers) were. Enabled for touch-capable web browsers except for old Androids. |
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. |
Events
Layer events
Event | Data | Description |
---|---|---|
baselayerchange | LayersControlEvent | Fired when the base layer is changed through the layers control. |
overlayadd | LayersControlEvent | Fired when an overlay is selected through the layers control. |
overlayremove | LayersControlEvent | Fired when an overlay is deselected through the layers control. |
layeradd | LayerEvent | Fired when a new layer is added to the map. |
layerremove | LayerEvent | Fired when some layer is removed from the map |
Map state change events
Event | Data | Description |
---|---|---|
zoomlevelschange | Event | Fired when the number of zoomlevels on the map is changed due to adding or removing a layer. |
resize | ResizeEvent | Fired when the map is resized. |
unload | Event | Fired when the map is destroyed with remove method. |
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. |
load | Event | Fired when the map is initialized (when its center and zoom are set for the first time). |
zoomstart | Event | Fired when the map zoom is about to change (e.g. before zoom animation). |
movestart | Event | Fired when the view of the map starts changing (e.g. user starts dragging the map). |
zoom | Event | Fired repeatedly during any change in zoom level, including zoom and fly animations. |
move | Event | Fired repeatedly during any movement of the map, including pan and fly animations. |
zoomend | Event | Fired when the map has changed, after any animations. |
moveend | Event | Fired when the center of the map stops changing (e.g. user stopped dragging the map). |
Popup events
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup is opened in the map |
popupclose | PopupEvent | Fired when a popup in the map is closed |
autopanstart | Event | Fired when the map starts autopanning when opening a popup. |
Tooltip events
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip is opened in the map. |
tooltipclose | TooltipEvent | Fired when a tooltip in the map is closed. |
Location events
Event | Data | Description |
---|---|---|
locationerror | ErrorEvent | Fired when geolocation (using the locate method) failed. |
locationfound | LocationEvent | Fired when geolocation (using the locate method) went successfully. |
Interaction events
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the map. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the map. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the map. |
mouseup | MouseEvent | Fired when the user releases the mouse button on the map. |
mouseover | MouseEvent | Fired when the mouse enters the map. |
mouseout | MouseEvent | Fired when the mouse leaves the map. |
mousemove | MouseEvent | Fired while the mouse moves over the map. |
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). |
keypress | KeyboardEvent | Fired when the user presses a key from the keyboard that produces a character value while the map is focused. |
keydown | KeyboardEvent | Fired when the user presses a key from the keyboard while the map is focused. Unlike the keypress event, the keydown event is fired for keys that produce a character value and for keys that do not produce a character value. |
keyup | KeyboardEvent | Fired when the user releases a key from the keyboard while the map is focused. |
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). |
Other Events
Event | Data | Description |
---|---|---|
zoomanim | ZoomAnimEvent | Fired at least once per zoom animation. For continuous zoom, like pinch zooming, fired once per frame during zoom. |
Methods
Method | Returns | Description |
---|---|---|
getRenderer( | Renderer |
Returns the instance of |
Methods for Layers and Controls
Method | Returns | Description |
---|---|---|
addControl( | this |
Adds the given control to the map |
removeControl( | this |
Removes the given control from the map |
addLayer( | this |
Adds the given layer to the map |
removeLayer( | this |
Removes the given layer from the map. |
hasLayer( | Boolean |
Returns |
eachLayer( | this |
Iterates over the layers of the map, optionally specifying context of the iterator function. map.eachLayer(function(layer){ layer.bindPopup('Hello'); }); |
openPopup( | this |
Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability). |
openPopup( | this |
Creates a popup with the specified content and options and opens it in the given point on a map. |
closePopup( | this |
Closes the popup previously opened with openPopup (or the given one). |
openTooltip( | this |
Opens the specified tooltip. |
openTooltip( | this |
Creates a tooltip with the specified content and options and open it. |
closeTooltip( | this |
Closes the tooltip given as parameter. |
Methods for modifying map state
Method | Returns | Description |
---|---|---|
setView( | this |
Sets the view of the map (geographical center and zoom) with the given animation options. |
setZoom( | this |
Sets the zoom of the map. |
zoomIn( | this |
Increases the zoom of the map by |
zoomOut( | this |
Decreases the zoom of the map by |
setZoomAround( | 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). |
setZoomAround( | this |
Zooms the map while keeping a specified pixel on the map (relative to the top-left corner) stationary. |
fitBounds( | this |
Sets a map view that contains the given geographical bounds with the maximum zoom level possible. |
fitWorld( | this |
Sets a map view that mostly contains the whole world with the maximum zoom level possible. |
panTo( | this |
Pans the map to a given center. |
panBy( | this |
Pans the map by a given number of pixels (animated). |
flyTo( | this |
Sets the view of the map (geographical center and zoom) performing a smooth pan-zoom animation. |
flyToBounds( | this |
Sets the view of the map with a smooth animation like |
setMaxBounds( | this |
Restricts the map view to the given bounds (see the maxBounds option). |
setMinZoom( | this |
Sets the lower limit for the available zoom levels (see the minZoom option). |
setMaxZoom( | this |
Sets the upper limit for the available zoom levels (see the maxZoom option). |
panInsideBounds( | 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. |
panInside( | this |
Pans the map the minimum amount to make the |
invalidateSize( | 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 |
invalidateSize( | 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. |
stop() | this |
Stops the currently running |
Geolocation methods
Method | Returns | Description |
---|---|---|
locate( | this |
Tries to locate the user using the Geolocation API, firing a |
stopLocate() | this |
Stops watching location previously initiated by |
Other Methods
Method | Returns | Description |
---|---|---|
addHandler( | this |
Adds a new |
remove() | this |
Destroys the map and clears all related event listeners. |
createPane( | 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 child of |
getPane( | HTMLElement |
Returns a map pane, given its name or its HTML element (its identity). |
getPanes() | Object |
Returns a plain object containing the names of all panes as keys and the panes as values. |
getContainer() | HTMLElement |
Returns the HTML element that contains the map. |
whenReady( | this |
Runs the given function |
Methods for Getting Map State
Method | Returns | Description |
---|---|---|
getCenter() | LatLng |
Returns the geographical center of the map view |
getZoom() | Number |
Returns the current zoom level of the map view |
getBounds() | LatLngBounds |
Returns the geographical bounds visible in the current map view |
getMinZoom() | Number |
Returns the minimum zoom level of the map (if set in the |
getMaxZoom() | Number |
Returns the maximum zoom level of the map (if set in the |
getBoundsZoom( | Number |
Returns the maximum zoom level on which the given bounds fit to the map view in its entirety. If |
getSize() | Point |
Returns the current size of the map container (in pixels). |
getPixelBounds() | Bounds |
Returns the bounds of the current map view in projected pixel coordinates (sometimes useful in layer and overlay implementations). |
getPixelOrigin() | Point |
Returns the projected pixel coordinates of the top left point of the map layer (useful in custom layer and overlay implementations). |
getPixelWorldBounds( | Bounds |
Returns the world's bounds in pixel coordinates for zoom level |
Conversion Methods
Method | Returns | Description |
---|---|---|
getZoomScale( | Number |
Returns the scale factor to be applied to a map transition from zoom level |
getScaleZoom( | Number |
Returns the zoom level that the map would end up at, if it is at |
project( | Point |
Projects a geographical coordinate |
unproject( | LatLng |
Inverse of |
layerPointToLatLng( | LatLng |
Given a pixel coordinate relative to the origin pixel, returns the corresponding geographical coordinate (for the current zoom level). |
latLngToLayerPoint( | Point |
Given a geographical coordinate, returns the corresponding pixel coordinate relative to the origin pixel. |
wrapLatLng( | LatLng |
Returns a |
wrapLatLngBounds( | LatLngBounds |
Returns a |
distance( | Number |
Returns the distance between two geographical coordinates according to the map's CRS. By default this measures distance in meters. |
containerPointToLayerPoint( | Point |
Given a pixel coordinate relative to the map container, returns the corresponding pixel coordinate relative to the origin pixel. |
layerPointToContainerPoint( | Point |
Given a pixel coordinate relative to the origin pixel, returns the corresponding pixel coordinate relative to the map container. |
containerPointToLatLng( | LatLng |
Given a pixel coordinate relative to the map container, returns the corresponding geographical coordinate (for the current zoom level). |
latLngToContainerPoint( | Point |
Given a geographical coordinate, returns the corresponding pixel coordinate relative to the map container. |
mouseEventToContainerPoint( | Point |
Given a MouseEvent object, returns the pixel coordinate relative to the map container where the event took place. |
mouseEventToLayerPoint( | Point |
Given a MouseEvent object, returns the pixel coordinate relative to the origin pixel where the event took place. |
mouseEventToLatLng( | LatLng |
Given a MouseEvent object, returns geographical coordinate where the event took place. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Properties
Controls
Property | Type | Description |
---|---|---|
zoomControl | Control.Zoom | The default zoom control (only available if the zoomControl option was true when creating the map). |
Handlers
Property | Type | Description |
---|---|---|
boxZoom | Handler | Box (shift-drag with mouse) zoom handler. |
doubleClickZoom | Handler | Double click zoom handler. |
dragging | Handler | Map dragging handler (by both mouse and touch). |
keyboard | Handler | Keyboard navigation handler. |
scrollWheelZoom | Handler | Scroll wheel zoom handler. |
tap | Handler | Mobile touch hacks (quick tap and touch hold) handler. |
touchZoom | Handler | Touch zoom handler. |
Map panes
Pane | Type | Z-index | Description |
---|---|---|---|
mapPane | HTMLElement | 'auto' | Pane that contains all other map panes |
tilePane | HTMLElement | 200 | Pane for GridLayer s and TileLayer s |
overlayPane | HTMLElement | 400 | Pane for overlay shadows (e.g. Marker shadows) |
shadowPane | HTMLElement | 500 | Pane for vectors (Path s, like Polyline s and Polygon s), ImageOverlay s and VideoOverlay s |
markerPane | HTMLElement | 600 | Pane for Icon s of Marker s |
tooltipPane | HTMLElement | 650 | Pane for Tooltip s. |
popupPane | HTMLElement | 700 | Pane for Popup s. |
Locate options
Map
take in an options
parameter. This is a plain javascript object with the following optional components:Option | Type | Default | Description |
---|---|---|---|
watch | Boolean | false | If true , starts continuous watching of location changes (instead of detecting it once) using W3C watchPosition method. You can later stop watching using map.stopLocate() method. |
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. |
maxZoom | Number | Infinity | The maximum zoom for automatic view setting when using setView option. |
timeout | Number | 10000 | Number of milliseconds to wait for a response from geolocation before firing a locationerror event. |
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. |
enableHighAccuracy | Boolean | false | Enables high accuracy, see description in the W3C spec. |
Zoom options
Map
methods which modify the zoom level take in an options
parameter. This is a plain javascript object with the following optional components:Option | Type | Default | Description |
---|---|---|---|
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 without animation. |
Pan options
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 | Type | Default | Description |
---|---|---|---|
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). | |
duration | Number | 0.25 | Duration of animated panning, in seconds. |
easeLinearity | Number | 0.25 | The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, and the smaller this number, the more bowed the curve. |
noMoveStart | Boolean | false | If true , panning won't fire movestart event on start (used internally for panning inertia). |
Zoom/pan options
Option | Type | Default | Description |
---|---|---|---|
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 without animation. |
Option | Type | Default | Description |
---|---|---|---|
duration | Number | 0.25 | Duration of animated panning, in seconds. |
easeLinearity | Number | 0.25 | The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, and the smaller this number, the more bowed the curve. |
noMoveStart | Boolean | false | If true , panning won't fire movestart event on start (used internally for panning inertia). |
FitBounds options
Option | Type | Default | Description |
---|---|---|---|
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. |
paddingBottomRight | Point | [0, 0] | The same for the bottom right corner of the map. |
padding | Point | [0, 0] | Equivalent of setting both top left and bottom right padding to the same value. |
maxZoom | Number | null | The maximum possible zoom to use. |
Option | Type | Default | Description |
---|---|---|---|
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 without animation. |
Option | Type | Default | Description |
---|---|---|---|
duration | Number | 0.25 | Duration of animated panning, in seconds. |
easeLinearity | Number | 0.25 | The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, and the smaller this number, the more bowed the curve. |
noMoveStart | Boolean | false | If true , panning won't fire movestart event on start (used internally for panning inertia). |
Marker
L.Marker is used to display clickable/draggable icons on the map. Extends Layer
.
Usage example
L.marker([50.5, 30.5]).addTo(map);
Creation
Factory | Description |
---|---|
L.marker( | Instantiates a Marker object given a geographical point and optionally an options object. |
Options
Option | Type | Default | Description |
---|---|---|---|
icon | Icon | * | Icon instance to use for rendering the marker. See Icon documentation for details on how to customize the marker icon. If not specified, a common instance of L.Icon.Default is used. |
keyboard | Boolean | true | Whether the marker can be tabbed to with a keyboard and clicked by pressing enter. |
title | String | '' | Text for the browser tooltip that appear on marker hover (no tooltip by default). |
alt | String | '' | Text for the alt attribute of the icon image (useful for accessibility). |
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). |
opacity | Number | 1.0 | The opacity of the marker. |
riseOnHover | Boolean | false | If true , the marker will get on top of others when you hover the mouse over it. |
riseOffset | Number | 250 | The z-index offset used for the riseOnHover feature. |
pane | String | 'markerPane' |
Map pane where the markers icon will be added. |
shadowPane | String | 'shadowPane' |
Map pane where the markers shadow will be added. |
bubblingMouseEvents | Boolean | false | When true , a mouse event on this marker will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
Draggable marker options
Option | Type | Default | Description |
---|---|---|---|
draggable | Boolean | false | Whether the marker is draggable with mouse/touch or not. |
autoPan | Boolean | false | Whether to pan the map when dragging this marker near its edge or not. |
autoPanPadding | Point | Point(50, 50) | Distance (in pixels to the left/right and to the top/bottom) of the map edge to start panning the map. |
autoPanSpeed | Number | 10 | Number of pixels the map should pan by. |
Option | Type | Default | Description |
---|---|---|---|
interactive | Boolean | true | If false , the layer will not emit mouse events and will act as a part of the underlying map. |
Option | Type | Default | Description |
---|---|---|---|
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
move | Event | Fired when the marker is moved via setLatLng or by dragging. Old and new coordinates are included in event arguments as oldLatLng , latlng . |
Dragging events
Event | Data | Description |
---|---|---|
dragstart | Event | Fired when the user starts dragging the marker. |
movestart | Event | Fired when the marker starts moving (because of dragging). |
drag | Event | Fired repeatedly while the user drags the marker. |
dragend | DragEndEvent | Fired when the user stops dragging the marker. |
moveend | Event | Fired when the marker stops moving (because of dragging). |
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
addTo()
and remove()
and popup methods like bindPopup() you can also use the following methods:Method | Returns | Description |
---|---|---|
getLatLng() | LatLng |
Returns the current geographical position of the marker. |
setLatLng( | this |
Changes the marker position to the given point. |
setZIndexOffset( | this |
Changes the zIndex offset of the marker. |
getIcon() | Icon |
Returns the current icon used by the marker |
setIcon( | this |
Changes the marker icon. |
setOpacity( | this |
Changes the opacity of the marker. |
Other methods
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Properties
Interaction handlers
Handler
methods). Example: marker.dragging.disable();
Property | Type | Description |
---|---|---|
dragging | Handler | Marker dragging handler (by both mouse and touch). Only valid when the marker is on the map (Otherwise set marker.options.draggable ). |
Popup
Used to open popups in certain places of the map. Use Map.openPopup to open popups while making sure that only one popup is open at one time (recommended for usability), or use Map.addLayer to open as many as you want.
Usage example
If you want to just bind a popup to marker click and then open it, it's really easy:
marker.bindPopup(popupContent).openPopup();
Path overlays like polylines also have a bindPopup
method. Here's a more complicated way to open a popup on a map:
var popup = L.popup() .setLatLng(latlng) .setContent('<p>Hello world!<br />This is a nice popup.</p>') .openOn(map);
Creation
Factory | Description |
---|---|
L.popup( | 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. |
Options
Option | Type | Default | Description |
---|---|---|---|
maxWidth | Number | 300 | Max width of the popup, in pixels. |
minWidth | Number | 50 | Min width of the popup, in pixels. |
maxHeight | Number | null | If set, creates a scrollable container of the given height inside a popup if its content exceeds it. |
autoPan | Boolean | true | Set it to false if you don't want the map to do panning animation to fit the opened popup. |
autoPanPaddingTopLeft | Point | null | The margin between the popup and the top left corner of the map view after autopanning was performed. |
autoPanPaddingBottomRight | Point | null | The margin between the popup and the bottom right corner of the map view after autopanning was performed. |
autoPanPadding | Point | Point(5, 5) | Equivalent of setting both top left and bottom right autopan padding to the same value. |
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. |
closeButton | Boolean | true | Controls the presence of a close button in the popup. |
autoClose | Boolean | true | Set it to false if you want to override the default behavior of the popup closing when another popup is opened. |
closeOnEscapeKey | Boolean | true | Set it to false if you want to override the default behavior of the ESC key for closing of the popup. |
closeOnClick | Boolean | * | Set it if you want to override the default behavior of the popup closing when user clicks on the map. Defaults to the map's closePopupOnClick option. |
className | String | '' | A custom CSS class name to assign to the popup. |
Option | Type | Default | Description |
---|---|---|---|
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. |
pane | String | 'popupPane' |
Map pane where the popup will be added. |
Option | Type | Default | Description |
---|---|---|---|
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
getLatLng() | LatLng |
Returns the geographical point of popup. |
setLatLng( | this |
Sets the geographical point where the popup will open. |
getContent() | String|HTMLElement |
Returns the content of the popup. |
setContent( | 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 |
getElement() | String|HTMLElement |
Returns the HTML container of the popup. |
update() | null |
Updates the popup content, layout and position. Useful for updating the popup after something inside changed, e.g. image loaded. |
isOpen() | Boolean |
Returns |
bringToFront() | this |
Brings this popup in front of other popups (in the same map pane). |
bringToBack() | this |
Brings this popup to the back of other popups (in the same map pane). |
openOn( | this |
Adds the popup to the map and closes the previous one. The same as |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Tooltip
Used to display small texts on top of map layers.
Usage example
marker.bindTooltip("my tooltip text").openTooltip();
Note about tooltip offset. Leaflet takes two options in consideration for computing tooltip offsetting:
- the
offset
Tooltip option: it defaults to [0, 0], and it's specific to one tooltip. Add a positive x offset to move the tooltip to the right, and a positive y offset to move it to the bottom. Negatives will move to the left and top. - the
tooltipAnchor
Icon option: this will only be considered for Marker. You should adapt this value if you use a custom icon.
Creation
Factory | Description |
---|---|
L.tooltip( | Instantiates a Tooltip object given an optional options object that describes its appearance and location and an optional source object that is used to tag the tooltip with a reference to the Layer to which it refers. |
Options
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'tooltipPane' |
Map pane where the tooltip will be added. |
offset | Point | Point(0, 0) | Optional offset of the tooltip position. |
direction | String | 'auto' | Direction where to open the tooltip. Possible values are: right , left , top , bottom , center , auto . auto will dynamically switch between right and left according to the tooltip position on the map. |
permanent | Boolean | false | Whether to open the tooltip permanently or only on mouseover. |
sticky | Boolean | false | If true, the tooltip will follow the mouse instead of being fixed at the feature center. |
interactive | Boolean | false | If true, the tooltip will listen to the feature events. |
opacity | Number | 0.9 | Tooltip container opacity. |
Option | Type | Default | Description |
---|---|---|---|
className | String | '' | A custom CSS class name to assign to the popup. |
Option | Type | Default | Description |
---|---|---|---|
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
TileLayer
Used to load and display tile layers on the map. Note that most tile servers require attribution, which you can set under Layer
. Extends GridLayer
.
Usage example
L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar', attribution: 'Map data © <a href="https://www.openstreetmap.org/">OpenStreetMap</a> contributors, <a href="https://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>'}).addTo(map);
URL template
A string of the following form:
'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
{s}
means one of the available subdomains (used sequentially to help with browser parallel requests per domain limitation; subdomain values are specified in options; a
, b
or c
by default, can be omitted), {z}
— zoom level, {x}
and {y}
— tile coordinates. {r}
can be used to add "@2x" to the URL to load retina tiles.
You can use custom keys in the template, which will be evaluated from TileLayer options, like this:
L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});
Creation
Extension methods
Factory | Description |
---|---|
L.tilelayer( | Instantiates a tile layer object given a URL template and optionally an options object. |
Options
Option | Type | Default | Description |
---|---|---|---|
minZoom | Number | 0 | The minimum zoom level down to which this layer will be displayed (inclusive). |
maxZoom | Number | 18 | The maximum zoom level up to which this layer will be displayed (inclusive). |
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. |
errorTileUrl | String | '' | URL to the tile image to show in place of the tile that failed to load. |
zoomOffset | Number | 0 | The zoom number used in tile URLs will be offset with this value. |
tms | Boolean | false | If true , inverses Y axis numbering for tiles (turn this on for TMS services). |
zoomReverse | Boolean | false | If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom ) |
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. |
crossOrigin | Boolean|String | false | Whether the crossOrigin attribute will be added to the tiles. If a String is provided, all tiles will have their crossOrigin attribute set to the String provided. This is needed if you want to access tile pixel data. Refer to CORS Settings for valid String values. |
Option | Type | Default | Description |
---|---|---|---|
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. |
opacity | Number | 1.0 | Opacity of the tiles. Can be used in the createTile() function. |
updateWhenIdle | Boolean | (depends) | Load new tiles only when panning ends. true by default on mobile browsers, in order to avoid too many requests and keep smooth navigation. false otherwise in order to display new tiles during panning, since it is easy to pan outside the keepBuffer option in desktop browsers. |
updateWhenZooming | Boolean | true | By default, a smooth zoom animation (during a touch zoom or a flyTo() ) will update grid layers every integer zoom level. Setting this option to false will update the grid layer only when the smooth animation ends. |
updateInterval | Number | 200 | Tiles will not update more than once every updateInterval milliseconds when panning. |
zIndex | Number | 1 | The explicit zIndex of the tile layer. |
bounds | LatLngBounds | undefined | If set, tiles will only be loaded inside the set LatLngBounds . |
maxNativeZoom | Number | undefined | 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. |
minNativeZoom | Number | undefined | Minimum zoom number the tile source has available. If it is specified, the tiles on all zoom levels lower than minNativeZoom will be loaded from minNativeZoom level and auto-scaled. |
noWrap | Boolean | false | Whether the layer is wrapped around the antimeridian. If true , the GridLayer will only be displayed once at low zoom levels. Has no effect when the map CRS doesn't wrap around. Can be used in combination with bounds to prevent requesting tiles outside the CRS limits. |
pane | String | 'tilePane' |
Map pane where the grid layer will be added. |
className | String | '' | A custom class name to assign to the tile layer. Empty by default. |
keepBuffer | Number | 2 | When panning the map, keep this many rows and columns of tiles before unloading them. |
Option | Type | Default | Description |
---|---|---|---|
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
loading | Event | Fired when the grid layer starts loading tiles. |
tileunload | TileEvent | Fired when a tile is removed (e.g. when a tile goes off the screen). |
tileloadstart | TileEvent | Fired when a tile is requested and starts loading. |
tileerror | TileErrorEvent | Fired when there is an error loading a tile. |
tileload | TileEvent | Fired when a tile loads. |
load | Event | Fired when the grid layer loaded all visible tiles. |
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
setUrl( | this |
Updates the layer's URL template and redraws it (unless |
createTile( | HTMLElement |
Called only internally, overrides GridLayer's |
Extension methods
TileLayer
might reimplement the following method.Method | Returns | Description |
---|---|---|
getTileUrl( | String |
Called only internally, returns the URL for a tile given its coordinates. Classes extending |
Method | Returns | Description |
---|---|---|
bringToFront() | this |
Brings the tile layer to the top of all tile layers. |
bringToBack() | this |
Brings the tile layer to the bottom of all tile layers. |
getContainer() | HTMLElement |
Returns the HTML element that contains the tiles for this layer. |
setOpacity( | this |
Changes the opacity of the grid layer. |
setZIndex( | this |
Changes the zIndex of the grid layer. |
isLoading() | Boolean |
Returns |
redraw() | this |
Causes the layer to clear all the tiles and request them again. |
getTileSize() | Point |
Normalizes the tileSize option into a point. Used by the |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
TileLayer.WMS
Used to display WMS services as tile layers on the map. Extends TileLayer
.
Usage example
var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", { layers: 'nexrad-n0r-900913', format: 'image/png', transparent: true, attribution: "Weather data © 2012 IEM Nexrad" });
Creation
Factory | Description |
---|---|
L.tileLayer.wms( | Instantiates a WMS tile layer object given a base URL of the WMS service and a WMS parameters/options object. |
Options
Option | Type | Default | Description |
---|---|---|---|
layers | String | '' | (required) Comma-separated list of WMS layers to show. |
styles | String | '' | Comma-separated list of WMS styles. |
format | String | 'image/jpeg' | WMS image format (use 'image/png' for layers with transparency). |
transparent | Boolean | false | If true , the WMS service will return images with transparency. |
version | String | '1.1.1' | Version of the WMS service to use |
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. |
uppercase | Boolean | false | If true , WMS request parameter keys will be uppercase. |
Option | Type | Default | Description |
---|---|---|---|
minZoom | Number | 0 | The minimum zoom level down to which this layer will be displayed (inclusive). |
maxZoom | Number | 18 | The maximum zoom level up to which this layer will be displayed (inclusive). |
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. |
errorTileUrl | String | '' | URL to the tile image to show in place of the tile that failed to load. |
zoomOffset | Number | 0 | The zoom number used in tile URLs will be offset with this value. |
tms | Boolean | false | If true , inverses Y axis numbering for tiles (turn this on for TMS services). |
zoomReverse | Boolean | false | If set to true, the zoom number used in tile URLs will be reversed (maxZoom - zoom instead of zoom ) |
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. |
crossOrigin | Boolean|String | false | Whether the crossOrigin attribute will be added to the tiles. If a String is provided, all tiles will have their crossOrigin attribute set to the String provided. This is needed if you want to access tile pixel data. Refer to CORS Settings for valid String values. |
Option | Type | Default | Description |
---|---|---|---|
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. |
opacity | Number | 1.0 | Opacity of the tiles. Can be used in the createTile() function. |
updateWhenIdle | Boolean | (depends) | Load new tiles only when panning ends. true by default on mobile browsers, in order to avoid too many requests and keep smooth navigation. false otherwise in order to display new tiles during panning, since it is easy to pan outside the keepBuffer option in desktop browsers. |
updateWhenZooming | Boolean | true | By default, a smooth zoom animation (during a touch zoom or a flyTo() ) will update grid layers every integer zoom level. Setting this option to false will update the grid layer only when the smooth animation ends. |
updateInterval | Number | 200 | Tiles will not update more than once every updateInterval milliseconds when panning. |
zIndex | Number | 1 | The explicit zIndex of the tile layer. |
bounds | LatLngBounds | undefined | If set, tiles will only be loaded inside the set LatLngBounds . |
maxNativeZoom | Number | undefined | 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. |
minNativeZoom | Number | undefined | Minimum zoom number the tile source has available. If it is specified, the tiles on all zoom levels lower than minNativeZoom will be loaded from minNativeZoom level and auto-scaled. |
noWrap | Boolean | false | Whether the layer is wrapped around the antimeridian. If true , the GridLayer will only be displayed once at low zoom levels. Has no effect when the map CRS doesn't wrap around. Can be used in combination with bounds to prevent requesting tiles outside the CRS limits. |
pane | String | 'tilePane' |
Map pane where the grid layer will be added. |
className | String | '' | A custom class name to assign to the tile layer. Empty by default. |
keepBuffer | Number | 2 | When panning the map, keep this many rows and columns of tiles before unloading them. |
Option | Type | Default | Description |
---|---|---|---|
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
loading | Event | Fired when the grid layer starts loading tiles. |
tileunload | TileEvent | Fired when a tile is removed (e.g. when a tile goes off the screen). |
tileloadstart | TileEvent | Fired when a tile is requested and starts loading. |
tileerror | TileErrorEvent | Fired when there is an error loading a tile. |
tileload | TileEvent | Fired when a tile loads. |
load | Event | Fired when the grid layer loaded all visible tiles. |
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
setParams( | this |
Merges an object with the new parameters and re-requests tiles on the current screen (unless |
Method | Returns | Description |
---|---|---|
setUrl( | this |
Updates the layer's URL template and redraws it (unless |
createTile( | HTMLElement |
Called only internally, overrides GridLayer's |
Method | Returns | Description |
---|---|---|
bringToFront() | this |
Brings the tile layer to the top of all tile layers. |
bringToBack() | this |
Brings the tile layer to the bottom of all tile layers. |
getContainer() | HTMLElement |
Returns the HTML element that contains the tiles for this layer. |
setOpacity( | this |
Changes the opacity of the grid layer. |
setZIndex( | this |
Changes the zIndex of the grid layer. |
isLoading() | Boolean |
Returns |
redraw() | this |
Causes the layer to clear all the tiles and request them again. |
getTileSize() | Point |
Normalizes the tileSize option into a point. Used by the |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
ImageOverlay
Used to load and display a single image over specific bounds of the map. Extends Layer
.
Usage example
var imageUrl = 'http://www.lib.utexas.edu/maps/historical/newark_nj_1922.jpg', imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]]; L.imageOverlay(imageUrl, imageBounds).addTo(map);
Creation
Factory | Description |
---|---|
L.imageOverlay( | Instantiates an image overlay object given the URL of the image and the geographical bounds it is tied to. |
Options
Option | Type | Default | Description |
---|---|---|---|
opacity | Number | 1.0 | The opacity of the image overlay. |
alt | String | '' | Text for the alt attribute of the image (useful for accessibility). |
interactive | Boolean | false | If true , the image overlay will emit mouse events when clicked or hovered. |
crossOrigin | Boolean|String | false | Whether the crossOrigin attribute will be added to the image. If a String is provided, the image will have its crossOrigin attribute set to the String provided. This is needed if you want to access image pixel data. Refer to CORS Settings for valid String values. |
errorOverlayUrl | String | '' | URL to the overlay image to show in place of the overlay that failed to load. |
zIndex | Number | 1 | The explicit zIndex of the overlay layer. |
className | String | '' | A custom class name to assign to the image. Empty by default. |
Option | Type | Default | Description |
---|---|---|---|
bubblingMouseEvents | Boolean | true | When true , a mouse event on this layer will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
load | Event | Fired when the ImageOverlay layer has loaded its image |
error | Event | Fired when the ImageOverlay layer fails to load its image |
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
setOpacity( | this |
Sets the opacity of the overlay. |
bringToFront() | this |
Brings the layer to the top of all overlays. |
bringToBack() | this |
Brings the layer to the bottom of all overlays. |
setUrl( | this |
Changes the URL of the image. |
setBounds( | this |
Update the bounds that this ImageOverlay covers |
setZIndex( | this |
Changes the zIndex of the image overlay. |
getBounds() | LatLngBounds |
Get the bounds that this ImageOverlay covers |
getElement() | HTMLElement |
Returns the instance of |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
VideoOverlay
Used to load and display a video player over specific bounds of the map. Extends ImageOverlay
.
A video overlay uses the <video>
HTML5 element.
Usage example
var videoUrl = 'https://www.mapbox.com/bites/00188/patricia_nasa.webm', videoBounds = [[ 32, -130], [ 13, -100]]; L.videoOverlay(videoUrl, videoBounds ).addTo(map);
Creation
Factory | Description |
---|---|
L.videoOverlay( | Instantiates an image overlay object given the URL of the video (or array of URLs, or even a video element) and the geographical bounds it is tied to. |
Options
Option | Type | Default | Description |
---|---|---|---|
autoplay | Boolean | true | Whether the video starts playing automatically when loaded. |
loop | Boolean | true | Whether the video will loop back to the beginning when played. |
keepAspectRatio | Boolean | true | Whether the video will save aspect ratio after the projection. Relevant for supported browsers. See browser compatibility |
muted | Boolean | false | Whether the video starts on mute when loaded. |
Option | Type | Default | Description |
---|---|---|---|
opacity | Number | 1.0 | The opacity of the image overlay. |
alt | String | '' | Text for the alt attribute of the image (useful for accessibility). |
interactive | Boolean | false | If true , the image overlay will emit mouse events when clicked or hovered. |
crossOrigin | Boolean|String | false | Whether the crossOrigin attribute will be added to the image. If a String is provided, the image will have its crossOrigin attribute set to the String provided. This is needed if you want to access image pixel data. Refer to CORS Settings for valid String values. |
errorOverlayUrl | String | '' | URL to the overlay image to show in place of the overlay that failed to load. |
zIndex | Number | 1 | The explicit zIndex of the overlay layer. |
className | String | '' | A custom class name to assign to the image. Empty by default. |
Option | Type | Default | Description |
---|---|---|---|
bubblingMouseEvents | Boolean | true | When true , a mouse event on this layer will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
load | Event | Fired when the video has finished loading the first frame |
Event | Data | Description |
---|---|---|
error | Event | Fired when the ImageOverlay layer fails to load its image |
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
getElement() | HTMLVideoElement |
Returns the instance of |
Method | Returns | Description |
---|---|---|
setOpacity( | this |
Sets the opacity of the overlay. |
bringToFront() | this |
Brings the layer to the top of all overlays. |
bringToBack() | this |
Brings the layer to the bottom of all overlays. |
setUrl( | this |
Changes the URL of the image. |
setBounds( | this |
Update the bounds that this ImageOverlay covers |
setZIndex( | this |
Changes the zIndex of the image overlay. |
getBounds() | LatLngBounds |
Get the bounds that this ImageOverlay covers |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
SVGOverlay
Used to load, display and provide DOM access to an SVG file over specific bounds of the map. Extends ImageOverlay
.
An SVG overlay uses the <svg>
element.
Usage example
var svgElement = document.createElementNS("http://www.w3.org/2000/svg", "svg"); svgElement.setAttribute('xmlns', "http://www.w3.org/2000/svg"); svgElement.setAttribute('viewBox', "0 0 200 200"); svgElement.innerHTML = '<rect width="200" height="200"/><rect x="75" y="23" width="50" height="50" style="fill:red"/><rect x="75" y="123" width="50" height="50" style="fill:#0013ff"/>'; var svgElementBounds = [ [ 32, -130 ], [ 13, -100 ] ]; L.svgOverlay(svgElement, svgElementBounds).addTo(map);
Creation
Factory | Description |
---|---|
L.svgOverlay( | Instantiates an image overlay object given an SVG element and the geographical bounds it is tied to. A viewBox attribute is required on the SVG element to zoom in and out properly. |
Options
Option | Type | Default | Description |
---|---|---|---|
opacity | Number | 1.0 | The opacity of the image overlay. |
alt | String | '' | Text for the alt attribute of the image (useful for accessibility). |
interactive | Boolean | false | If true , the image overlay will emit mouse events when clicked or hovered. |
crossOrigin | Boolean|String | false | Whether the crossOrigin attribute will be added to the image. If a String is provided, the image will have its crossOrigin attribute set to the String provided. This is needed if you want to access image pixel data. Refer to CORS Settings for valid String values. |
errorOverlayUrl | String | '' | URL to the overlay image to show in place of the overlay that failed to load. |
zIndex | Number | 1 | The explicit zIndex of the overlay layer. |
className | String | '' | A custom class name to assign to the image. Empty by default. |
Option | Type | Default | Description |
---|---|---|---|
bubblingMouseEvents | Boolean | true | When true , a mouse event on this layer will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
load | Event | Fired when the ImageOverlay layer has loaded its image |
error | Event | Fired when the ImageOverlay layer fails to load its image |
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
getElement() | SVGElement |
Returns the instance of |
Method | Returns | Description |
---|---|---|
setOpacity( | this |
Sets the opacity of the overlay. |
bringToFront() | this |
Brings the layer to the top of all overlays. |
bringToBack() | this |
Brings the layer to the bottom of all overlays. |
setUrl( | this |
Changes the URL of the image. |
setBounds( | this |
Update the bounds that this ImageOverlay covers |
setZIndex( | this |
Changes the zIndex of the image overlay. |
getBounds() | LatLngBounds |
Get the bounds that this ImageOverlay covers |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Path
An abstract class that contains options and constants shared between vector overlays (Polygon, Polyline, Circle). Do not use it directly. Extends Layer
.
Options
Option | Type | Default | Description |
---|---|---|---|
stroke | Boolean | true | Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles. |
color | String | '#3388ff' | Stroke color |
weight | Number | 3 | Stroke width in pixels |
opacity | Number | 1.0 | Stroke opacity |
lineCap | String | 'round' | A string that defines shape to be used at the end of the stroke. |
lineJoin | String | 'round' | A string that defines shape to be used at the corners of the stroke. |
dashArray | String | null | A string that defines the stroke dash pattern. Doesn't work on Canvas -powered layers in some old browsers. |
dashOffset | String | null | A string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas -powered layers in some old browsers. |
fill | Boolean | depends | Whether to fill the path with color. Set it to false to disable filling on polygons or circles. |
fillColor | String | * | Fill color. Defaults to the value of the color option |
fillOpacity | Number | 0.2 | Fill opacity. |
fillRule | String | 'evenodd' | A string that defines how the inside of a shape is determined. |
bubblingMouseEvents | Boolean | true | When true , a mouse event on this path will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
renderer | Renderer | Use this specific instance of Renderer for this path. Takes precedence over the map's default renderer. | |
className | String | null | Custom class name set on an element. Only for SVG renderer. |
Option | Type | Default | Description |
---|---|---|---|
interactive | Boolean | true | If false , the layer will not emit mouse events and will act as a part of the underlying map. |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
redraw() | this |
Redraws the layer. Sometimes useful after you changed the coordinates that the path uses. |
setStyle( | this |
Changes the appearance of a Path based on the options in the |
bringToFront() | this |
Brings the layer to the top of all path layers. |
bringToBack() | this |
Brings the layer to the bottom of all path layers. |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Polyline
A class for drawing polyline overlays on a map. Extends Path
.
Usage example
// create a red polyline from an array of LatLng points var latlngs = [ [45.51, -122.68], [37.77, -122.43], [34.04, -118.2] ]; var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map); // zoom the map to the polyline map.fitBounds(polyline.getBounds());
You can also pass a multi-dimensional array to represent a MultiPolyline
shape:
// create a red polyline from an array of arrays of LatLng points var latlngs = [ [[45.51, -122.68], [37.77, -122.43], [34.04, -118.2]], [[40.78, -73.91], [41.83, -87.62], [32.76, -96.72]] ];
Creation
Factory | Description |
---|---|
L.polyline( | Instantiates a polyline object given an array of geographical points and optionally an options object. You can create a Polyline object with multiple separate lines (MultiPolyline ) by passing an array of arrays of geographic points. |
Options
Option | Type | Default | Description |
---|---|---|---|
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. |
noClip | Boolean | false | Disable polyline clipping. |
Option | Type | Default | Description |
---|---|---|---|
stroke | Boolean | true | Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles. |
color | String | '#3388ff' | Stroke color |
weight | Number | 3 | Stroke width in pixels |
opacity | Number | 1.0 | Stroke opacity |
lineCap | String | 'round' | A string that defines shape to be used at the end of the stroke. |
lineJoin | String | 'round' | A string that defines shape to be used at the corners of the stroke. |
dashArray | String | null | A string that defines the stroke dash pattern. Doesn't work on Canvas -powered layers in some old browsers. |
dashOffset | String | null | A string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas -powered layers in some old browsers. |
fill | Boolean | depends | Whether to fill the path with color. Set it to false to disable filling on polygons or circles. |
fillColor | String | * | Fill color. Defaults to the value of the color option |
fillOpacity | Number | 0.2 | Fill opacity. |
fillRule | String | 'evenodd' | A string that defines how the inside of a shape is determined. |
bubblingMouseEvents | Boolean | true | When true , a mouse event on this path will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
renderer | Renderer | Use this specific instance of Renderer for this path. Takes precedence over the map's default renderer. | |
className | String | null | Custom class name set on an element. Only for SVG renderer. |
Option | Type | Default | Description |
---|---|---|---|
interactive | Boolean | true | If false , the layer will not emit mouse events and will act as a part of the underlying map. |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
getLatLngs() | LatLng[] |
Returns an array of the points in the path, or nested arrays of points in case of multi-polyline. |
setLatLngs( | this |
Replaces all the points in the polyline with the given array of geographical points. |
isEmpty() | Boolean |
Returns |
closestLayerPoint( | Point |
Returns the point closest to |
getCenter() | LatLng |
Returns the center (centroid) of the polyline. |
getBounds() | LatLngBounds |
Returns the |
addLatLng( | 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 |
Method | Returns | Description |
---|---|---|
redraw() | this |
Redraws the layer. Sometimes useful after you changed the coordinates that the path uses. |
setStyle( | this |
Changes the appearance of a Path based on the options in the |
bringToFront() | this |
Brings the layer to the top of all path layers. |
bringToBack() | this |
Brings the layer to the bottom of all path layers. |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Polygon
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.
Usage example
// create a red polygon from an array of LatLng points var latlngs = [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]]; var polygon = L.polygon(latlngs, {color: 'red'}).addTo(map); // zoom the map to the polygon map.fitBounds(polygon.getBounds());
You can also pass an array of arrays of latlngs, with the first array representing the outer shape and the other arrays representing holes in the outer shape:
var latlngs = [ [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole ];
Additionally, you can pass a multi-dimensional array to represent a MultiPolygon shape.
var latlngs = [ [ // first polygon [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring [[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole ], [ // second polygon [[41, -111.03],[45, -111.04],[45, -104.05],[41, -104.05]] ] ];
Creation
Factory | Description |
---|---|
L.polygon( |
Options
Option | Type | Default | Description |
---|---|---|---|
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. |
noClip | Boolean | false | Disable polyline clipping. |
Option | Type | Default | Description |
---|---|---|---|
stroke | Boolean | true | Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles. |
color | String | '#3388ff' | Stroke color |
weight | Number | 3 | Stroke width in pixels |
opacity | Number | 1.0 | Stroke opacity |
lineCap | String | 'round' | A string that defines shape to be used at the end of the stroke. |
lineJoin | String | 'round' | A string that defines shape to be used at the corners of the stroke. |
dashArray | String | null | A string that defines the stroke dash pattern. Doesn't work on Canvas -powered layers in some old browsers. |
dashOffset | String | null | A string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas -powered layers in some old browsers. |
fill | Boolean | depends | Whether to fill the path with color. Set it to false to disable filling on polygons or circles. |
fillColor | String | * | Fill color. Defaults to the value of the color option |
fillOpacity | Number | 0.2 | Fill opacity. |
fillRule | String | 'evenodd' | A string that defines how the inside of a shape is determined. |
bubblingMouseEvents | Boolean | true | When true , a mouse event on this path will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
renderer | Renderer | Use this specific instance of Renderer for this path. Takes precedence over the map's default renderer. | |
className | String | null | Custom class name set on an element. Only for SVG renderer. |
Option | Type | Default | Description |
---|---|---|---|
interactive | Boolean | true | If false , the layer will not emit mouse events and will act as a part of the underlying map. |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
Method | Returns | Description |
---|---|---|
getLatLngs() | LatLng[] |
Returns an array of the points in the path, or nested arrays of points in case of multi-polyline. |
setLatLngs( | this |
Replaces all the points in the polyline with the given array of geographical points. |
isEmpty() | Boolean |
Returns |
closestLayerPoint( | Point |
Returns the point closest to |
getCenter() | LatLng |
Returns the center (centroid) of the polyline. |
getBounds() | LatLngBounds |
Returns the |
addLatLng( | 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 |
Method | Returns | Description |
---|---|---|
redraw() | this |
Redraws the layer. Sometimes useful after you changed the coordinates that the path uses. |
setStyle( | this |
Changes the appearance of a Path based on the options in the |
bringToFront() | this |
Brings the layer to the top of all path layers. |
bringToBack() | this |
Brings the layer to the bottom of all path layers. |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Rectangle
A class for drawing rectangle overlays on a map. Extends Polygon
.
Usage example
// define rectangle geographical bounds var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]]; // create an orange rectangle L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map); // zoom the map to the rectangle bounds map.fitBounds(bounds);
Creation
Factory | Description |
---|---|
L.rectangle( |
Options
Option | Type | Default | Description |
---|---|---|---|
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. |
noClip | Boolean | false | Disable polyline clipping. |
Option | Type | Default | Description |
---|---|---|---|
stroke | Boolean | true | Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles. |
color | String | '#3388ff' | Stroke color |
weight | Number | 3 | Stroke width in pixels |
opacity | Number | 1.0 | Stroke opacity |
lineCap | String | 'round' | A string that defines shape to be used at the end of the stroke. |
lineJoin | String | 'round' | A string that defines shape to be used at the corners of the stroke. |
dashArray | String | null | A string that defines the stroke dash pattern. Doesn't work on Canvas -powered layers in some old browsers. |
dashOffset | String | null | A string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas -powered layers in some old browsers. |
fill | Boolean | depends | Whether to fill the path with color. Set it to false to disable filling on polygons or circles. |
fillColor | String | * | Fill color. Defaults to the value of the color option |
fillOpacity | Number | 0.2 | Fill opacity. |
fillRule | String | 'evenodd' | A string that defines how the inside of a shape is determined. |
bubblingMouseEvents | Boolean | true | When true , a mouse event on this path will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
renderer | Renderer | Use this specific instance of Renderer for this path. Takes precedence over the map's default renderer. | |
className | String | null | Custom class name set on an element. Only for SVG renderer. |
Option | Type | Default | Description |
---|---|---|---|
interactive | Boolean | true | If false , the layer will not emit mouse events and will act as a part of the underlying map. |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
setBounds( | this |
Redraws the rectangle with the passed bounds. |
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
Method | Returns | Description |
---|---|---|
getLatLngs() | LatLng[] |
Returns an array of the points in the path, or nested arrays of points in case of multi-polyline. |
setLatLngs( | this |
Replaces all the points in the polyline with the given array of geographical points. |
isEmpty() | Boolean |
Returns |
closestLayerPoint( | Point |
Returns the point closest to |
getCenter() | LatLng |
Returns the center (centroid) of the polyline. |
getBounds() | LatLngBounds |
Returns the |
addLatLng( | 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 |
Method | Returns | Description |
---|---|---|
redraw() | this |
Redraws the layer. Sometimes useful after you changed the coordinates that the path uses. |
setStyle( | this |
Changes the appearance of a Path based on the options in the |
bringToFront() | this |
Brings the layer to the top of all path layers. |
bringToBack() | this |
Brings the layer to the bottom of all path layers. |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Circle
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).
Usage example
L.circle([50.5, 30.5], {radius: 200}).addTo(map);
Creation
Factory | Description |
---|---|
L.circle( | Instantiates a circle object given a geographical point, and an options object which contains the circle radius. |
L.circle( | Obsolete way of instantiating a circle, for compatibility with 0.7.x code. Do not use in new applications or plugins. |
Options
Option | Type | Default | Description |
---|---|---|---|
radius | Number | Radius of the circle, in meters. |
Option | Type | Default | Description |
---|---|---|---|
stroke | Boolean | true | Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles. |
color | String | '#3388ff' | Stroke color |
weight | Number | 3 | Stroke width in pixels |
opacity | Number | 1.0 | Stroke opacity |
lineCap | String | 'round' | A string that defines shape to be used at the end of the stroke. |
lineJoin | String | 'round' | A string that defines shape to be used at the corners of the stroke. |
dashArray | String | null | A string that defines the stroke dash pattern. Doesn't work on Canvas -powered layers in some old browsers. |
dashOffset | String | null | A string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas -powered layers in some old browsers. |
fill | Boolean | depends | Whether to fill the path with color. Set it to false to disable filling on polygons or circles. |
fillColor | String | * | Fill color. Defaults to the value of the color option |
fillOpacity | Number | 0.2 | Fill opacity. |
fillRule | String | 'evenodd' | A string that defines how the inside of a shape is determined. |
bubblingMouseEvents | Boolean | true | When true , a mouse event on this path will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
renderer | Renderer | Use this specific instance of Renderer for this path. Takes precedence over the map's default renderer. | |
className | String | null | Custom class name set on an element. Only for SVG renderer. |
Option | Type | Default | Description |
---|---|---|---|
interactive | Boolean | true | If false , the layer will not emit mouse events and will act as a part of the underlying map. |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
move | Event | Fired when the marker is moved via setLatLng . Old and new coordinates are included in event arguments as oldLatLng , latlng . |
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
setRadius( | this |
Sets the radius of a circle. Units are in meters. |
getRadius() | Number |
Returns the current radius of a circle. Units are in meters. |
getBounds() | LatLngBounds |
Returns the |
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
setLatLng( | this |
Sets the position of a circle marker to a new location. |
getLatLng() | LatLng |
Returns the current geographical position of the circle marker |
Method | Returns | Description |
---|---|---|
redraw() | this |
Redraws the layer. Sometimes useful after you changed the coordinates that the path uses. |
setStyle( | this |
Changes the appearance of a Path based on the options in the |
bringToFront() | this |
Brings the layer to the top of all path layers. |
bringToBack() | this |
Brings the layer to the bottom of all path layers. |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
CircleMarker
A circle of a fixed size with radius specified in pixels. Extends Path
.
Creation
Factory | Description |
---|---|
L.circleMarker( | Instantiates a circle marker object given a geographical point, and an optional options object. |
Options
Option | Type | Default | Description |
---|---|---|---|
radius | Number | 10 | Radius of the circle marker, in pixels |
Option | Type | Default | Description |
---|---|---|---|
stroke | Boolean | true | Whether to draw stroke along the path. Set it to false to disable borders on polygons or circles. |
color | String | '#3388ff' | Stroke color |
weight | Number | 3 | Stroke width in pixels |
opacity | Number | 1.0 | Stroke opacity |
lineCap | String | 'round' | A string that defines shape to be used at the end of the stroke. |
lineJoin | String | 'round' | A string that defines shape to be used at the corners of the stroke. |
dashArray | String | null | A string that defines the stroke dash pattern. Doesn't work on Canvas -powered layers in some old browsers. |
dashOffset | String | null | A string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas -powered layers in some old browsers. |
fill | Boolean | depends | Whether to fill the path with color. Set it to false to disable filling on polygons or circles. |
fillColor | String | * | Fill color. Defaults to the value of the color option |
fillOpacity | Number | 0.2 | Fill opacity. |
fillRule | String | 'evenodd' | A string that defines how the inside of a shape is determined. |
bubblingMouseEvents | Boolean | true | When true , a mouse event on this path will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
renderer | Renderer | Use this specific instance of Renderer for this path. Takes precedence over the map's default renderer. | |
className | String | null | Custom class name set on an element. Only for SVG renderer. |
Option | Type | Default | Description |
---|---|---|---|
interactive | Boolean | true | If false , the layer will not emit mouse events and will act as a part of the underlying map. |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
move | Event | Fired when the marker is moved via setLatLng . Old and new coordinates are included in event arguments as oldLatLng , latlng . |
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
setLatLng( | this |
Sets the position of a circle marker to a new location. |
getLatLng() | LatLng |
Returns the current geographical position of the circle marker |
setRadius( | this |
Sets the radius of a circle marker. Units are in pixels. |
getRadius() | Number |
Returns the current radius of the circle |
Method | Returns | Description |
---|---|---|
redraw() | this |
Redraws the layer. Sometimes useful after you changed the coordinates that the path uses. |
setStyle( | this |
Changes the appearance of a Path based on the options in the |
bringToFront() | this |
Brings the layer to the top of all path layers. |
bringToBack() | this |
Brings the layer to the bottom of all path layers. |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
SVG
VML was deprecated in 2012, which means VML functionality exists only for backwards compatibility with old versions of Internet Explorer.
Allows vector layers to be displayed with SVG. Inherits Renderer
.
Due to technical limitations, SVG is not available in all web browsers, notably Android 2.x and 3.x.
Although SVG is not available on IE7 and IE8, these browsers support VML (a now deprecated technology), and the SVG renderer will fall back to VML in this case.
Usage example
Use SVG by default for all paths in the map:
var map = L.map('map', { renderer: L.svg() });
Use a SVG renderer with extra padding for specific vector geometries:
var map = L.map('map'); var myRenderer = L.svg({ padding: 0.5 }); var line = L.polyline( coordinates, { renderer: myRenderer } ); var circle = L.circle( center, { renderer: myRenderer } );
Creation
Factory | Description |
---|---|
L.svg( | Creates a SVG renderer with the given options. |
Options
Option | Type | Default | Description |
---|---|---|---|
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 |
tolerance | Number | 0 | How much to extend click tolerance round a path/object on the map |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
update | Event | Fired when the renderer updates its bounds, center and zoom, for example when its map has moved |
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Functions
Function | Returns | Description |
---|---|---|
create( | SVGElement | Returns a instance of SVGElement, corresponding to the class name passed. For example, using 'line' will return an instance of SVGLineElement. |
pointsToPath( | String | Generates a SVG path string for multiple rings, with each ring turning into "M..L..L.." instructions |
Canvas
Allows vector layers to be displayed with <canvas>
. Inherits Renderer
.
Due to technical limitations, Canvas is not available in all web browsers, notably IE8, and overlapping geometries might not display properly in some edge cases.
Usage example
Use Canvas by default for all paths in the map:
var map = L.map('map', { renderer: L.canvas() });
Use a Canvas renderer with extra padding for specific vector geometries:
var map = L.map('map'); var myRenderer = L.canvas({ padding: 0.5 }); var line = L.polyline( coordinates, { renderer: myRenderer } ); var circle = L.circle( center, { renderer: myRenderer } );
Creation
Factory | Description |
---|---|
L.canvas( | Creates a Canvas renderer with the given options. |
Options
Option | Type | Default | Description |
---|---|---|---|
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 |
tolerance | Number | 0 | How much to extend click tolerance round a path/object on the map |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
update | Event | Fired when the renderer updates its bounds, center and zoom, for example when its map has moved |
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
LayerGroup
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
.
Usage example
L.layerGroup([marker1, marker2]) .addLayer(polyline) .addTo(map);
Creation
Factory | Description |
---|---|
L.layerGroup( | Create a layer group, optionally given an initial set of layers and an options object. |
Options
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
addLayer( | this |
Adds the given layer to the group. |
removeLayer( | this |
Removes the given layer from the group. |
removeLayer( | this |
Removes the layer with the given internal ID from the group. |
hasLayer( | Boolean |
Returns |
hasLayer( | Boolean |
Returns |
clearLayers() | this |
Removes all the layers from the group. |
invoke( | this |
Calls |
eachLayer( | this |
Iterates over the layers of the group, optionally specifying context of the iterator function. group.eachLayer(function (layer) { layer.bindPopup('Hello'); }); |
getLayer( | Layer |
Returns the layer with the given internal ID. |
getLayers() | Layer[] |
Returns an array of all the layers added to the group. |
setZIndex( | this |
Calls |
getLayerId( | Number |
Returns the internal ID for a layer |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
FeatureGroup
Extended LayerGroup
that makes it easier to do the same thing to all its member layers:
-
bindPopup
binds a popup to all of the layers at once (likewise withbindTooltip
) - Events are propagated to the
FeatureGroup
, so if the group has an event handler, it will handle events from any of the layers. This includes mouse events and custom events. - Has
layeradd
andlayerremove
events
Usage example
L.featureGroup([marker1, marker2, polyline]) .bindPopup('Hello world!') .on('click', function() { alert('Clicked on a member of the group!'); }) .addTo(map);
Creation
Factory | Description |
---|---|
L.featureGroup( | Create a feature group, optionally given an initial set of layers and an options object. |
Options
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
layeradd | LayerEvent | Fired when a layer is added to this FeatureGroup
|
layerremove | LayerEvent | Fired when a layer is removed from this FeatureGroup
|
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
setStyle( | this |
Sets the given path options to each layer of the group that has a |
bringToFront() | this |
Brings the layer group to the top of all other layers |
bringToBack() | this |
Brings the layer group to the back of all other layers |
getBounds() | LatLngBounds |
Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children). |
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
addLayer( | this |
Adds the given layer to the group. |
removeLayer( | this |
Removes the given layer from the group. |
removeLayer( | this |
Removes the layer with the given internal ID from the group. |
hasLayer( | Boolean |
Returns |
hasLayer( | Boolean |
Returns |
clearLayers() | this |
Removes all the layers from the group. |
invoke( | this |
Calls |
eachLayer( | this |
Iterates over the layers of the group, optionally specifying context of the iterator function. group.eachLayer(function (layer) { layer.bindPopup('Hello'); }); |
getLayer( | Layer |
Returns the layer with the given internal ID. |
getLayers() | Layer[] |
Returns an array of all the layers added to the group. |
setZIndex( | this |
Calls |
getLayerId( | Number |
Returns the internal ID for a layer |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
GeoJSON
Represents a GeoJSON object or an array of GeoJSON objects. Allows you to parse GeoJSON data and display it on the map. Extends FeatureGroup
.
Usage example
L.geoJSON(data, { style: function (feature) { return {color: feature.properties.color}; } }).bindPopup(function (layer) { return layer.feature.properties.description; }).addTo(map);
Creation
Factory | Description |
---|---|
L.geoJSON( | Creates a GeoJSON layer. Optionally accepts an object in GeoJSON format to display on the map (you can alternatively add it later with addData method) and an options object. |
Options
Option | Type | Default | Description |
---|---|---|---|
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 : function(geoJsonPoint, latlng) { return L.marker(latlng); } |
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: function (geoJsonFeature) { return {} } |
onEachFeature | Function | * | A Function that will be called once for each created Feature , after it has been created and styled. Useful for attaching events and popups to features. The default is to do nothing with the newly created layers: function (feature, layer) {} |
filter | Function | * | A Function that will be used to decide whether to include a feature or not. The default is to include all features: function (geoJsonFeature) { return true; } Note: dynamically changing the |
coordsToLatLng | Function | * | A Function that will be used for converting GeoJSON coordinates to LatLng s. The default is the coordsToLatLng static method. |
markersInheritOptions | Boolean | false | Whether default Markers for "Point" type Features inherit from group options. |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
layeradd | LayerEvent | Fired when a layer is added to this FeatureGroup
|
layerremove | LayerEvent | Fired when a layer is removed from this FeatureGroup
|
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
addData(data) | this |
Adds a GeoJSON object to the layer. |
resetStyle(layer?) | this |
Resets the given vector layer's style to the original GeoJSON style, useful for resetting style after hover events. If |
setStyle(style) | this |
Changes styles of GeoJSON vector layers with the given style function. |
Method | Returns | Description |
---|---|---|
bringToFront() | this |
Brings the layer group to the top of all other layers |
bringToBack() | this |
Brings the layer group to the back of all other layers |
getBounds() | LatLngBounds |
Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children). |
Method | Returns | Description |
---|---|---|
toGeoJSON( | Object |
|
addLayer( | this |
Adds the given layer to the group. |
removeLayer( | this |
Removes the given layer from the group. |
removeLayer( | this |
Removes the layer with the given internal ID from the group. |
hasLayer( | Boolean |
Returns |
hasLayer( | Boolean |
Returns |
clearLayers() | this |
Removes all the layers from the group. |
invoke( | this |
Calls |
eachLayer( | this |
Iterates over the layers of the group, optionally specifying context of the iterator function. group.eachLayer(function (layer) { layer.bindPopup('Hello'); }); |
getLayer( | Layer |
Returns the layer with the given internal ID. |
getLayers() | Layer[] |
Returns an array of all the layers added to the group. |
setZIndex( | this |
Calls |
getLayerId( | Number |
Returns the internal ID for a layer |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Functions
Function | Returns | Description |
---|---|---|
geometryToLayer( | Layer | Creates a Layer from a given GeoJSON feature. Can use a custom pointToLayer and/or coordsToLatLng functions if provided as options. |
coordsToLatLng( | LatLng | Creates a LatLng object from an array of 2 numbers (longitude, latitude) or 3 numbers (longitude, latitude, altitude) used in GeoJSON for points. |
coordsToLatLngs( | 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 function. |
latLngToCoords( | Array | Reverse of coordsToLatLng
|
latLngsToCoords( | Array | Reverse of coordsToLatLngs closed determines whether the first point should be appended to the end of the array to close the feature, only used when levelsDeep is 0. False by default. |
asFeature( | Object | Normalize GeoJSON geometries/features into GeoJSON features. |
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.
Usage example
Synchronous usage
To create a custom layer, extend GridLayer and implement the createTile()
method, which will be passed a Point
object with the x
, y
, and z
(zoom level) coordinates to draw your tile.
var CanvasLayer = L.GridLayer.extend({ createTile: function(coords){ // create a <canvas> element for drawing var tile = L.DomUtil.create('canvas', 'leaflet-tile'); // setup tile width and height according to the options var size = this.getTileSize(); tile.width = size.x; tile.height = size.y; // get a canvas context and draw something on it using coords.x, coords.y and coords.z var ctx = tile.getContext('2d'); // return the tile so it can be rendered on screen return tile; } });
Asynchronous usage
Tile creation can also be asynchronous, this is useful when using a third-party drawing library. Once the tile is finished drawing it can be passed to the done()
callback.
var CanvasLayer = L.GridLayer.extend({ createTile: function(coords, done){ var error; // create a <canvas> element for drawing var tile = L.DomUtil.create('canvas', 'leaflet-tile'); // setup tile width and height according to the options var size = this.getTileSize(); tile.width = size.x; tile.height = size.y; // draw something asynchronously and pass the tile to the done() callback setTimeout(function() { done(error, tile); }, 1000); return tile; } });
Creation
Factory | Description |
---|---|
L.gridLayer( | Creates a new instance of GridLayer with the supplied options. |
Options
Option | Type | Default | Description |
---|---|---|---|
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. |
opacity | Number | 1.0 | Opacity of the tiles. Can be used in the createTile() function. |
updateWhenIdle | Boolean | (depends) | Load new tiles only when panning ends. true by default on mobile browsers, in order to avoid too many requests and keep smooth navigation. false otherwise in order to display new tiles during panning, since it is easy to pan outside the keepBuffer option in desktop browsers. |
updateWhenZooming | Boolean | true | By default, a smooth zoom animation (during a touch zoom or a flyTo() ) will update grid layers every integer zoom level. Setting this option to false will update the grid layer only when the smooth animation ends. |
updateInterval | Number | 200 | Tiles will not update more than once every updateInterval milliseconds when panning. |
zIndex | Number | 1 | The explicit zIndex of the tile layer. |
bounds | LatLngBounds | undefined | If set, tiles will only be loaded inside the set LatLngBounds . |
minZoom | Number | 0 | The minimum zoom level down to which this layer will be displayed (inclusive). |
maxZoom | Number | undefined | The maximum zoom level up to which this layer will be displayed (inclusive). |
maxNativeZoom | Number | undefined | 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. |
minNativeZoom | Number | undefined | Minimum zoom number the tile source has available. If it is specified, the tiles on all zoom levels lower than minNativeZoom will be loaded from minNativeZoom level and auto-scaled. |
noWrap | Boolean | false | Whether the layer is wrapped around the antimeridian. If true , the GridLayer will only be displayed once at low zoom levels. Has no effect when the map CRS doesn't wrap around. Can be used in combination with bounds to prevent requesting tiles outside the CRS limits. |
pane | String | 'tilePane' |
Map pane where the grid layer will be added. |
className | String | '' | A custom class name to assign to the tile layer. Empty by default. |
keepBuffer | Number | 2 | When panning the map, keep this many rows and columns of tiles before unloading them. |
Option | Type | Default | Description |
---|---|---|---|
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
loading | Event | Fired when the grid layer starts loading tiles. |
tileunload | TileEvent | Fired when a tile is removed (e.g. when a tile goes off the screen). |
tileloadstart | TileEvent | Fired when a tile is requested and starts loading. |
tileerror | TileErrorEvent | Fired when there is an error loading a tile. |
tileload | TileEvent | Fired when a tile loads. |
load | Event | Fired when the grid layer loaded all visible tiles. |
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
bringToFront() | this |
Brings the tile layer to the top of all tile layers. |
bringToBack() | this |
Brings the tile layer to the bottom of all tile layers. |
getContainer() | HTMLElement |
Returns the HTML element that contains the tiles for this layer. |
setOpacity( | this |
Changes the opacity of the grid layer. |
setZIndex( | this |
Changes the zIndex of the grid layer. |
isLoading() | Boolean |
Returns |
redraw() | this |
Causes the layer to clear all the tiles and request them again. |
getTileSize() | Point |
Normalizes the tileSize option into a point. Used by the |
Extension methods
GridLayer
shall reimplement the following method.Method | Returns | Description |
---|---|---|
createTile( | HTMLElement |
Called only internally, must be overridden by classes extending |
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
LatLng
Represents a geographical point with a certain latitude and longitude.
Usage example
var latlng = L.latLng(50.5, 30.5);
All Leaflet methods that accept LatLng objects also accept them in a simple Array form and simple object form (unless noted otherwise), so these lines are equivalent:
map.panTo([50, 30]); map.panTo({lon: 30, lat: 50}); map.panTo({lat: 50, lng: 30}); map.panTo(L.latLng(50, 30));
Note that LatLng
does not inherit from Leaflet's Class
object, which means new classes can't inherit from it, and new methods can't be added to it with the include
function.
Creation
Factory | Description |
---|---|
L.latLng( | Creates an object representing a geographical point with the given latitude and longitude (and optionally altitude). |
L.latLng( | Expects an array of the form [Number, Number] or [Number, Number, Number] instead. |
L.latLng( | Expects an plain object of the form {lat: Number, lng: Number} or {lat: Number, lng: Number, alt: Number} instead. |
Methods
Method | Returns | Description |
---|---|---|
equals( | Boolean |
Returns |
toString() | String |
Returns a string representation of the point (for debugging purposes). |
distanceTo( | Number |
Returns the distance (in meters) to the given |
wrap() | LatLng |
Returns a new |
toBounds( | LatLngBounds |
Returns a new |
Properties
Property | Type | Description |
---|---|---|
lat | Number | Latitude in degrees |
lng | Number | Longitude in degrees |
alt | Number | Altitude in meters (optional) |
LatLngBounds
Represents a rectangular geographical area on a map.
Usage example
var corner1 = L.latLng(40.712, -74.227), corner2 = L.latLng(40.774, -74.125), bounds = L.latLngBounds(corner1, corner2);
All Leaflet methods that accept LatLngBounds objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:
map.fitBounds([ [40.712, -74.227], [40.774, -74.125] ]);
Caution: if the area crosses the antimeridian (often confused with the International Date Line), you must specify corners outside the [-180, 180] degrees longitude range.
Note that LatLngBounds
does not inherit from Leaflet's Class
object, which means new classes can't inherit from it, and new methods can't be added to it with the include
function.
Creation
Factory | Description |
---|---|
L.latLngBounds( | Creates a LatLngBounds object by defining two diagonally opposite corners of the rectangle. |
L.latLngBounds( | 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 . |
Methods
Method | Returns | Description |
---|---|---|
extend( | this |
Extend the bounds to contain the given point |
extend( | this |
Extend the bounds to contain the given bounds |
pad( | LatLngBounds |
Returns bounds created by extending or retracting the current bounds by a given ratio in each direction. For example, a ratio of 0.5 extends the bounds by 50% in each direction. Negative values will retract the bounds. |
getCenter() | LatLng |
Returns the center point of the bounds. |
getSouthWest() | LatLng |
Returns the south-west point of the bounds. |
getNorthEast() | LatLng |
Returns the north-east point of the bounds. |
getNorthWest() | LatLng |
Returns the north-west point of the bounds. |
getSouthEast() | LatLng |
Returns the south-east point of the bounds. |
getWest() | Number |
Returns the west longitude of the bounds |
getSouth() | Number |
Returns the south latitude of the bounds |
getEast() | Number |
Returns the east longitude of the bounds |
getNorth() | Number |
Returns the north latitude of the bounds |
contains( | Boolean |
Returns |
contains( | Boolean |
Returns |
intersects( | Boolean |
Returns |
overlaps( | Boolean |
Returns |
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. |
equals( | Boolean |
Returns |
isValid() | Boolean |
Returns |
Point
Represents a point with x
and y
coordinates in pixels.
Usage example
var point = L.point(200, 300);
All Leaflet methods and options that accept Point
objects also accept them in a simple Array form (unless noted otherwise), so these lines are equivalent:
map.panBy([200, 300]); map.panBy(L.point(200, 300));
Note that Point
does not inherit from Leaflet's Class
object, which means new classes can't inherit from it, and new methods can't be added to it with the include
function.
Creation
Factory | Description |
---|---|
L.point( | Creates a Point object with the given x and y coordinates. If optional round is set to true, rounds the x and y values. |
L.point( | Expects an array of the form [x, y] instead. |
L.point( | Expects a plain object of the form {x: Number, y: Number} instead. |
Methods
Method | Returns | Description |
---|---|---|
clone() | Point |
Returns a copy of the current point. |
add( | Point |
Returns the result of addition of the current and the given points. |
subtract( | Point |
Returns the result of subtraction of the given point from the current. |
divideBy( | Point |
Returns the result of division of the current point by the given number. |
multiplyBy( | Point |
Returns the result of multiplication of the current point by the given number. |
scaleBy( | Point |
Multiply each coordinate of the current point by each coordinate of |
unscaleBy( | Point |
Inverse of |
round() | Point |
Returns a copy of the current point with rounded coordinates. |
floor() | Point |
Returns a copy of the current point with floored coordinates (rounded down). |
ceil() | Point |
Returns a copy of the current point with ceiled coordinates (rounded up). |
trunc() | Point |
Returns a copy of the current point with truncated coordinates (rounded towards zero). |
distanceTo( | Number |
Returns the cartesian distance between the current and the given points. |
equals( | Boolean |
Returns |
contains( | Boolean |
Returns |
toString() | String |
Returns a string representation of the point for debugging purposes. |
Properties
Property | Type | Description |
---|---|---|
x | Number | The x coordinate of the point |
y | Number | The y coordinate of the point |
Bounds
Represents a rectangular area in pixel coordinates.
Usage example
var p1 = L.point(10, 10), p2 = L.point(40, 60), bounds = L.bounds(p1, p2);
All Leaflet methods that accept Bounds
objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:
otherBounds.intersects([[10, 10], [40, 60]]);
Note that Bounds
does not inherit from Leaflet's Class
object, which means new classes can't inherit from it, and new methods can't be added to it with the include
function.
Creation
Factory | Description |
---|---|
L.bounds( | Creates a Bounds object from two corners coordinate pairs. |
L.bounds( | Creates a Bounds object from the given array of points. |
Methods
Method | Returns | Description |
---|---|---|
extend( | this |
Extends the bounds to contain the given point. |
getCenter( | Point |
Returns the center point of the bounds. |
getBottomLeft() | Point |
Returns the bottom-left point of the bounds. |
getTopRight() | Point |
Returns the top-right point of the bounds. |
getTopLeft() | Point |
Returns the top-left point of the bounds (i.e. |
getBottomRight() | Point |
Returns the bottom-right point of the bounds (i.e. |
getSize() | Point |
Returns the size of the given bounds |
contains( | Boolean |
Returns |
contains( | Boolean |
Returns |
intersects( | Boolean |
Returns |
overlaps( | Boolean |
Returns |
Properties
Property | Type | Description |
---|---|---|
min | Point | The top left corner of the rectangle. |
max | Point | The bottom right corner of the rectangle. |
Icon
Represents an icon to provide when creating a marker.
Usage example
var myIcon = L.icon({ iconUrl: 'my-icon.png', iconSize: [38, 95], iconAnchor: [22, 94], popupAnchor: [-3, -76], shadowUrl: 'my-icon-shadow.png', shadowSize: [68, 95], shadowAnchor: [22, 94] }); L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
L.Icon.Default
extends L.Icon
and is the blue icon Leaflet uses for markers by default.
Creation
Factory | Description |
---|---|
L.icon( | Creates an icon instance with the given options. |
Options
Option | Type | Default | Description |
---|---|---|---|
iconUrl | String | null | (required) The URL to the icon image (absolute or relative to your script path). |
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. |
iconSize | Point | null | Size of the icon image in pixels. |
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. |
popupAnchor | Point | [0, 0] | The coordinates of the point from which popups will "open", relative to the icon anchor. |
tooltipAnchor | Point | [0, 0] | The coordinates of the point from which tooltips will "open", relative to the icon anchor. |
shadowUrl | String | null | The URL to the icon shadow image. If not specified, no shadow image will be created. |
shadowRetinaUrl | String | null | |
shadowSize | Point | null | Size of the shadow image in pixels. |
shadowAnchor | Point | null | The coordinates of the "tip" of the shadow (relative to its top left corner) (the same as iconAnchor if not specified). |
className | String | '' | A custom class name to assign to both icon and shadow images. Empty by default. |
Methods
Method | Returns | Description |
---|---|---|
createIcon( | HTMLElement |
Called internally when the icon has to be shown, returns a |
createShadow( | HTMLElement |
As |
Icon.Default
Icon
, represents the icon to use in Marker
s when no icon is specified. Points to the blue marker image distributed with Leaflet releases. In order to customize the default icon, just change the properties of L.Icon.Default.prototype.options
(which is a set of Icon options
).
If you want to completely replace the default icon, override the L.Marker.prototype.options.icon
with your own icon instead.
Option | Type | Default | Description |
---|---|---|---|
imagePath | String |
Icon.Default will try to auto-detect the location of the blue icon images. If you are placing these images in a non-standard way, set this option to point to the right path. |
DivIcon
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.
Usage example
var myIcon = L.divIcon({className: 'my-div-icon'}); // you can set .my-div-icon styles in CSS L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
By default, it has a 'leaflet-div-icon' CSS class and is styled as a little white square with a shadow.
Creation
Factory | Description |
---|---|
L.divIcon( | Creates a DivIcon instance with the given options. |
Options
Option | Type | Default | Description |
---|---|---|---|
html | String|HTMLElement | '' | Custom HTML code to put inside the div element, empty by default. Alternatively, an instance of HTMLElement . |
bgPos | Point | [0, 0] | Optional relative position of the background, in pixels |
Option | Type | Default | Description |
---|---|---|---|
iconUrl | String | null | (required) The URL to the icon image (absolute or relative to your script path). |
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. |
iconSize | Point | null | Size of the icon image in pixels. |
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. |
popupAnchor | Point | [0, 0] | The coordinates of the point from which popups will "open", relative to the icon anchor. |
tooltipAnchor | Point | [0, 0] | The coordinates of the point from which tooltips will "open", relative to the icon anchor. |
shadowUrl | String | null | The URL to the icon shadow image. If not specified, no shadow image will be created. |
shadowRetinaUrl | String | null | |
shadowSize | Point | null | Size of the shadow image in pixels. |
shadowAnchor | Point | null | The coordinates of the "tip" of the shadow (relative to its top left corner) (the same as iconAnchor if not specified). |
className | String | '' | A custom class name to assign to both icon and shadow images. Empty by default. |
Methods
Method | Returns | Description |
---|---|---|
createIcon( | HTMLElement |
Called internally when the icon has to be shown, returns a |
createShadow( | HTMLElement |
As |
Control.Zoom
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 to false
. Extends Control
.
Creation
Factory | Description |
---|---|
L.control.zoom( | Creates a zoom control |
Options
Option | Type | Default | Description |
---|---|---|---|
zoomInText | String | '+' | The text set on the 'zoom in' button. |
zoomInTitle | String | 'Zoom in' | The title set on the 'zoom in' button. |
zoomOutText | String | '− | ' The text set on the 'zoom out' button. |
zoomOutTitle | String | 'Zoom out' | The title set on the 'zoom out' button. |
Option | Type | Default | Description |
---|---|---|---|
position | String | 'topright' | The position of the control (one of the map corners). Possible values are 'topleft' , 'topright' , 'bottomleft' or 'bottomright'
|
Methods
Method | Returns | Description |
---|---|---|
getPosition() | string |
Returns the position of the control. |
setPosition( | this |
Sets the position of the control. |
getContainer() | HTMLElement |
Returns the HTMLElement that contains the control. |
addTo( | this |
Adds the control to the given map. |
remove() | this |
Removes the control from the map it is currently active on. |
Control.Attribution
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 to false
, and it fetches attribution texts from layers with the getAttribution
method automatically. Extends Control.
Creation
Factory | Description |
---|---|
L.control.attribution( | Creates an attribution control. |
Options
Option | Type | Default | Description |
---|---|---|---|
prefix | String | 'Leaflet' | The HTML text shown before the attributions. Pass false to disable. |
Option | Type | Default | Description |
---|---|---|---|
position | String | 'topright' | The position of the control (one of the map corners). Possible values are 'topleft' , 'topright' , 'bottomleft' or 'bottomright'
|
Methods
Method | Returns | Description |
---|---|---|
setPrefix( | this |
Sets the text before the attributions. |
addAttribution( | this |
Adds an attribution text (e.g. |
removeAttribution( | this |
Removes an attribution text. |
Method | Returns | Description |
---|---|---|
getPosition() | string |
Returns the position of the control. |
setPosition( | this |
Sets the position of the control. |
getContainer() | HTMLElement |
Returns the HTMLElement that contains the control. |
addTo( | this |
Adds the control to the given map. |
remove() | this |
Removes the control from the map it is currently active on. |
Control.Layers
The layers control gives users the ability to switch between different base layers and switch overlays on/off (check out the detailed example). Extends Control
.
Usage example
var baseLayers = { "Mapbox": mapbox, "OpenStreetMap": osm }; var overlays = { "Marker": marker, "Roads": roadsLayer }; L.control.layers(baseLayers, overlays).addTo(map);
The baseLayers
and overlays
parameters are object literals with layer names as keys and Layer
objects as values:
{ "<someName1>": layer1, "<someName2>": layer2 }
The layer names can contain HTML, which allows you to add additional styling to the items:
{"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}
Creation
Factory | Description |
---|---|
L.control.layers( | Creates a layers 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. |
Options
Option | Type | Default | Description |
---|---|---|---|
collapsed | Boolean | true | If true , the control will be collapsed into an icon and expanded on mouse hover or touch. |
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. |
hideSingleBase | Boolean | false | If true , the base layers in the control will be hidden when there is only one. |
sortLayers | Boolean | false | Whether to sort the layers. When false , layers will keep the order in which they were added to the control. |
sortFunction | Function | * | A compare function that will be used for sorting the layers, when sortLayers is true . The function receives both the L.Layer instances and their names, as in sortFunction(layerA, layerB, nameA, nameB) . By default, it sorts layers alphabetically by their name. |
Option | Type | Default | Description |
---|---|---|---|
position | String | 'topright' | The position of the control (one of the map corners). Possible values are 'topleft' , 'topright' , 'bottomleft' or 'bottomright'
|
Methods
Method | Returns | Description |
---|---|---|
addBaseLayer( | this |
Adds a base layer (radio button entry) with the given name to the control. |
addOverlay( | this |
Adds an overlay (checkbox entry) with the given name to the control. |
removeLayer( | this |
Remove the given layer from the control. |
expand() | this |
Expand the control container if collapsed. |
collapse() | this |
Collapse the control container if expanded. |
Method | Returns | Description |
---|---|---|
getPosition() | string |
Returns the position of the control. |
setPosition( | this |
Sets the position of the control. |
getContainer() | HTMLElement |
Returns the HTMLElement that contains the control. |
addTo( | this |
Adds the control to the given map. |
remove() | this |
Removes the control from the map it is currently active on. |
Control.Scale
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
.
Usage example
L.control.scale().addTo(map);
Creation
Factory | Description |
---|---|
L.control.scale( | Creates an scale control with the given options. |
Options
Option | Type | Default | Description |
---|---|---|---|
maxWidth | Number | 100 | Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500). |
metric | Boolean | True | Whether to show the metric scale line (m/km). |
imperial | Boolean | True | Whether to show the imperial scale line (mi/ft). |
updateWhenIdle | Boolean | false | If true , the control is updated on moveend , otherwise it's always up-to-date (updated on move ). |
Option | Type | Default | Description |
---|---|---|---|
position | String | 'topright' | The position of the control (one of the map corners). Possible values are 'topleft' , 'topright' , 'bottomleft' or 'bottomright'
|
Methods
Method | Returns | Description |
---|---|---|
getPosition() | string |
Returns the position of the control. |
setPosition( | this |
Sets the position of the control. |
getContainer() | HTMLElement |
Returns the HTMLElement that contains the control. |
addTo( | this |
Adds the control to the given map. |
remove() | this |
Removes the control from the map it is currently active on. |
Browser
A namespace with static properties for browser/feature detection used by Leaflet internally.
Usage example
if (L.Browser.ielt9) { alert('Upgrade your browser, dude!'); }
Properties
Property | Type | Description |
---|---|---|
ie | Boolean |
true for all Internet Explorer versions (not Edge). |
ielt9 | Boolean |
true for Internet Explorer versions less than 9. |
edge | Boolean |
true for the Edge web browser. |
webkit | Boolean |
true for webkit-based browsers like Chrome and Safari (including mobile versions). |
android | Boolean |
true for any browser running on an Android platform. |
android23 | Boolean |
true for browsers running on Android 2 or Android 3. |
androidStock | Boolean |
true for the Android stock browser (i.e. not Chrome) |
opera | Boolean |
true for the Opera browser |
chrome | Boolean |
true for the Chrome browser. |
gecko | Boolean |
true for gecko-based browsers like Firefox. |
safari | Boolean |
true for the Safari browser. |
opera12 | Boolean |
true for the Opera browser supporting CSS transforms (version 12 or later). |
win | Boolean |
true when the browser is running in a Windows platform |
ie3d | Boolean |
true for all Internet Explorer versions supporting CSS transforms. |
webkit3d | Boolean |
true for webkit-based browsers supporting CSS transforms. |
gecko3d | Boolean |
true for gecko-based browsers supporting CSS transforms. |
any3d | Boolean |
true for all browsers supporting CSS transforms. |
mobile | Boolean |
true for all browsers running in a mobile device. |
mobileWebkit | Boolean |
true for all webkit-based browsers in a mobile device. |
mobileWebkit3d | Boolean |
true for all webkit-based browsers in a mobile device supporting CSS transforms. |
msPointer | Boolean |
true for browsers implementing the Microsoft touch events model (notably IE10). |
pointer | Boolean |
true for all browsers supporting pointer events. |
touch | Boolean |
true for all browsers supporting touch events. This does not necessarily mean that the browser is running in a computer with a touchscreen, it only means that the browser is capable of understanding touch events. |
mobileOpera | Boolean |
true for the Opera browser in a mobile device. |
mobileGecko | Boolean |
true for gecko-based browsers running in a mobile device. |
retina | Boolean |
true for browsers on a high-resolution "retina" screen or on any screen when browser's display zoom is more than 100%. |
passiveEvents | Boolean |
true for browsers that support passive events. |
canvas | Boolean |
true when the browser supports <canvas> . |
svg | Boolean |
true when the browser supports SVG. |
vml | Boolean |
true if the browser supports VML. |
Util
Various utility functions, used by Leaflet internally.
Functions
Function | Returns | Description |
---|---|---|
extend( | Object | Merges the properties of the src object (or multiple objects) into dest object and returns the latter. Has an L.extend shortcut. |
create( | Object | Compatibility polyfill for Object.create |
bind( | Function | Returns a new function bound to the arguments passed, like Function.prototype.bind. Has a L.bind() shortcut. |
stamp( | Number | Returns the unique ID of an object, assigning it one if it doesn't have it. |
throttle( | Function | Returns a function which executes function fn with the given scope context (so that the this keyword refers to context inside fn 's code). The function fn will be called no more than one time per given amount of time . The arguments received by the bound function will be any arguments passed when binding the function, followed by any arguments passed when invoking the bound function. Has an L.throttle shortcut. |
wrapNum( | 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 . |
falseFn() | Function | Returns a function which always returns false . |
formatNum( | Number | Returns the number num rounded to digits decimals, or to 6 decimals by default. |
trim( | String | Compatibility polyfill for String.prototype.trim |
splitWords( | String[] | Trims and splits the string on whitespace and returns the array of parts. |
setOptions( | Object | Merges the given properties to the options of the obj object, returning the resulting options. See Class options . Has an L.setOptions shortcut. |
getParamString( | String | Converts an object into a parameter URL string, e.g. {a: "foo", b: "bar"} translates to '?a=foo&b=bar' . If existingUrl is set, the parameters will be appended at the end. If uppercase is true , the parameter names will be uppercased (e.g. '?A=foo&B=bar' ) |
template( | String | Simple templating facility, accepts a template string of the form 'Hello {a}, {b}' and a data object like {a: 'foo', b: 'bar'} , returns evaluated string ('Hello foo, bar') . You can also specify functions instead of strings for data values — they will be evaluated passing data as an argument. |
isArray(obj) | Boolean | Compatibility polyfill for Array.isArray |
indexOf( | Number | Compatibility polyfill for Array.prototype.indexOf |
requestAnimFrame( | Number | Schedules fn to be executed when the browser repaints. fn is bound to context if given. When immediate is set, fn is called immediately if the browser doesn't have native support for window.requestAnimationFrame , otherwise it's delayed. Returns a request ID that can be used to cancel the request. |
cancelAnimFrame( | undefined | Cancels a previous requestAnimFrame . See also window.cancelAnimationFrame. |
Properties
Property | Type | Description |
---|---|---|
lastId | Number | Last unique ID used by stamp()
|
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). |
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.
Usage example
var transformation = L.transformation(2, 5, -1, 10), p = L.point(1, 2), p2 = transformation.transform(p), // L.point(7, 8) p3 = transformation.untransform(p2); // L.point(1, 2)
Creation
Factory | Description |
---|---|
L.transformation( | Instantiates a Transformation object with the given coefficients. |
L.transformation( | Expects an coefficients array of the form [a: Number, b: Number, c: Number, d: Number] . |
Methods
Method | Returns | Description |
---|---|---|
transform( | Point |
Returns a transformed point, optionally multiplied by the given scale. Only accepts actual |
untransform( | Point |
Returns the reverse transformation of the given point, optionally divided by the given scale. Only accepts actual |
LineUtil
Various utility functions for polyline points processing, used by Leaflet internally to make polylines lightning-fast.
Functions
Function | Returns | Description |
---|---|---|
simplify( | 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. Used for a huge performance boost when processing/displaying Leaflet polylines for each zoom level and also reducing visual noise. tolerance affects the amount of simplification (lesser value means higher quality but slower and with more points). Also released as a separated micro-library Simplify.js. |
pointToSegmentDistance( | Number | Returns the distance between point p and segment p1 to p2 . |
closestPointOnSegment( | Number | Returns the closest point from a point p on a segment p1 to p2 . |
clipSegment( | Point[]|Boolean | Clips the segment a to b by rectangular bounds with the Cohen-Sutherland algorithm (modifying the segment points directly!). Used by Leaflet to only show polyline points that are on the screen or near, increasing performance. |
isFlat( | Boolean | Returns true if latlngs is a flat array, false is nested. |
PolyUtil
Various utility functions for polygon geometries.
Functions
Function | Returns | Description |
---|---|---|
clipPolygon( | Point[] | Clips the polygon geometry defined by the given points by the given bounds (using the Sutherland-Hodgman algorithm). Used by Leaflet to only show polygon points that are on the screen or near, increasing performance. Note that polygon points needs different algorithm for clipping than polyline, so there's a separate method for it. |
DomEvent
Utility functions to work with the DOM events, used by Leaflet internally.
Functions
Function | Returns | Description |
---|---|---|
on( | 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' ). |
on( | this | Adds a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}
|
off( | this | Removes a previously added listener function. Note that if you passed a custom context to on, you must pass the same context to off in order to remove the listener. |
off( | this | Removes a set of type/listener pairs, e.g. {click: onClick, mousemove: onMouseMove}
|
stopPropagation( | this | Stop the given event from propagation to parent elements. Used inside the listener functions: L.DomEvent.on(div, 'click', function (ev) { L.DomEvent.stopPropagation(ev); }); |
disableScrollPropagation( | this | Adds stopPropagation to the element's 'wheel' events (plus browser variants). |
disableClickPropagation( | this | Adds stopPropagation to the element's 'click' , 'doubleclick' , 'mousedown' and 'touchstart' events (plus browser variants). |
preventDefault( | this | Prevents the default action of the DOM Event ev from happening (such as following a link in the href of the a element, or doing a POST request with page reload when a <form> is submitted). Use it inside listener functions. |
stop( | this | Does stopPropagation and preventDefault at the same time. |
getMousePosition( | Point | Gets normalized mouse position from a DOM event relative to the container (border excluded) or to the whole page if not specified. |
getWheelDelta( | Number | Gets normalized wheel delta from a wheel DOM event, in vertical pixels scrolled (negative if scrolling down). Events from pointing devices without precise scrolling are mapped to a best guess of 60 pixels. |
addListener(…) | this | Alias to L.DomEvent.on
|
removeListener(…) | this | Alias to L.DomEvent.off
|
DomUtil
Utility functions to work with the DOM tree, used by Leaflet internally.
Most functions expecting or returning a HTMLElement
also work for SVG elements. The only difference is that classes refer to CSS classes in HTML and SVG classes in SVG.
Functions
Function | Returns | Description |
---|---|---|
get( | HTMLElement | Returns an element given its DOM id, or returns the element itself if it was passed directly. |
getStyle( | String | Returns the value for a certain style attribute on an element, including computed values or values set through CSS. |
create( | HTMLElement | Creates an HTML element with tagName , sets its class to className , and optionally appends it to container element. |
remove( | Removes el from its parent element | |
empty( | Removes all of el 's children elements from el
| |
toFront( | Makes el the last child of its parent, so it renders in front of the other children. | |
toBack( | Makes el the first child of its parent, so it renders behind the other children. | |
hasClass( | Boolean | Returns true if the element's class attribute contains name . |
addClass( | Adds name to the element's class attribute. | |
removeClass( | Removes name from the element's class attribute. | |
setClass( | Sets the element's class. | |
getClass( | String | Returns the element's class. |
setOpacity( | Set the opacity of an element (including old IE support). opacity must be a number from 0 to 1 . | |
testProp( | 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 . |
setTransform( | 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. | |
setPosition( | 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). | |
getPosition( | Point | Returns the coordinates of an element previously positioned with setPosition. |
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. | |
enableTextSelection() | Cancels the effects of a previous L.DomUtil.disableTextSelection . | |
disableImageDrag() | As L.DomUtil.disableTextSelection , but for dragstart DOM events, usually generated when the user drags an image. | |
enableImageDrag() | Cancels the effects of a previous L.DomUtil.disableImageDrag . | |
preventOutline( | Makes the outline of the element el invisible. Used internally by Leaflet to prevent focusable elements from displaying an outline when the user performs a drag interaction on them. | |
restoreOutline() | Cancels the effects of a previous L.DomUtil.preventOutline . | |
getSizedParentNode( | HTMLElement | Finds the closest parent node which size (width and height) is not null. |
getScale( | Object | Computes the CSS scale currently applied on the element. Returns an object with x and y members as horizontal and vertical scales respectively, and boundingClientRect as the result of getBoundingClientRect() . |
Properties
Property | Type | Description |
---|---|---|
TRANSFORM | String | Vendor-prefixed transform style name (e.g. 'webkitTransform' for WebKit). |
TRANSITION | String | Vendor-prefixed transition style name. |
TRANSITION_END | String | Vendor-prefixed transitionend event name. |
PosAnimation
Used internally for panning animations, utilizing CSS3 Transitions for modern browsers and a timer fallback for IE6-9.
Usage example
var fx = new L.PosAnimation(); fx.run(el, [300, 500], 0.5);
Constructor
Constructor | Description |
---|---|
L.PosAnimation() | Creates a PosAnimation object. |
Events
Event | Data | Description |
---|---|---|
start | Event | Fired when the animation starts |
step | Event | Fired continuously during the animation. |
end | Event | Fired when the animation ends. |
Methods
Method | Returns | Description |
---|---|---|
run( |
Run an animation of a given element to a new position, optionally setting duration in seconds ( | |
stop() |
Stops the animation (if currently running). |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Draggable
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
.
Usage example
var draggable = new L.Draggable(elementToDrag); draggable.enable();
Constructor
Constructor | Description |
---|---|
L.Draggable( | Creates a Draggable object for moving el when you start dragging the dragHandle element (equals el itself by default). |
Options
Option | Type | Default | Description |
---|---|---|---|
clickTolerance | Number | 3 | The max number of pixels a user can shift the mouse pointer during a click for it to be considered a valid click (as opposed to a mouse drag). |
Events
Event | Data | Description |
---|---|---|
down | Event | Fired when a drag is about to start. |
dragstart | Event | Fired when a drag starts |
predrag | Event | Fired continuously during dragging before each corresponding update of the element's position. |
drag | Event | Fired continuously during dragging. |
dragend | DragEndEvent | Fired when the drag ends. |
Methods
Method | Returns | Description |
---|---|---|
enable() |
Enables the dragging ability | |
disable() |
Disables the dragging ability |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
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.
Usage example
var MyClass = L.Class.extend({ initialize: function (greeter) { this.greeter = greeter; // class constructor }, greet: function (name) { alert(this.greeter + ', ' + name) } }); // create instance of MyClass, passing "Hello" to the constructor var a = new MyClass("Hello"); // call greet method, alerting "Hello, World" a.greet("World");
Class Factories
You may have noticed that Leaflet objects are created without using the new
keyword. This is achieved by complementing each class with a lowercase factory method:
new L.Map('map'); // becomes: L.map('map');
The factories are implemented very easily, and you can do this for your own classes:
L.map = function (id, options) { return new L.Map(id, options); };
Inheritance
You use L.Class.extend to define new classes, but you can use the same method on any class to inherit from it:
var MyChildClass = MyClass.extend({ // ... new properties and methods });
This will create a class that inherits all methods and properties of the parent class (through a proper prototype chain), adding or overriding the ones you pass to extend. It will also properly react to instanceof:
var a = new MyChildClass(); a instanceof MyChildClass; // true a instanceof MyClass; // true
You can call parent methods (including constructor) from corresponding child ones (as you do with super calls in other languages) by accessing parent class prototype and using JavaScript's call or apply:
var MyChildClass = MyClass.extend({ initialize: function () { MyClass.prototype.initialize.call(this, "Yo"); }, greet: function (name) { MyClass.prototype.greet.call(this, 'bro ' + name + '!'); } }); var a = new MyChildClass(); a.greet('Jason'); // alerts "Yo, bro Jason!"
Options
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 completely, which makes managing configuration of objects and default values convenient:
var MyClass = L.Class.extend({ options: { myOption1: 'foo', myOption2: 'bar' } }); var MyChildClass = MyClass.extend({ options: { myOption1: 'baz', myOption3: 5 } }); var a = new MyChildClass(); a.options.myOption1; // 'baz' a.options.myOption2; // 'bar' a.options.myOption3; // 5
There's also L.Util.setOptions
, a method for conveniently merging options passed to constructor with the defaults defines in the class:
var MyClass = L.Class.extend({ options: { foo: 'bar', bla: 5 }, initialize: function (options) { L.Util.setOptions(this, options); ... } }); var a = new MyClass({bla: 10}); a.options; // {foo: 'bar', bla: 10}
Note that the options object allows any keys, not just the options defined by the class and its base classes. This means you can use the options object to store application specific information, as long as you avoid keys that are already used by the class in question.
Includes
includes
is a special class property that merges all specified objects into the class (such objects are called mixins).
var MyMixin = { foo: function () { ... }, bar: 5 }; var MyClass = L.Class.extend({ includes: MyMixin }); var a = new MyClass(); a.foo();
You can also do such includes in runtime with the include
method:
MyClass.include(MyMixin);
statics
is just a convenience property that injects specified object properties as the static properties of the class, useful for defining constants:
var MyClass = L.Class.extend({ statics: { FOO: 'bar', BLA: 5 } }); MyClass.FOO; // 'bar'
Constructor hooks
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:
MyClass.addInitHook(function () { // ... do something in constructor additionally // e.g. add event listeners, set custom properties etc. });
You can also use the following shortcut when you just need to make one additional method call:
MyClass.addInitHook('methodName', arg1, arg2, …);
Functions
Function | Returns | Description |
---|---|---|
extend( | Function |
Extends the current class given the properties to be included. Returns a Javascript function that is a class constructor (to be called with new ). |
include( | this | Includes a mixin into the current class. |
mergeOptions( | this |
Merges options into the defaults of the class. |
addInitHook( | this | Adds a constructor hook to the class. |
Evented
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).
Usage example
map.on('click', function(e) { alert(e.latlng); } );
Leaflet deals with event listeners by reference, so if you want to add a listener and then remove it, define it as a function:
function onClick(e) { ... } map.on('click', onClick); map.off('click', onClick);
Methods
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Layer
A set of methods from the Layer base class that all Leaflet layers use. Inherits all methods, options and events from L.Evented
.
Usage example
var layer = L.marker(latlng).addTo(map); layer.addTo(map); layer.remove();
Options
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Popup events
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Tooltip events
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
L.Layer
will inherit the following methods:Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Extension methods
L.Layer
and (re-)implement the following methods.Method | Returns | Description |
---|---|---|
onAdd( | this |
Should contain code that creates DOM elements for the layer, adds them to |
onRemove( | this |
Should contain all clean up code that removes the layer's elements from the DOM and removes listeners previously added in |
getEvents() | Object |
This optional method should return an object like |
getAttribution() | String |
This optional method should return a string containing HTML to be shown on the |
beforeAdd( | this |
Optional method. Called on |
Popup methods
var layer = L.Polygon(latlngs).bindPopup('Hi There!').addTo(map); layer.openPopup(); layer.closePopup();
Popups will also be automatically opened when the layer is clicked on and closed when the layer is removed from the map or another popup is opened.
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Tooltip methods
var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map); layer.openTooltip(); layer.closeTooltip();
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Interactive layer
Some Layer
s can be made interactive - when the user interacts with such a layer, mouse events like click
and mouseover
can be handled. Use the event handling methods to handle these events.
Options
Option | Type | Default | Description |
---|---|---|---|
interactive | Boolean | true | If false , the layer will not emit mouse events and will act as a part of the underlying map. |
bubblingMouseEvents | Boolean | true | When true , a mouse event on this layer will trigger the same event on the map (unless L.DomEvent.stopPropagation is used). |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Mouse events
Event | Data | Description |
---|---|---|
click | MouseEvent | Fired when the user clicks (or taps) the layer. |
dblclick | MouseEvent | Fired when the user double-clicks (or double-taps) the layer. |
mousedown | MouseEvent | Fired when the user pushes the mouse button on the layer. |
mouseup | MouseEvent | Fired when the user releases the mouse button pushed on the layer. |
mouseover | MouseEvent | Fired when the mouse enters the layer. |
mouseout | MouseEvent | Fired when the mouse leaves the layer. |
contextmenu | MouseEvent | Fired when the user right-clicks on the layer, 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 | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Control
L.Control is a base class for implementing map controls. Handles positioning. All other controls extend from this class.
Options
Option | Type | Default | Description |
---|---|---|---|
position | String | 'topright' | The position of the control (one of the map corners). Possible values are 'topleft' , 'topright' , 'bottomleft' or 'bottomright'
|
Methods
Method | Returns | Description |
---|---|---|
getPosition() | string |
Returns the position of the control. |
setPosition( | this |
Sets the position of the control. |
getContainer() | HTMLElement |
Returns the HTMLElement that contains the control. |
addTo( | this |
Adds the control to the given map. |
remove() | this |
Removes the control from the map it is currently active on. |
Extension methods
L.Control
and (re-)implement the following methods.Method | Returns | Description |
---|---|---|
onAdd( | HTMLElement |
Should return the container DOM element for the control and add listeners on relevant map events. Called on |
onRemove( |
Optional method. Should contain all clean up code that removes the listeners previously added in |
Handler
Abstract class for map interaction handlers
Methods
Method | Returns | Description |
---|---|---|
enable() | this |
Enables the handler |
disable() | this |
Disables the handler |
enabled() | Boolean |
Returns |
Extension methods
Handler
must implement the two following methods:Method | Returns | Description |
---|---|---|
addHooks() |
Called when the handler is enabled, should add event hooks. | |
removeHooks() |
Called when the handler is disabled, should remove the event hooks added previously. |
Functions
There is static function which can be called without instantiating L.Handler:
Function | Returns | Description |
---|---|---|
addTo( | this | Adds a new Handler to the given map with the given name. |
Projection
An object with methods for projecting geographical coordinates of the world onto a flat surface (and back). See Map projection.
Methods
Method | Returns | Description |
---|---|---|
project( | Point |
Projects geographical coordinates into a 2D point. Only accepts actual |
unproject( | LatLng |
The inverse of Note that the projection instances do not inherit from Leaflet's |
Properties
Property | Type | Description |
---|---|---|
bounds | Bounds | The bounds (specified in CRS units) where the projection is valid |
Defined projections
Projection | Description |
---|---|
L.Projection.LonLat | Equirectangular, or Plate Carree projection — the most simple projection, mostly used by GIS enthusiasts. Directly maps x as longitude, and y as latitude. Also suitable for flat worlds, e.g. game maps. Used by the EPSG:4326 and Simple CRS. |
L.Projection.Mercator | Elliptical Mercator projection — more complex than Spherical Mercator. Assumes that Earth is an ellipsoid. Used by the EPSG:3395 CRS. |
L.Projection.SphericalMercator | Spherical Mercator projection — the most common projection for online maps, used by almost all free and commercial tile providers. Assumes that Earth is a sphere. Used by the EPSG:3857 CRS. |
CRS
Methods
Method | Returns | Description |
---|---|---|
latLngToPoint( | Point |
Projects geographical coordinates into pixel coordinates for a given zoom. |
pointToLatLng( | LatLng |
The inverse of |
project( | Point |
Projects geographical coordinates into coordinates in units accepted for this CRS (e.g. meters for EPSG:3857, for passing it to WMS services). |
unproject( | LatLng |
Given a projected coordinate returns the corresponding LatLng. The inverse of |
scale( | Number |
Returns the scale used when transforming projected coordinates into pixel coordinates for a particular zoom. For example, it returns |
zoom( | Number |
Inverse of |
getProjectedBounds( | Bounds |
Returns the projection's bounds scaled and transformed for the provided |
distance( | Number |
Returns the distance between two geographical coordinates. |
wrapLatLng( | LatLng |
Returns a |
wrapLatLngBounds( | LatLngBounds |
Returns a |
Properties
Property | Type | Description |
---|---|---|
code | String | Standard code name of the CRS passed into WMS services (e.g. 'EPSG:3857' ) |
wrapLng | Number[] | An array of two numbers defining whether the longitude (horizontal) coordinate axis wraps around a given range and how. Defaults to [-180, 180] in most geographical CRSs. If undefined , the longitude axis does not wrap around. |
wrapLat | Number[] | Like wrapLng , but for the latitude (vertical) axis. |
infinite | Boolean | If true, the coordinate space will be unbounded (infinite in both axes) |
Defined CRSs
CRS | Description |
---|---|
L.CRS.EPSG3395 | Rarely used by some commercial tile providers. Uses Elliptical Mercator projection. |
L.CRS.EPSG3857 | The most common CRS for online maps, used by almost all free and commercial tile providers. Uses Spherical Mercator projection. Set in by default in Map's crs option. |
L.CRS.EPSG4326 | A common CRS among GIS enthusiasts. Uses simple Equirectangular projection. Leaflet 1.0.x complies with the TMS coordinate scheme for EPSG:4326, which is a breaking change from 0.7.x behaviour. If you are using a |
L.CRS.Earth | Serves as the base for CRS that are global such that they cover the earth. Can only be used as the base for other CRS and cannot be used directly, since it does not have a code , projection or transformation . distance() returns meters. |
L.CRS.Simple | A simple CRS that maps longitude and latitude into x and y directly. May be used for maps of flat surfaces (e.g. game maps). Note that the y axis should still be inverted (going from bottom to top). distance() returns simple euclidean distance. |
L.CRS.Base | Object 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 spatial reference system. Leaflet defines the most usual CRSs by default. If you want to use a CRS not defined by default, take a look at the Proj4Leaflet plugin. Note that the CRS instances do not inherit from Leaflet's |
Renderer
Base class for vector renderer implementations (SVG
, Canvas
). Handles the DOM container of the renderer, its bounds, and its zoom animation.
A Renderer
works as an implicit layer group for all Path
s - the renderer itself can be added or removed to the map. All paths use a renderer, which can be implicit (the map will decide the type of renderer and use it automatically) or explicit (using the renderer
option of the path).
Do not use this class directly, use SVG
and Canvas
instead.
Options
Option | Type | Default | Description |
---|---|---|---|
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 |
tolerance | Number | 0 | How much to extend click tolerance round a path/object on the map |
Option | Type | Default | Description |
---|---|---|---|
pane | String | 'overlayPane' | By default the layer will be added to the map's overlay pane. Overriding this option will cause the layer to be placed on another pane by default. |
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
update | Event | Fired when the renderer updates its bounds, center and zoom, for example when its map has moved |
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Event objects
Whenever a class inheriting from Evented
fires an event, a listener function will be called with an event argument, which is a plain object containing information about the event. For example:
map.on('click', function(ev) { alert(ev.latlng); // ev is an event object (MouseEvent in this case) });
The information available depends on the event type:
Event
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
KeyboardEvent
Property | Type | Description |
---|---|---|
originalEvent | DOMEvent | The original DOM KeyboardEvent that triggered this Leaflet event. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
MouseEvent
Property | Type | Description |
---|---|---|
latlng | LatLng | The geographical point where the mouse event occurred. |
layerPoint | Point | Pixel coordinates of the point where the mouse event occurred relative to the map layer. |
containerPoint | Point | Pixel coordinates of the point where the mouse event occurred relative to the map сontainer. |
originalEvent | DOMEvent | The original DOM MouseEvent or DOM TouchEvent that triggered this Leaflet event. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
LocationEvent
Property | Type | Description |
---|---|---|
latlng | LatLng | Detected geographical location of the user. |
bounds | LatLngBounds | Geographical bounds of the area user is located in (with respect to the accuracy of location). |
accuracy | Number | Accuracy of location in meters. |
altitude | Number | Height of the position above the WGS84 ellipsoid in meters. |
altitudeAccuracy | Number | Accuracy of altitude in meters. |
heading | Number | The direction of travel in degrees counting clockwise from true North. |
speed | Number | Current velocity in meters per second. |
timestamp | Number | The time when the position was acquired. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
ErrorEvent
Property | Type | Description |
---|---|---|
message | String | Error message. |
code | Number | Error code (if applicable). |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
LayerEvent
Property | Type | Description |
---|---|---|
layer | Layer | The layer that was added or removed. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
LayersControlEvent
Property | Type | Description |
---|---|---|
layer | Layer | The layer that was added or removed. |
name | String | The name of the layer that was added or removed. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
TileEvent
Property | Type | Description |
---|---|---|
tile | HTMLElement | The tile element (image). |
coords | Point | Point object with the tile's x , y , and z (zoom level) coordinates. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
TileErrorEvent
Property | Type | Description |
---|---|---|
tile | HTMLElement | The tile element (image). |
coords | Point | Point object with the tile's x , y , and z (zoom level) coordinates. |
error | * | Error passed to the tile's done() callback. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
ResizeEvent
Property | Type | Description |
---|---|---|
oldSize | Point | The old size before resize event. |
newSize | Point | The new size after the resize event. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
GeoJSONEvent
Property | Type | Description |
---|---|---|
layer | Layer | The layer for the GeoJSON feature that is being added to the map. |
properties | Object | GeoJSON properties of the feature. |
geometryType | String | GeoJSON geometry type of the feature. |
id | String | GeoJSON ID of the feature (if present). |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
PopupEvent
Property | Type | Description |
---|---|---|
popup | Popup | The popup that was opened or closed. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
TooltipEvent
Property | Type | Description |
---|---|---|
tooltip | Tooltip | The tooltip that was opened or closed. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
DragEndEvent
Property | Type | Description |
---|---|---|
distance | Number | The distance in pixels the draggable element was moved by. |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
ZoomAnimEvent
Property | Type | Description |
---|---|---|
center | LatLng | The current center of the map |
zoom | Number | The current zoom level of the map |
noUpdate | Boolean | Whether layers should update their contents due to this event |
Property | Type | Description |
---|---|---|
type | String | The event type (e.g. 'click' ). |
target | Object | The object that fired the event. For propagated events, the last object in the propagation chain that fired the event. |
sourceTarget | Object | The object that originally fired the event. For non-propagated events, this will be the same as the target . |
propagatedFrom | Object | For propagated events, the last object that propagated the event to its event parent. |
layer | Object |
Deprecated. The same as propagatedFrom . |
DivOverlay
Base model for L.Popup and L.Tooltip. Inherit from it for custom popup like plugins.
Options
Option | Type | Default | Description |
---|---|---|---|
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. |
className | String | '' | A custom CSS class name to assign to the popup. |
pane | String | 'popupPane' |
Map pane where the popup will be added. |
Option | Type | Default | Description |
---|---|---|---|
attribution | String | null | String to be shown in the attribution control, e.g. "© OpenStreetMap contributors". It describes the layer data and is often a legal obligation towards copyright holders and tile providers. |
Events
Event | Data | Description |
---|---|---|
add | Event | Fired after the layer is added to a map |
remove | Event | Fired after the layer is removed from a map |
Event | Data | Description |
---|---|---|
popupopen | PopupEvent | Fired when a popup bound to this layer is opened |
popupclose | PopupEvent | Fired when a popup bound to this layer is closed |
Event | Data | Description |
---|---|---|
tooltipopen | TooltipEvent | Fired when a tooltip bound to this layer is opened. |
tooltipclose | TooltipEvent | Fired when a tooltip bound to this layer is closed. |
Methods
Method | Returns | Description |
---|---|---|
addTo( | this |
Adds the layer to the given map or layer group. |
remove() | this |
Removes the layer from the map it is currently active on. |
removeFrom( | this |
Removes the layer from the given map |
removeFrom( | this |
Removes the layer from the given |
getPane( | HTMLElement |
Returns the |
getAttribution() | String |
Used by the |
Method | Returns | Description |
---|---|---|
bindPopup( | this |
Binds a popup to the layer with the passed |
unbindPopup() | this |
Removes the popup previously bound with |
openPopup( | this |
Opens the bound popup at the specified |
closePopup() | this |
Closes the popup bound to this layer if it is open. |
togglePopup() | this |
Opens or closes the popup bound to this layer depending on its current state. |
isPopupOpen() | boolean |
Returns |
setPopupContent( | this |
Sets the content of the popup bound to this layer. |
getPopup() | Popup |
Returns the popup bound to this layer. |
Method | Returns | Description |
---|---|---|
bindTooltip( | this |
Binds a tooltip to the layer with the passed |
unbindTooltip() | this |
Removes the tooltip previously bound with |
openTooltip( | this |
Opens the bound tooltip at the specified |
closeTooltip() | this |
Closes the tooltip bound to this layer if it is open. |
toggleTooltip() | this |
Opens or closes the tooltip bound to this layer depending on its current state. |
isTooltipOpen() | boolean |
Returns |
setTooltipContent( | this |
Sets the content of the tooltip bound to this layer. |
getTooltip() | Tooltip |
Returns the tooltip bound to this layer. |
Method | Returns | Description |
---|---|---|
on( | this |
Adds a listener function ( |
on( | this |
Adds a set of type/listener pairs, e.g. |
off( | 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 |
off( | this |
Removes a set of type/listener pairs. |
off() | this |
Removes all listeners to all events on the object. This includes implicitly attached events. |
fire( | 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 can optionally be propagated to event parents. |
listens( | Boolean |
Returns |
once(…) | this |
Behaves as |
addEventParent( | this |
Adds an event parent - an |
removeEventParent( | this |
Removes an event parent, so it will stop receiving propagated events |
addEventListener(…) | this |
Alias to |
removeEventListener(…) | this |
Alias to |
clearAllEventListeners(…) | this |
Alias to |
addOneTimeEventListener(…) | this |
Alias to |
fireEvent(…) | this |
Alias to |
hasEventListeners(…) | Boolean |
Alias to |
Global Switches
Global switches are created for rare cases and generally make Leaflet to not detect a particular browser feature even if it's there. You need to set the switch as a global variable to true before including Leaflet on the page, like this:
<script>L_NO_TOUCH = true;</script> <script src="leaflet.js"></script>
Switch | Description |
---|---|
L_NO_TOUCH | Forces Leaflet to not use touch events even if it detects them. |
L_DISABLE_3D | Forces Leaflet to not use hardware-accelerated CSS 3D transforms for positioning (which may cause glitches in some rare environments) even if they're supported. |
noConflict
This method restores the L
global variable to the original value it had before Leaflet inclusion, and returns the real Leaflet namespace so you can put it elsewhere, like this:
<script src='libs/l.js'> <!-- L points to some other library --> <script src='leaflet.js'> <!-- you include Leaflet, it replaces the L variable to Leaflet namespace --> <script> var Leaflet = L.noConflict(); // now L points to that other library again, and you can use Leaflet.Map etc. </script>
version
A constant that represents the Leaflet version in use.
L.version; // contains "1.0.0" (or whatever version is currently in use)
© 2010–2019 Vladimir Agafonkin
© 2010–2011, CloudMade
Maps © OpenStreetMap contributors.
https://leafletjs.com/reference-1.7.1.html
map.getPane
ormap.getPanes
methods. New panes can be created with themap.createPane
method.Every map has the following default panes that differ only in zIndex.