This reference reflects Leaflet 1.0.0.
- -Docs for the legacy 0.7.x versions are available here. - -
-The central class of the API — it is used to create a map on a page and manipulate it.
- -// 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
-});
-| 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. |
-
| Option | -Type | -Default | -Description | -
|---|---|---|---|
preferCanvas |
-
-Boolean
- |
-false |
- Whether Paths should be rendered on a Canvas renderer.
-By default, all Paths are rendered in a SVG renderer. |
-
| 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. | -
| 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. | -
| 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
- |
-undefined |
- Minimum zoom level of the map. Overrides any minZoom option set on map layers. |
-
maxZoom |
-
-Number
- |
-undefined |
- Maximum zoom level of the map. Overrides any maxZoom option set on map layers. |
-
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 when he 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. |
-
| Option | -Type | -Default | -Description | -
|---|---|---|---|
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. |
-
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. | -
| 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. |
-
| 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. | -
| 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). | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
baselayerchange
- |
-||
overlayadd
- |
-||
overlayremove
- |
-||
layeradd
- |
-||
layerremove
- |
-
| Event | -Data | -Description | -
|---|---|---|
zoomlevelschange
- |
-||
resize
- |
-||
unload
- |
-||
viewreset
- |
-||
load
- |
-||
zoomstart
- |
-||
movestart
- |
-||
zoom
- |
-||
move
- |
-||
zoomend
- |
-||
moveend
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-||
autopanstart
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseup
- |
-||
mouseover
- |
-||
mouseout
- |
-||
mousemove
- |
-||
contextmenu
- |
-||
keypress
- |
-||
preclick
- |
-
| Event | -Data | -Description | -
|---|---|---|
zoomanim
- |
-
| Event | -Data | -Description | -
|---|---|---|
locationerror
- |
-||
locationfound
- |
-
| Method | -Returns | -Description | -
|---|---|---|
getRenderer( |
- Renderer |
-
- Returns the instance of |
-
| 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. - |
-
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. - |
-
| 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). - |
-
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. - |
-
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 |
-
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 |
-
| 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 children 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 |
-
| 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 |
-
| 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 |
-
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( |
- Point |
-
- 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 | -
|---|---|---|
locate( |
- this |
-
- Tries to locate the user using the Geolocation API, firing a |
-
stopLocate() |
- this |
-
- Stops watching location previously initiated by |
-
| 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. - |
-
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 might 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 |
-
| Property | -Type | -Description | -
|---|---|---|
boxZoom
- |
-||
doubleClickZoom
- |
-||
dragging
- |
-||
keyboard
- |
-||
scrollWheelZoom
- |
-||
tap
- |
-||
touchZoom
- |
-
| Pane | -Type | -Z-index | -Description | -
|---|---|---|---|
mapPane |
-
-HTMLElement
- |
-'auto' |
- Pane that contains all other map panes | -
tilePane |
-
-HTMLElement
- |
-200 |
- Pane for GridLayers and TileLayers |
-
overlayPane |
-
-HTMLElement
- |
-400 |
- Pane for vector overlays (Paths), like Polylines and Polygons |
-
shadowPane |
-
-HTMLElement
- |
-500 |
- Pane for overlay shadows (e.g. Marker shadows) |
-
markerPane |
-
-HTMLElement
- |
-600 |
- Pane for Icons of Markers |
-
tooltipPane |
-
-HTMLElement
- |
-650 |
- Pane for tooltip. | -
popupPane |
-
-HTMLElement
- |
-700 |
- Pane for Popups. |
-
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 continous 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. | -
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. |
-
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, -the less the more bowed the curve. | -
noMoveStart |
-
-Boolean
- |
-false |
- If true, panning won't fire movestart event on start (used internally for
-panning inertia). |
-
| 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, -the less the more bowed the curve. | -
noMoveStart |
-
-Boolean
- |
-false |
- If true, panning won't fire movestart event on start (used internally for
-panning inertia). |
-
| 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, -the less the more bowed the curve. | -
noMoveStart |
-
-Boolean
- |
-false |
- If true, panning won't fire movestart event on start (used internally for
-panning inertia). |
-
L.Marker is used to display clickable/draggable icons on the map. Extends Layer.
L.marker([50.5, 30.5]).addTo(map);
-| Factory | -Description | -
|---|---|
L.marker( |
- Instantiates a Marker object given a geographical point and optionally an options object. | -
| Option | -Type | -Default | -Description | -
|---|---|---|---|
icon |
-
-Icon
- |
-* |
- Icon class to use for rendering the marker. See Icon documentation for details on how to customize the marker icon. If not specified, a new L.Icon.Default is used. |
-
draggable |
-
-Boolean
- |
-false |
- Whether the marker is draggable with mouse/touch or not. | -
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. |
-
| 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. |
-
| Event | -Data | -Description | -
|---|---|---|
move
- |
-
| Event | -Data | -Description | -
|---|---|---|
dragstart
- |
-||
movestart
- |
-||
drag
- |
-||
dragend
- |
-||
moveend
- |
-
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
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. - |
-
setIcon( |
- this |
-
- Changes the marker icon. - |
-
setOpacity( |
- this |
-
- Changes the opacity of the marker. - |
-
| 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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Handler methods). Example:
-marker.dragging.disable();
-| Property | -Type | -Description | -
|---|---|---|
dragging
- |
-
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.
- -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);
-| 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. |
-
| 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 user clicks the map (set globally by
-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. |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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 |
-
- Alias for getContent() - |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Used to display small texts on top of map layers.
- -marker.bindTooltip("my tooltip text").openTooltip();
-Note about tooltip offset. Leaflet takes two options in consideration -for computing tooltip offseting:
-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.tooltipAnchor Icon option: this will only be considered for Marker. You
-should adapt this value if you use a custom icon.| 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. |
-
| 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 dynamicaly 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. | -
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Used to load and display tile layers on the map. Extends GridLayer.
L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);
-A string of the following form:
-'http://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
-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'});
-| Factory | -Description | -
|---|---|
L.tilelayer( |
- Instantiates a tile layer object given a URL template and optionally an options object. |
-
| Option | -Type | -Default | -Description | -
|---|---|---|---|
minZoom |
-
-Number
- |
-0 |
- Minimum zoom number. | -
maxZoom |
-
-Number
- |
-18 |
- Maximum zoom number. | -
maxNativeZoom |
-
-Number
- |
-null |
- Maximum zoom number the tile source has available. If it is specified,
-the tiles on all zoom levels higher than maxNativeZoom will be loaded
-from maxNativeZoom level and auto-scaled. |
-
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
- |
-false |
- If true, all tiles will have their crossOrigin attribute set to ''. This is needed if you want to access tile pixel data. | -
| 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 |
- If false, new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile browsers, otherwise false. |
-
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. |
-
attribution |
-
-String
- |
-null |
- String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox". | -
zIndex |
-
-Number
- |
-1 |
- The explicit zIndex of the tile layer. | -
bounds |
-
-LatLngBounds
- |
-undefined |
- If set, tiles will only be loaded inside the set LatLngBounds. |
-
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. |
-
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. | -
| Event | -Data | -Description | -
|---|---|---|
loading
- |
-||
tileunload
- |
-||
tileloadstart
- |
-||
tileerror
- |
-||
tileload
- |
-||
load
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
setUrl( |
- this |
-
- Updates the layer's URL template and redraws it (unless |
-
createTile( |
- HTMLElement |
-
- Called only internally, overrides GridLayer's |
-
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. - |
-
getAttribution() |
- String |
-
- Used by the |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Used to display WMS services as tile layers on the map. Extends TileLayer.
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"
-});
-| 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. | -
| 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 |
- Minimum zoom number. | -
maxZoom |
-
-Number
- |
-18 |
- Maximum zoom number. | -
maxNativeZoom |
-
-Number
- |
-null |
- Maximum zoom number the tile source has available. If it is specified,
-the tiles on all zoom levels higher than maxNativeZoom will be loaded
-from maxNativeZoom level and auto-scaled. |
-
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
- |
-false |
- If true, all tiles will have their crossOrigin attribute set to ''. This is needed if you want to access tile pixel data. | -
| 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 |
- If false, new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile browsers, otherwise false. |
-
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. |
-
attribution |
-
-String
- |
-null |
- String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox". | -
zIndex |
-
-Number
- |
-1 |
- The explicit zIndex of the tile layer. | -
bounds |
-
-LatLngBounds
- |
-undefined |
- If set, tiles will only be loaded inside the set LatLngBounds. |
-
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. |
-
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. | -
| Event | -Data | -Description | -
|---|---|---|
loading
- |
-||
tileunload
- |
-||
tileloadstart
- |
-||
tileerror
- |
-||
tileload
- |
-||
load
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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. - |
-
getAttribution() |
- String |
-
- Used by the |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Used to load and display a single image over specific bounds of the map. Extends Layer.
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);
-| Factory | -Description | -
|---|---|
L.imageOverlay( |
- Instantiates an image overlay object given the URL of the image and the -geographical bounds it is tied to. | -
| 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. |
-
attribution |
-
-String
- |
-null |
- An optional string containing HTML to be shown on the Attribution control
- |
-
crossOrigin |
-
-Boolean
- |
-false |
- If true, the image will have its crossOrigin attribute set to ''. This is needed if you want to access image pixel data. | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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. - |
-
| 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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
An abstract class that contains options and constants shared between vector
-overlays (Polygon, Polyline, Circle). Do not use it directly. Extends Layer.
| 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. | -
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. | -
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
A class for drawing polyline overlays on a map. Extends Path.
// create a red polyline from an array of LatLng points
-var latlngs = [
- [-122.68, 45.51],
- [-122.43, 37.77],
- [-118.2, 34.04]
-];
-var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
-// zoom the map to the polyline
-map.fitBounds(polyline.getBounds());
-You can also pass a multi-dimensional array to represent a MultiPolyline shape:
// create a red polyline from an array of arrays of LatLng points
-var latlngs = [
- [[-122.68, 45.51],
- [-122.43, 37.77],
- [-118.2, 34.04]],
- [[-73.91, 40.78],
- [-87.62, 41.83],
- [-96.72, 32.76]]
-];
-| 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. |
-
| 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. | -
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. | -
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
toGeoJSON() |
- Object |
-
- Returns a |
-
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 |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
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.
// create a red polygon from an array of LatLng points
-var latlngs = [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]];
-var polygon = L.polygon(latlngs, {color: 'red'}).addTo(map);
-// zoom the map to the polygon
-map.fitBounds(polygon.getBounds());
-You can also pass an array of arrays of latlngs, with the first array representing the outer shape and the other arrays representing holes in the outer shape:
-var latlngs = [
- [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]], // outer ring
- [[-108.58,37.29],[-108.58,40.71],[-102.50,40.71],[-102.50,37.29]] // hole
-];
-Additionally, you can pass a multi-dimensional array to represent a MultiPolygon shape.
-var latlngs = [
- [ // first polygon
- [[-111.03, 41],[-111.04, 45],[-104.05, 45],[-104.05, 41]], // outer ring
- [[-108.58,37.29],[-108.58,40.71],[-102.50,40.71],[-102.50,37.29]] // hole
- ],
- [ // second polygon
- [[-109.05, 37],[-109.03, 41],[-102.05, 41],[-102.04, 37],[-109.05, 38]]
- ]
-];
-| Factory | -Description | -
|---|---|
L.polygon( |
- - |
| 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. | -
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. | -
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
toGeoJSON() |
- Object |
-
- Returns a |
-
| 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 |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
A class for drawing rectangle overlays on a map. Extends Polygon.
// 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);
-| Factory | -Description | -
|---|---|
L.rectangle( |
- - |
| 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. | -
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. | -
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
setBounds( |
- this |
-
- Redraws the rectangle with the passed bounds. - |
-
| 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 |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
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).
L.circle([50.5, 30.5], 200).addTo(map);
-| 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. | -
| 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. | -
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. | -
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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 |
-
- Returns a |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
A circle of a fixed size with radius specified in pixels. Extends Path.
| Factory | -Description | -
|---|---|
L.circleMarker( |
- Instantiates a circle marker object given a geographical point, and an optional options object. | -
| 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. | -
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. | -
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
toGeoJSON() |
- Object |
-
- Returns a |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Although SVG is not available on IE7 and IE8, these browsers support VML, and the SVG renderer will fall back to VML in this case. -VML was deprecated in 2012, which means VML functionality exists only for backwards compatibility -with old versions of Internet Explorer.
-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.
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 } );
-| Factory | -Description | -
|---|---|
L.svg( |
- Creates a SVG renderer with the given 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 | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
update
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
| 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 | -
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.
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 } );
-| Factory | -Description | -
|---|---|
L.canvas( |
- Creates a Canvas renderer with the given 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 | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
update
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
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.
L.layerGroup([marker1, marker2])
- .addLayer(polyline)
- .addTo(map);
-| Factory | -Description | -
|---|---|
L.layerGroup( |
- Create a layer group, optionally given an initial set of layers. | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
toGeoJSON() |
- Object |
-
- Returns a |
-
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 |
-
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. - |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
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 with bindTooltip)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.layeradd and layerremove eventsL.featureGroup([marker1, marker2, polyline])
- .bindPopup('Hello world!')
- .on('click', function() { alert('Clicked on a member of the group!'); })
- .addTo(map);
-| Factory | -Description | -
|---|---|
L.featureGroup( |
- Create a feature group, optionally given an initial set of layers. | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
layeradd
- |
-||
layerremove
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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 top 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 |
-
- Returns a |
-
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 |
-
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. - |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Represents a GeoJSON object or an array of GeoJSON objects. Allows you to parse
-GeoJSON data and display it on the map. Extends FeatureGroup.
L.geoJSON(data, {
- style: function (feature) {
- return {color: feature.properties.color};
- }
-}).bindPopup(function (layer) {
- return layer.feature.properties.description;
-}).addTo(map);
-| 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. |
-
| 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:
- |
-
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:
- |
-
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:
- |
-
filter |
-
-Function
- |
-* |
- A Function that will be used to decide whether to show a feature or not.
-The default is to show all features:
- |
-
coordsToLatLng |
-
-Function
- |
-* |
- A Function that will be used for converting GeoJSON coordinates to LatLngs.
-The default is the coordsToLatLng static method. |
-
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
layeradd
- |
-||
layerremove
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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 top 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 |
-
- Returns a |
-
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 |
-
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. - |
-
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 | -
|---|---|---|
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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
| Function | -Returns | -Description | -
|---|---|---|
addData(data) |
- Layer |
- Adds a GeoJSON object to the layer. | -
resetStyle(layer) |
- Layer |
- Resets the given vector layer's style to the original GeoJSON style, useful for resetting style after hover events. | -
setStyle(style) |
- Layer |
- Changes styles of GeoJSON vector layers with the given style function. | -
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 LatLngs 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. | -
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.
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;
- }
-});
-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;
- }
-});
-| Factory | -Description | -
|---|---|
L.gridLayer( |
- Creates a new instance of GridLayer with the supplied 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 |
- If false, new tiles are loaded during panning, otherwise only after it (for better performance). true by default on mobile browsers, otherwise false. |
-
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. |
-
attribution |
-
-String
- |
-null |
- String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox". | -
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 that tiles will be loaded at. By default the entire map. | -
maxZoom |
-
-Number
- |
-undefined |
- The maximum zoom level that tiles will be loaded at. | -
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. |
-
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. | -
| Event | -Data | -Description | -
|---|---|---|
loading
- |
-||
tileunload
- |
-||
tileloadstart
- |
-||
tileerror
- |
-||
tileload
- |
-||
load
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| 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. - |
-
getAttribution() |
- String |
-
- Used by the |
-
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 |
-
GridLayer shall reimplement the following method.| Method | -Returns | -Description | -
|---|---|---|
createTile( |
- HTMLElement |
-
- Called only internally, must be overriden by classes extending |
-
| 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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Represents a geographical point with a certain latitude and longitude.
- -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));
-| 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. |
-
| 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 |
-
| Property | -Type | -Description | -
|---|---|---|
lat
- |
-||
lng
- |
-||
alt
- |
-
Represents a rectangular geographical area on a map.
- -var southWest = L.latLng(40.712, -74.227),
-northEast = L.latLng(40.774, -74.125),
-bounds = L.latLngBounds(southWest, northEast);
-All Leaflet methods that accept LatLngBounds objects also accept them in a simple Array form (unless noted otherwise), so the bounds example above can be passed like this:
-map.fitBounds([
- [40.712, -74.227],
- [40.774, -74.125]
-]);
-| Factory | -Description | -
|---|---|
L.latLngBounds( |
- Creates a LatLngBounds object by defining south-west and north-east 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. |
-
| 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 bigger bounds created by extending the current bounds by a given percentage in each direction. - |
-
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 |
-
Represents a point with x and y coordinates in pixels.
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));
-| 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. |
-
| 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). - |
-
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. - |
-
Represents a rectangular area in pixel coordinates.
- -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]]);
-| Factory | -Description | -
|---|---|
L.bounds( |
- Creates a Bounds object from two coordinates (usually top-left and bottom-right corners). | -
L.bounds( |
- Creates a Bounds object from the points it contains | -
| 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. - |
-
getSize() |
- Point |
-
- Returns the size of the given bounds - |
-
contains( |
- Boolean |
-
- Returns |
-
contains( |
- Boolean |
-
- Returns |
-
intersects( |
- Boolean |
-
- Returns |
-
overlaps( |
- Boolean |
-
- Returns |
-
| Property | -Type | -Description | -
|---|---|---|
min
- |
-||
max
- |
-
Represents an icon to provide when creating a marker.
- -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.
| Factory | -Description | -
|---|---|
L.icon( |
- Creates an icon instance with the given 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
- |
-null |
- The coordinates of the point from which popups 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. | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
createIcon( |
- HTMLElement |
-
- Called internally when the icon has to be shown, returns a |
-
createShadow( |
- HTMLElement |
-
- As |
-
| 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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
Icon, represents the icon to use in Markers when
-no icon is specified. Points to the blue marker image distributed with Leaflet
-releases.
-In order to change the default icon, just change the properties of L.Icon.Default.prototype.options
-(which is a set of Icon options).| Option | -Type | -Default | -Description | -
|---|---|---|---|
imagePath |
-
-String
- |
- |
-
-L.Icon.Default will try to auto-detect the absolute location of the
-blue icon images. If you are placing these images in a non-standard
-way, set this option to point to the right absolute path. |
-
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.
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.
- - - -| Factory | -Description | -
|---|---|
L.divIcon( |
- Creates a DivIcon instance with the given options. |
-
| Option | -Type | -Default | -Description | -
|---|---|---|---|
html |
-
-String
- |
-'' |
- Custom HTML code to put inside the div element, empty by default. | -
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
- |
-null |
- The coordinates of the point from which popups 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. | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
createIcon( |
- HTMLElement |
-
- Called internally when the icon has to be shown, returns a |
-
createShadow( |
- HTMLElement |
-
- As |
-
| 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 specificed |
-
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 specificed |
-
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 | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
| 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. - |
-
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 might 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 |
-
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.
| Factory | -Description | -
|---|---|
L.control.zoom( |
- Creates a zoom control | -
| 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'
- |
-
| 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. - |
-
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.
| Factory | -Description | -
|---|---|
L.control.attribution( |
- Creates an attribution control. | -
| 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'
- |
-
| 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. - |
-
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.
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}
-| Factory | -Description | -
|---|---|
L.control.layers( |
- Creates an attribution control with the given layers. Base layers will be switched with radio buttons, while overlays will be switched with checkboxes. Note that all base layers should be passed in the base layers object, but only one should be added to the map during map instantiation. | -
| 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. |
-
| 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'
- |
-
| 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. - |
-
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.
L.control.scale().addTo(map);
-| Factory | -Description | -
|---|---|
L.control.scale( |
- Creates an scale control with the given 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'
- |
-
| 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. - |
-
A namespace with static properties for browser/feature detection used by Leaflet internally.
- -if (L.Browser.ielt9) {
- alert('Upgrade your browser, dude!');
-}
-| Property | -Type | -Description | -
|---|---|---|
ie
- |
-||
ielt9
- |
-||
edge
- |
-||
webkit
- |
-||
gecko
- |
-||
android
- |
-||
android23
- |
-||
chrome
- |
-||
safari
- |
-||
win
- |
-||
ie3d
- |
-||
webkit3d
- |
-||
gecko3d
- |
-||
opera12
- |
-||
any3d
- |
-||
mobile
- |
-||
mobileWebkit
- |
-||
mobileWebkit3d
- |
-||
mobileOpera
- |
-||
mobileGecko
- |
-||
touch
- |
-||
msPointer
- |
-||
pointer
- |
-||
retina
- |
-||
canvas
- |
-||
vml
- |
-||
svg
- |
-
Various utility functions, used by Leaflet internally.
- -| 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, assiging 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.bind 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 5 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. |
-
| Property | -Type | -Description | -
|---|---|---|
lastId
- |
-||
emptyImageUrl
- |
-
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.
var transformation = new L.Transformation(2, 5, -1, 10),
- p = L.point(1, 2),
- p2 = transformation.transform(p), // L.point(7, 8)
- p3 = transformation.untransform(p2); // L.point(1, 2)
-| Method | -Returns | -Description | -
|---|---|---|
transform( |
- Point |
-
- Returns a transformed point, optionally multiplied by the given scale.
-Only accepts real |
-
untransform( |
- Point |
-
- Returns the reverse transformation of the given point, optionally divided
-by the given scale. Only accepts real |
-
Various utility functions for polyine points processing, used by Leaflet internally to make polylines lightning-fast.
- -| 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. | -
Various utility functions for polygon geometries.
- -| Function | -Returns | -Description | -
|---|---|---|
clipPolygon( |
- Point[] |
- Clips the polygon geometry defined by the given points by the given bounds (using the Sutherland-Hodgeman algorithm).
-Used by Leaflet to only show polygon points that are on the screen or near, increasing
-performance. Note that polygon points needs different algorithm for clipping
-than polyline, so there's a seperate method for it. |
-
Utility functions to work with the DOM events, used by Leaflet internally.
- -| 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. If no function is specified,
-it will remove all the listeners of that particular DOM event from the element.
-Note that if you passed a custom context to on, you must pass the same
-context to off in order to remove the listener. |
-
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:
- |
-
disableScrollPropagation( |
- this |
- Adds stopPropagation to the element's 'mousewheel' 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(ev) |
- this |
- Does stopPropagation and preventDefault at the same time. |
-
getMousePosition( |
- Point |
- Gets normalized mouse position from a DOM event relative to the
-container or to the whole page if not specified. |
-
getWheelDelta( |
- Number |
- Gets normalized wheel delta from a mousewheel DOM event, in vertical -pixels scrolled (negative if scrolling down). -Events from pointing devices without precise scrolling are mapped to -a best guess of 60 pixels. | -
addListener(…) |
- this |
- Alias to L.DomEvent.on
- |
-
removeListener(…) |
- this |
- Alias to L.DomEvent.off
- |
-
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.
| 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 children of its parent, so it renders in front of the other children. |
-
toBack( |
- |
- Makes el the first children of its parent, so it renders back from 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. |
-
| Property | -Type | -Description | -
|---|---|---|
TRANSFORM
- |
-||
TRANSITION
- |
-
Used internally for panning animations, utilizing CSS3 Transitions for modern browsers and a timer fallback for IE6-9.
- -var fx = new L.PosAnimation();
-fx.run(el, [300, 500], 0.5);
-| Constructor | -Description | -
|---|---|
L.PosAnimation() |
- Creates a PosAnimation object. |
-
| Event | -Data | -Description | -
|---|---|---|
start
- |
-||
step
- |
-||
end
- |
-
| 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. - |
-
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 might 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 |
-
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.
var draggable = new L.Draggable(elementToDrag);
-draggable.enable();
-| Constructor | -Description | -
|---|---|
L.Draggable( |
- Creates a Draggable object for moving el when you start dragging the dragHandle element (equals el itself by default). |
-
| 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). | -
| Event | -Data | -Description | -
|---|---|---|
down
- |
-||
dragstart
- |
-||
predrag
- |
-||
drag
- |
-||
dragend
- |
-
| 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. - |
-
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 might 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 |
-
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.
- -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");
-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);
-};
-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 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 = L.Class.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}
-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'
-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, …);
-| 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. | -
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).
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);
-| 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. - |
-
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 might 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 |
-
A set of methods from the Layer base class that all Leaflet layers use.
-Inherits all methods, options and events from L.Evented.
var layer = L.Marker(latlng).addTo(map);
-layer.addTo(map);
-layer.remove();
-| 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. | -
| Event | -Data | -Description | -
|---|---|---|
add
- |
-||
remove
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
L.Layer will inherit the following methods:| Method | -Returns | -Description | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns the |
-
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 specificed |
-
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. - |
-
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 specificed |
-
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. - |
-
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 |
-
| 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. - |
-
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 might 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 |
-
Some Layers 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.
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
click
- |
-||
dblclick
- |
-||
mousedown
- |
-||
mouseover
- |
-||
mouseout
- |
-||
contextmenu
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns 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 specificed |
-
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 specificed |
-
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. - |
-
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 might 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 |
-
L.Control is a base class for implementing map controls. Handles positioning. -All other controls extend from this class.
- -| 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'
- |
-
| 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. - |
-
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 |
-
Abstract class for map interaction handlers
- -| Method | -Returns | -Description | -
|---|---|---|
enable() |
- this |
-
- Enables the handler - |
-
disable() |
- this |
-
- Disables the handler - |
-
enabled() |
- Boolean |
-
- Returns |
-
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. - |
-
An object with methods for projecting geographical coordinates of the world onto -a flat surface (and back). See Map projection.
- -| Method | -Returns | -Description | -
|---|---|---|
project( |
- Point |
-
- Projects geographical coordinates into a 2D point. - |
-
unproject( |
- LatLng |
-
- The inverse of |
-
| Property | -Type | -Description | -
|---|---|---|
bounds
- |
-
| 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:3395 and Simple CRS. |
-
L.Projection.Mercator |
- Elliptical Mercator projection — more complex than Spherical Mercator. Takes into account that Earth is a geoid, not a perfect sphere. Used by the EPSG:3395 CRS. | -
L.Projection.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. |
-
Abstract class that defines coordinate reference systems for projecting -geographical points into pixel (screen) coordinates and back (and to -coordinates in other units for WMS services). See -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.
- -| 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 |
-
| Property | -Type | -Description | -
|---|---|---|
code
- |
-||
wrapLng
- |
-||
wrapLat
- |
-||
infinite
- |
-
| 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. | -
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. |
-
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 Paths - 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.
| 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 | -
| 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. | -
| Event | -Data | -Description | -
|---|---|---|
update
- |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns 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 specificed |
-
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 specificed |
-
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. - |
-
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 might 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 |
-
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:
- - - -| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
originalEvent
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
latlng
- |
-||
layerPoint
- |
-||
containerPoint
- |
-||
originalEvent
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
latlng
- |
-||
bounds
- |
-||
accuracy
- |
-||
altitude
- |
-||
altitudeAccuracy
- |
-||
heading
- |
-||
speed
- |
-||
timestamp
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
message
- |
-||
code
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
layer
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
layer
- |
-||
name
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
tile
- |
-||
coords
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
tile
- |
-||
coords
- |
-||
error
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
oldSize
- |
-||
newSize
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
layer
- |
-||
properties
- |
-||
geometryType
- |
-||
id
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
popup
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
tooltip
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
| Property | -Type | -Description | -
|---|---|---|
distance
- |
-
| Property | -Type | -Description | -
|---|---|---|
type
- |
-||
target
- |
-
Base model for L.Popup and L.Tooltip. Inherit from it for custom popup like plugins.
- -| 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. |
-
| Event | -Data | -Description | -
|---|---|---|
popupopen
- |
-||
popupclose
- |
-
| Event | -Data | -Description | -
|---|---|---|
tooltipopen
- |
-||
tooltipclose
- |
-
| Method | -Returns | -Description | -
|---|---|---|
addTo( |
- this |
-
- Adds the layer to the given map - |
-
remove() |
- this |
-
- Removes the layer from the map it is currently active on. - |
-
removeFrom( |
- this |
-
- Removes the layer from the given map - |
-
getPane( |
- HTMLElement |
-
- Returns 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 specificed |
-
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 specificed |
-
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. - |
-
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 might 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 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. | -
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>
-A constant that represents the Leaflet version in use.
-L.version; // contains "1.0.0" (or whatever version is currently in use)
-This reference reflects Leaflet 1.3.4. Check this list if you are using a different version of Leaflet.
+This reference reflects Leaflet 1.4.0. Check this list if you are using a different version of Leaflet.
Boolean
falsePaths should be rendered on a Canvas renderer.
-By default, all Paths are rendered in a SVG renderer.Paths should be rendered on a Canvas renderer.
+By default, all Paths are rendered in a SVG renderer.Boolean
truezoomControlBoolean
true1fitBounds() or a pinch-zoom.
+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.1zoomIn(), zoomOut(), pressing +
-or - on the keyboard, or using the zoom controls.
+zoomIn(), zoomOut(), pressing +
+or - on the keyboard, or using the zoom controls.
Values smaller than 1 (e.g. 0.5) allow for greater granularity.Number
60crsCRS
+CRS
L.CRS.EPSG3857centerLatLng
+LatLng
undefined*GridLayer or TileLayer is in 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.*GridLayer or TileLayer is in 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.maxBoundsLatLngBounds
+LatLngBounds
nullsetMaxBounds method.setMaxBounds method.
rendererRenderer
+Renderer
*L.SVG
-or L.Canvas by default depending on browser support.L.SVG
+or L.Canvas by default depending on browser support.baselayerchange
- LayersControlEventFired when the base layer is changed through the layer control.
+ LayersControlEventFired when the base layer is changed through the layer control.
overlayadd
- LayersControlEventFired when an overlay is selected through the layer control.
+ LayersControlEventFired when an overlay is selected through the layer control.
overlayremove
- LayersControlEventFired when an overlay is deselected through the layer control.
+ LayersControlEventFired when an overlay is deselected through the layer control.
layeradd
- LayerEventLayerEventFired when a new layer is added to the map.
layerremove
- LayerEventLayerEventFired when some layer is removed from the map
zoomlevelschange
- EventEventFired when the number of zoomlevels on the map is changed due
to adding or removing a layer.
resize
- ResizeEventResizeEventFired when the map is resized.
unload
- EventFired when the map is destroyed with remove method.
+ EventFired when the map is destroyed with remove method.
viewreset
- EventEventFired when the map needs to redraw its content (this usually happens
on map zoom or load). Very useful for creating custom overlays.
load
- EventEventFired when the map is initialized (when its center and zoom are set
for the first time).
zoomstart
- EventEventFired when the map zoom is about to change (e.g. before zoom animation).
movestart
- EventEventFired when the view of the map starts changing (e.g. user starts dragging the map).
zoom
- EventEventFired repeatedly during any change in zoom level, including zoom
and fly animations.
move
- EventEventFired repeatedly during any movement of the map, including pan and
fly animations.
zoomend
- EventEventFired when the map has changed, after any animations.
moveend
- EventEventFired when the center of the map stops changing (e.g. user stopped
dragging the map).
popupopen
- PopupEventPopupEventFired when a popup is opened in the map
popupclose
- PopupEventPopupEventFired when a popup in the map is closed
autopanstart
- EventEventFired when the map starts autopanning when opening a popup.
tooltipopen
- TooltipEventTooltipEventFired when a tooltip is opened in the map.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip in the map is closed.
locationerror
- ErrorEventFired when geolocation (using the locate method) failed.
+ ErrorEventFired when geolocation (using the locate method) failed.
locationfound
- LocationEventFired when geolocation (using the locate method)
+ LocationEventFired when geolocation (using the locate method)
went successfully.
click
- MouseEventMouseEventFired when the user clicks (or taps) the map.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the map.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the map.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button on the map.
mouseover
- MouseEventMouseEventFired when the mouse enters the map.
mouseout
- MouseEventMouseEventFired when the mouse leaves the map.
mousemove
- MouseEventMouseEventFired while the mouse moves over the map.
contextmenu
- MouseEventMouseEventFired 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
@@ -1054,13 +1054,13 @@ Interaction events
keypress
- KeyboardEventKeyboardEventFired when the user presses a key from the keyboard while the map is focused.
preclick
- MouseEventMouseEventFired before mouse click on the map (sometimes useful when you
want something to happen on click before any existing click
handlers start running).
@@ -1085,8 +1085,8 @@ Other Methods
zoomanim
- ZoomAnimEventFired on every frame of a zoom animation
+ ZoomAnimEventFired at least once per zoom animation. For continuous zoom, like pinch zooming, fired once per frame during zoom.
@@ -1113,11 +1113,11 @@ Methods
- getRenderer(<Path> layer)RenderergetRenderer(<Path> layer)Renderer
-Returns the instance of Renderer that should be used to render the given
-Path. It will ensure that the renderer options of the map and paths
+
Returns the instance of Renderer that should be used to render the given
+Path. It will ensure that the renderer options of the map and paths
are respected, and that the renderers do exist on the map.
@@ -1140,35 +1140,35 @@ Methods for Layers and Controls
- addControl(<Control> control)addControl(<Control> control)this
Adds the given control to the map
- removeControl(<Control> control)removeControl(<Control> control)this
Removes the given control from the map
- addLayer(<Layer> layer)addLayer(<Layer> layer)this
Adds the given layer to the map
- removeLayer(<Layer> layer)removeLayer(<Layer> layer)this
Removes the given layer from the map.
- hasLayer(<Layer> layer)hasLayer(<Layer> layer)Boolean
Returns true if the given layer is currently added to the map
@@ -1186,42 +1186,42 @@ Methods for Layers and Controls
- openPopup(<Popup> popup)openPopup(<Popup> popup)this
Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).
- openPopup(<String|HTMLElement> content, <LatLng> latlng, <Popup options> options?)openPopup(<String|HTMLElement> content, <LatLng> latlng, <Popup options> options?)this
Creates a popup with the specified content and options and opens it in the given point on a map.
- closePopup(<Popup> popup?)closePopup(<Popup> popup?)this
-Closes the popup previously opened with openPopup (or the given one).
+Closes the popup previously opened with openPopup (or the given one).
- openTooltip(<Tooltip> tooltip)openTooltip(<Tooltip> tooltip)this
Opens the specified tooltip.
- openTooltip(<String|HTMLElement> content, <LatLng> latlng, <Tooltip options> options?)openTooltip(<String|HTMLElement> content, <LatLng> latlng, <Tooltip options> options?)this
Creates a tooltip with the specified content and options and open it.
- closeTooltip(<Tooltip> tooltip?)closeTooltip(<Tooltip> tooltip?)this
Closes the tooltip given as parameter.
@@ -1245,7 +1245,7 @@ Methods for modifying map state
- setView(<LatLng> center, <Number> zoom, <Zoom/pan options> options?)setView(<LatLng> center, <Number> zoom, <Zoom/pan options> options?)this
Sets the view of the map (geographical center and zoom) with the given
@@ -1253,28 +1253,28 @@
Methods for modifying map state
- setZoom(<Number> zoom, <Zoom/pan options> options?)setZoom(<Number> zoom, <Zoom/pan options> options?)this
Sets the zoom of the map.
- zoomIn(<Number> delta?, <Zoom options> options?)zoomIn(<Number> delta?, <Zoom options> options?)this
-Increases the zoom of the map by delta (zoomDelta by default).
+Increases the zoom of the map by delta (zoomDelta by default).
- zoomOut(<Number> delta?, <Zoom options> options?)zoomOut(<Number> delta?, <Zoom options> options?)this
-Decreases the zoom of the map by delta (zoomDelta by default).
+Decreases the zoom of the map by delta (zoomDelta by default).
- setZoomAround(<LatLng> latlng, <Number> zoom, <Zoom options> options)setZoomAround(<LatLng> latlng, <Number> zoom, <Zoom options> options)this
Zooms the map while keeping a specified geographical point on the map
@@ -1282,14 +1282,14 @@
Methods for modifying map state
- setZoomAround(<Point> offset, <Number> zoom, <Zoom options> options)setZoomAround(<Point> offset, <Number> zoom, <Zoom options> options)this
Zooms the map while keeping a specified pixel on the map (relative to the top-left corner) stationary.
- fitBounds(<LatLngBounds> bounds, <fitBounds options> options?)fitBounds(<LatLngBounds> bounds, <fitBounds options> options?)this
Sets a map view that contains the given geographical bounds with the
@@ -1297,7 +1297,7 @@
Methods for modifying map state
- fitWorld(<fitBounds options> options?)fitWorld(<fitBounds options> options?)this
Sets a map view that mostly contains the whole world with the maximum
@@ -1305,21 +1305,21 @@
Methods for modifying map state
- panTo(<LatLng> latlng, <Pan options> options?)panTo(<LatLng> latlng, <Pan options> options?)this
Pans the map to a given center.
- panBy(<Point> offset, <Pan options> options?)panBy(<Point> offset, <Pan options> options?)this
Pans the map by a given number of pixels (animated).
- flyTo(<LatLng> latlng, <Number> zoom?, <Zoom/pan options> options?)flyTo(<LatLng> latlng, <Number> zoom?, <Zoom/pan options> options?)this
Sets the view of the map (geographical center and zoom) performing a smooth
@@ -1327,43 +1327,54 @@
Methods for modifying map state
- flyToBounds(<LatLngBounds> bounds, <fitBounds options> options?)flyToBounds(<LatLngBounds> bounds, <fitBounds options> options?)this
-Sets the view of the map with a smooth animation like flyTo,
-but takes a bounds parameter like fitBounds.
+Sets the view of the map with a smooth animation like flyTo,
+but takes a bounds parameter like fitBounds.
- setMaxBounds(<Bounds> bounds)setMaxBounds(<Bounds> bounds)this
-Restricts the map view to the given bounds (see the maxBounds option).
+Restricts the map view to the given bounds (see the maxBounds option).
setMinZoom(<Number> zoom)this
-Sets the lower limit for the available zoom levels (see the minZoom option).
+Sets the lower limit for the available zoom levels (see the minZoom option).
setMaxZoom(<Number> zoom)this
-Sets the upper limit for the available zoom levels (see the maxZoom option).
+Sets the upper limit for the available zoom levels (see the maxZoom option).
- panInsideBounds(<LatLngBounds> bounds, <Pan options> options?)panInsideBounds(<LatLngBounds> bounds, <Pan options> options?)this
Pans the map to the closest view that would lie inside the given bounds (if it's not already), controlling the animation using the options specific, if any.
+
+
+
+ panInside(<LatLng> latlng, <options> options?)this
+Pans the map the minimum amount to make the latlng visible. Use
+padding, paddingTopLeft and paddingTopRight options to fit
+the display to more restricted bounds, like fitBounds.
+If latlng is already within the (optionally padded) display bounds,
+the map will not be panned.
- invalidateSize(<Zoom/pan options> options)invalidateSize(<Zoom/pan options> options)this
Checks if the map container size changed and updates the map if so —
@@ -1408,16 +1419,16 @@
Geolocation methods
- locate(<Locate options> options?)locate(<Locate options> options?)this
-Tries to locate the user using the Geolocation API, firing a locationfound
-event with location data on success or a locationerror event on failure,
+
Tries to locate the user using the Geolocation API, firing a locationfound
+event with location data on success or a locationerror event on failure,
and optionally sets the map view to the user's location with respect to
detection accuracy (or to the world view if geolocation failed).
Note that, if your page doesn't use HTTPS, this method will fail in
modern browsers (Chrome 50 and newer)
-See Locate options for more details.
+See Locate options for more details.
@@ -1450,7 +1461,7 @@ Other Methods
addHandler(<String> name, <Function> HandlerClass)this
-Adds a new Handler to the map, given its name and constructor function.
+Adds a new Handler to the map, given its name and constructor function.
@@ -1464,7 +1475,7 @@ Other Methods
createPane(<String> name, <HTMLElement> container?)HTMLElement
-Creates a new map pane with the given name if it doesn't exist already,
+
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 container, or
as a child of the main map pane if not set.
@@ -1473,14 +1484,14 @@ Other Methods
getPane(<String|HTMLElement> pane)HTMLElement
-Returns a map pane, given its name or its HTML element (its identity).
+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
+
Returns a plain object containing the names of all panes as keys and
the panes as values.
@@ -1519,7 +1530,7 @@ Methods for Getting Map State
getCenter()LatLngLatLng
Returns the geographical center of the map view
@@ -1533,7 +1544,7 @@ Methods for Getting Map State
getBounds()LatLngBoundsLatLngBounds
Returns the geographical bounds visible in the current map view
@@ -1553,7 +1564,7 @@ Methods for Getting Map State
- getBoundsZoom(<LatLngBounds> bounds, <Boolean> inside?, <Point> padding?)getBoundsZoom(<LatLngBounds> bounds, <Boolean> inside?, <Point> padding?)Number
Returns the maximum zoom level on which the given bounds fit to the map
@@ -1564,14 +1575,14 @@
Methods for Getting Map State
getSize()PointPoint
Returns the current size of the map container (in pixels).
getPixelBounds()BoundsBounds
Returns the bounds of the current map view in projected pixel
coordinates (sometimes useful in layer and overlay implementations).
@@ -1579,7 +1590,7 @@ Methods for Getting Map State
getPixelOrigin()PointPoint
Returns the projected pixel coordinates of the top left point of
the map layer (useful in custom layer and overlay implementations).
@@ -1587,7 +1598,7 @@ Methods for Getting Map State
getPixelWorldBounds(<Number> zoom?)BoundsBounds
Returns the world's bounds in pixel coordinates for zoom level zoom.
If zoom is omitted, the map's current zoom level is used.
@@ -1624,47 +1635,47 @@ Conversion Methods
Returns the zoom level that the map would end up at, if it is at fromZoom
level and everything is scaled by a factor of scale. Inverse of
-getZoomScale.
+getZoomScale.
- project(<LatLng> latlng, <Number> zoom)Pointproject(<LatLng> latlng, <Number> zoom)Point
-Projects a geographical coordinate LatLng according to the projection
+
Projects a geographical coordinate LatLng according to the projection
of the map's CRS, then scales it according to zoom and the CRS's
-Transformation. The result is pixel coordinate relative to
+Transformation. The result is pixel coordinate relative to
the CRS origin.
- unproject(<Point> point, <Number> zoom)LatLngunproject(<Point> point, <Number> zoom)LatLng
-Inverse of project.
+Inverse of project.
- layerPointToLatLng(<Point> point)LatLnglayerPointToLatLng(<Point> point)LatLng
-Given a pixel coordinate relative to the origin pixel,
+
Given a pixel coordinate relative to the origin pixel,
returns the corresponding geographical coordinate (for the current zoom level).
- latLngToLayerPoint(<LatLng> latlng)PointlatLngToLayerPoint(<LatLng> latlng)Point
Given a geographical coordinate, returns the corresponding pixel coordinate
-relative to the origin pixel.
+relative to the origin pixel.
- wrapLatLng(<LatLng> latlng)LatLngwrapLatLng(<LatLng> latlng)LatLng
-Returns a LatLng where lat and lng has been wrapped according to the
+
Returns a LatLng where lat and lng has been wrapped according to the
map's CRS's wrapLat and wrapLng properties, if they are outside the
CRS's bounds.
By default this means longitude is wrapped around the dateline so its
@@ -1672,10 +1683,10 @@
Conversion Methods
- wrapLatLngBounds(<LatLngBounds> bounds)LatLngBoundswrapLatLngBounds(<LatLngBounds> bounds)LatLngBounds
-Returns a LatLngBounds with the same size as the given one, ensuring that
+
Returns a LatLngBounds with the same size as the given one, ensuring that
its center is within the CRS's bounds.
By default this means the center longitude is wrapped around the dateline so its
value is between -180 and +180 degrees, and the majority of the bounds
@@ -1683,7 +1694,7 @@
Conversion Methods
- distance(<LatLng> latlng1, <LatLng> latlng2)distance(<LatLng> latlng1, <LatLng> latlng2)Number
Returns the distance between two geographical coordinates according to
@@ -1691,56 +1702,56 @@
Conversion Methods
- containerPointToLayerPoint(<Point> point)PointcontainerPointToLayerPoint(<Point> point)Point
Given a pixel coordinate relative to the map container, returns the corresponding
-pixel coordinate relative to the origin pixel.
+pixel coordinate relative to the origin pixel.
- layerPointToContainerPoint(<Point> point)PointlayerPointToContainerPoint(<Point> point)Point
-Given a pixel coordinate relative to the origin pixel,
+
Given a pixel coordinate relative to the origin pixel,
returns the corresponding pixel coordinate relative to the map container.
- containerPointToLatLng(<Point> point)LatLngcontainerPointToLatLng(<Point> point)LatLng
Given a pixel coordinate relative to the map container, returns
the corresponding geographical coordinate (for the current zoom level).
- latLngToContainerPoint(<LatLng> latlng)PointlatLngToContainerPoint(<LatLng> latlng)Point
Given a geographical coordinate, returns the corresponding pixel coordinate
relative to the map container.
- mouseEventToContainerPoint(<MouseEvent> ev)PointmouseEventToContainerPoint(<MouseEvent> ev)Point
Given a MouseEvent object, returns the pixel coordinate relative to the
map container where the event took place.
- mouseEventToLayerPoint(<MouseEvent> ev)PointmouseEventToLayerPoint(<MouseEvent> ev)Point
Given a MouseEvent object, returns the pixel coordinate relative to
-the origin pixel where the event took place.
+the origin pixel where the event took place.
- mouseEventToLatLng(<MouseEvent> ev)LatLngmouseEventToLatLng(<MouseEvent> ev)LatLng
Given a MouseEvent object, returns geographical coordinate where the
event took place.
@@ -1753,7 +1764,7 @@ Conversion Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -1845,42 +1856,42 @@ Conversion Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -1909,9 +1920,9 @@ Controls
zoomControl
- Control.ZoomControl.ZoomThe default zoom control (only available if the
-zoomControl option was true when creating the map).
+zoomControl option was true when creating the map).
@@ -1933,43 +1944,43 @@ Handlers
boxZoom
- HandlerHandlerBox (shift-drag with mouse) zoom handler.
doubleClickZoom
- HandlerHandlerDouble click zoom handler.
dragging
- HandlerHandlerMap dragging handler (by both mouse and touch).
keyboard
- HandlerHandlerKeyboard navigation handler.
scrollWheelZoom
- HandlerHandlerScroll wheel zoom handler.
tap
- HandlerHandlerMobile touch hacks (quick tap and touch hold) handler.
touchZoom
- HandlerHandlerTouch zoom handler.
@@ -1987,9 +1998,9 @@ Map panes
Panes are DOM elements used to control the ordering of layers on the map. You
-can access panes with map.getPane or
-map.getPanes methods. New panes can be created with the
-map.createPane method.
+can access panes with map.getPane or
+map.getPanes methods. New panes can be created with the
+map.createPane method.
Every map has the following default panes that differ only in zIndex.
@@ -2016,7 +2027,7 @@ Map panes
HTMLElement
200Pane for GridLayers and TileLayers
+ Pane for GridLayers and TileLayers
overlayPaneMap panes
HTMLElement
400Pane for vectors (Paths, like Polylines and Polygons), ImageOverlays and VideoOverlays
+ Pane for vectors (Paths, like Polylines and Polygons), ImageOverlays and VideoOverlays
shadowPaneMap panes
HTMLElement
500Pane for overlay shadows (e.g. Marker shadows)
+ Pane for overlay shadows (e.g. Marker shadows)
markerPaneMap panes
HTMLElement
600Pane for Icons of Markers
+ Pane for Icons of Markers
tooltipPaneMap panes
HTMLElement
650Pane for Tooltips.
+ Pane for Tooltips.
popupPaneMap panes
HTMLElement
700Pane for Popups.
+ Pane for Popups.
@@ -2073,7 +2084,7 @@ Locate options
-Some of the geolocation methods for Map take in an options parameter. This
+Some of the geolocation methods for Map take in an options parameter. This
is a plain javascript object with the following optional components:
@@ -2154,7 +2165,7 @@ Zoom options
-Some of the Map methods which modify the zoom level take in an options
+Some of the Map methods which modify the zoom level take in an options
parameter. This is a plain javascript object with the following optional
components:
@@ -2194,7 +2205,7 @@ Pan options
-Some of the Map methods which modify the center of the map take in an options
+Some of the Map methods which modify the center of the map take in an options
parameter. This is a plain javascript object with the following optional
components:
@@ -2261,7 +2272,7 @@ Zoom/pan options
-
+
@@ -2297,7 +2308,7 @@ Zoom/pan options
-
+
@@ -2371,7 +2382,7 @@ FitBounds options
paddingTopLeft
-Point
+Point
[0, 0]Sets the amount of padding in the top left corner of a map container that
@@ -2382,7 +2393,7 @@ FitBounds options
paddingBottomRight
-Point
+Point
[0, 0]The same for the bottom right corner of the map.
@@ -2390,7 +2401,7 @@ FitBounds options
padding
-Point
+Point
[0, 0]Equivalent of setting both top left and bottom right padding to the same value.
@@ -2410,7 +2421,7 @@ FitBounds options
-
+
@@ -2446,7 +2457,7 @@ FitBounds options
-
+
@@ -2498,7 +2509,7 @@ FitBounds options
Marker
-L.Marker is used to display clickable/draggable icons on the map. Extends Layer.
+L.Marker is used to display clickable/draggable icons on the map. Extends Layer.
Usage example
@@ -2534,7 +2545,7 @@ Creation
- L.marker(<LatLng> latlng, <Marker options> options?)L.marker(<LatLng> latlng, <Marker options> options?)Instantiates a Marker object given a geographical point and optionally an options object.
@@ -2564,12 +2575,12 @@ Options
icon
-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.
+See Icon documentation for details on how to customize the marker icon.
+If not specified, a common instance of L.Icon.Default is used.
keyboardOptions
falseWhen true, a mouse event on this marker will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).
+(unless L.DomEvent.stopPropagation is used).
@@ -2682,7 +2693,7 @@ Draggable marker options
autoPanPadding
-Point
+Point
Point(50, 50)Distance (in pixels to the left/right and to the top/bottom) of the
@@ -2703,7 +2714,7 @@ Draggable marker options
-
+
@@ -2736,7 +2747,7 @@ Draggable marker options
-
+
@@ -2759,7 +2770,7 @@ Draggable marker options
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
@@ -2775,7 +2786,7 @@ Events
-In addition to shared layer methods like addTo() and remove() and popup methods like bindPopup() you can also use the following methods:
+In addition to shared layer methods like addTo() and remove() and popup methods like bindPopup() you can also use the following methods:
@@ -2788,8 +2799,8 @@ Events
move
- EventFired when the marker is moved via setLatLng or by dragging. Old and new coordinates are included in event arguments as oldLatLng, latlng.
+ EventFired when the marker is moved via setLatLng or by dragging. Old and new coordinates are included in event arguments as oldLatLng, latlng.
@@ -2811,31 +2822,31 @@ Dragging events
dragstart
- EventEventFired when the user starts dragging the marker.
movestart
- EventEventFired when the marker starts moving (because of dragging).
drag
- EventEventFired repeatedly while the user drags the marker.
dragend
- DragEndEventDragEndEventFired when the user stops dragging the marker.
moveend
- EventEventFired when the marker stops moving (because of dragging).
@@ -2846,7 +2857,7 @@ Dragging events
-
+
@@ -2864,43 +2875,43 @@ Dragging events
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -2915,7 +2926,7 @@ Dragging events
-
+
@@ -2933,13 +2944,13 @@ Dragging events
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
@@ -2951,7 +2962,7 @@ Dragging events
-
+
@@ -2969,13 +2980,13 @@ Dragging events
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
@@ -2987,7 +2998,7 @@ Dragging events
-
+
@@ -3005,13 +3016,13 @@ Dragging events
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
@@ -3043,18 +3054,18 @@ Methods
toGeoJSON()Object
-Returns a GeoJSON representation of the marker (as a GeoJSON Point Feature).
+Returns a GeoJSON representation of the marker (as a GeoJSON Point Feature).
getLatLng()LatLngLatLng
Returns the current geographical position of the marker.
- setLatLng(<LatLng> latlng)setLatLng(<LatLng> latlng)this
Changes the marker position to the given point.
@@ -3064,11 +3075,11 @@ Methods
setZIndexOffset(<Number> offset)this
-Changes the zIndex offset of the marker.
+Changes the zIndex offset of the marker.
- setIcon(<Icon> icon)setIcon(<Icon> icon)this
Changes the marker icon.
@@ -3088,7 +3099,7 @@ Methods
-
+
@@ -3119,7 +3130,7 @@ Methods
- removeFrom(<Map> map)removeFrom(<Map> map)this
Removes the layer from the given map
@@ -3136,7 +3147,7 @@ Methods
getAttribution()String
-Used by the attribution control, returns the attribution option.
+Used by the attribution control, returns the attribution option.
@@ -3147,7 +3158,7 @@ Methods
-
+
@@ -3164,7 +3175,7 @@ Methods
- bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)this
Binds a popup to the layer with the passed content and sets up the
@@ -3180,10 +3191,10 @@
Methods
- openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)this
-Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
+Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
@@ -3216,7 +3227,7 @@ Methods
getPopup()PopupPopup
Returns the popup bound to this layer.
@@ -3229,7 +3240,7 @@ Methods
-
+
@@ -3246,7 +3257,7 @@ Methods
- bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)this
Binds a tooltip to the layer with the passed content and sets up the
@@ -3262,10 +3273,10 @@
Methods
- openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)this
-Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
+Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
@@ -3298,7 +3309,7 @@ Methods
getTooltip()TooltipTooltip
Returns the tooltip bound to this layer.
@@ -3311,7 +3322,7 @@ Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -3403,42 +3414,42 @@ Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -3455,7 +3466,7 @@ Properties
Interaction handlers
-Interaction handlers are properties of a marker instance that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging (see Handler methods). Example:
+Interaction handlers are properties of a marker instance that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging (see Handler methods). Example:
marker.dragging.disable();
@@ -3471,8 +3482,8 @@ Interaction handlers
dragging
- HandlerMarker dragging handler (by both mouse and touch). Only valid when the marker is on the map (Otherwise set marker.options.draggable).
+ HandlerMarker dragging handler (by both mouse and touch). Only valid when the marker is on the map (Otherwise set marker.options.draggable).
@@ -3482,9 +3493,9 @@ Interaction handlers
Popup
-Used to open popups in certain places of the map. Use Map.openPopup to
+
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.
+(recommended for usability), or use Map.addLayer to open as many as you want.
Usage example
@@ -3528,8 +3539,8 @@ Creation
- L.popup(<Popup options> options?, <Layer> source?)Instantiates a Popup object given an optional options object that describes its appearance and location and an optional source object that is used to tag the popup with a reference to the Layer to which it refers.
+ L.popup(<Popup options> options?, <Layer> source?)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.
@@ -3592,7 +3603,7 @@ Options
autoPanPaddingTopLeft
-Point
+Point
nullThe margin between the popup and the top left corner of the map
@@ -3601,7 +3612,7 @@ Options
autoPanPaddingBottomRight
-Point
+Point
nullThe margin between the popup and the bottom right corner of the map
@@ -3610,7 +3621,7 @@ Options
autoPanPadding
-Point
+Point
Point(5, 5)Equivalent of setting both top left and bottom right autopan padding to the same value.
@@ -3657,7 +3668,7 @@ Options
*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.
+on the map. Defaults to the map's closePopupOnClick option.
classNameOptions
-
+
@@ -3694,7 +3705,7 @@ Options
offset
-Point
+Point
Point(0, 7)The offset of the popup position. Useful to control the anchor
@@ -3717,7 +3728,7 @@ Options
-
+
@@ -3740,7 +3751,7 @@ Options
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
getLatLng()LatLngLatLngReturns the geographical point of popup.
setLatLng(<LatLng> latlng)setLatLng(<LatLng> latlng)thisSets the geographical point where the popup will open.
@@ -3912,7 +3923,7 @@getElement()String|HTMLElementAlias for getContent()
+Alias for getContent()
openOn(<Map> map)openOn(<Map> map)thisAdds the popup to the map and closes the previous one. The same as map.openPopup(popup).
removeFrom(<Map> map)removeFrom(<Map> map)thisRemoves the layer from the given map
@@ -4005,7 +4016,7 @@getAttribution()StringUsed by the attribution control, returns the attribution option.
Used by the attribution control, returns the attribution option.
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)thisBinds a popup to the layer with the passed content and sets up the
@@ -4049,10 +4060,10 @@
openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)thisOpens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
getPopup()PopupPopupReturns the popup bound to this layer.
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)thisBinds a tooltip to the layer with the passed content and sets up the
@@ -4131,10 +4142,10 @@
openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)thisOpens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
getTooltip()TooltipTooltipReturns the tooltip bound to this layer.
addEventParent(<Evented> obj)addEventParent(<Evented> obj)thisAdds an event parent - an Evented that will receive propagated events
Adds an event parent - an Evented that will receive propagated events
removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)thisRemoves an event parent, so it will stop receiving propagated events
@@ -4272,42 +4283,42 @@addEventListener(…)thisAlias to on(…)
Alias to on(…)
removeEventListener(…)thisAlias to off(…)
Alias to off(…)
clearAllEventListeners(…)thisAlias to off()
Alias to off()
addOneTimeEventListener(…)thisAlias to once(…)
Alias to once(…)
fireEvent(…)thisAlias to fire(…)
Alias to fire(…)
hasEventListeners(…)BooleanAlias to listens(…)
Alias to listens(…)
L.tooltip(<Tooltip options> options?, <Layer> source?)L.tooltip(<Tooltip options> options?, <Layer> source?)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.offsetPoint
+Point
Point(0, 0)String
nulladd
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
removeFrom(<Map> map)removeFrom(<Map> map)thisRemoves the layer from the given map
@@ -4691,7 +4702,7 @@getAttribution()StringUsed by the attribution control, returns the attribution option.
Used by the attribution control, returns the attribution option.
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)thisBinds a popup to the layer with the passed content and sets up the
@@ -4735,10 +4746,10 @@
openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)thisOpens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
getPopup()PopupPopupReturns the popup bound to this layer.
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)thisBinds a tooltip to the layer with the passed content and sets up the
@@ -4817,10 +4828,10 @@
openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)thisOpens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
getTooltip()TooltipTooltipReturns the tooltip bound to this layer.
addEventParent(<Evented> obj)addEventParent(<Evented> obj)thisAdds an event parent - an Evented that will receive propagated events
Adds an event parent - an Evented that will receive propagated events
removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)thisRemoves an event parent, so it will stop receiving propagated events
@@ -4958,42 +4969,42 @@addEventListener(…)thisAlias to on(…)
Alias to on(…)
removeEventListener(…)thisAlias to off(…)
Alias to off(…)
clearAllEventListeners(…)thisAlias to off()
Alias to off()
addOneTimeEventListener(…)thisAlias to once(…)
Alias to once(…)
fireEvent(…)thisAlias to fire(…)
Alias to fire(…)
hasEventListeners(…)BooleanAlias to listens(…)
Alias to listens(…)
Used to load and display tile layers on the map. Extends GridLayer.
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.
L.tileLayer('https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);
+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);
@@ -5030,7 +5041,7 @@ URL template
'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:
+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'});
@@ -5055,7 +5066,7 @@ Extension methods
- L.tilelayer(<String> urlTemplate, <TileLayer options> options?)L.tilelayer(<String> urlTemplate, <TileLayer options> options?)Instantiates a tile layer object given a URL template and optionally an options object.
@@ -5163,7 +5174,7 @@ Options
-
+
@@ -5205,7 +5216,7 @@ Options
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.
+keepBuffer option in desktop browsers.
updateWhenZoomingBoolean
trueflyTo()) will update grid layers every integer zoom level. Setting this option to false will update the grid layer only when the smooth animation ends.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.updateIntervalboundsLatLngBounds
+LatLngBounds
undefinedLatLngBounds.LatLngBounds.maxNativeZoomfalsetrue, 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
+effect when the map CRS doesn't wrap around. Can be used
+in combination with bounds to prevent requesting
tiles outside the CRS limits.String
nullloading
- EventEventFired when the grid layer starts loading tiles.
tileunload
- TileEventTileEventFired when a tile is removed (e.g. when a tile goes off the screen).
tileloadstart
- TileEventTileEventFired when a tile is requested and starts loading.
tileerror
- TileErrorEventTileErrorEventFired when there is an error loading a tile.
tileload
- TileEventTileEventFired when a tile loads.
load
- EventEventFired when the grid layer loaded all visible tiles.
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
setUrl(<String> url, <Boolean> noRedraw?)thisUpdates the layer's URL template and redraws it (unless noRedraw is set to true).
Updates the layer's URL template and redraws it (unless noRedraw is set to true).
+If the URL does not change, the layer will not be redrawn unless
+the noRedraw parameter is set to false.
createTile(<Object> coords, <Function> done?)HTMLElementCalled only internally, overrides GridLayer's createTile()
+
Called only internally, overrides GridLayer's createTile()
to return an <img> HTML element with the appropriate image URL given coords. The done
callback is called when the tile has been loaded.
TileLayer might reimplement the following method.TileLayer might reimplement the following method.String |
Called only internally, returns the URL for a tile given its coordinates.
-Classes extending TileLayer can override this function to provide custom tile URL naming schemes.
|
@@ -5576,7 +5589,7 @@ setOpacity( |
this |
- Changes the opacity of the grid layer. +Changes the opacity of the grid layer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
setZIndex( |
this |
- Changes the zIndex of the grid layer. +Changes the zIndex of the grid layer. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getTileSize() |
- Point |
+ Point |
- Normalizes the tileSize option into a point. Used by the Normalizes the tileSize option into a point. Used by the |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removeFrom( |
+ removeFrom( |
this |
Removes the layer from the given map @@ -5704,7 +5717,7 @@Extension methods | getAttribution() |
String |
- Used by the Used by the |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bindPopup( |
+ bindPopup( |
this |
Binds a popup to the layer with the passed Extension methods |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
openPopup( |
+ openPopup( |
this |
- Opens the bound popup at the specified Opens the bound popup at the specified |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getPopup() |
- Popup |
+ Popup |
Returns the popup bound to this layer. |
@@ -5797,7 +5810,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bindTooltip( |
+ bindTooltip( |
this |
Binds a tooltip to the layer with the passed Extension methods |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
openTooltip( |
+ openTooltip( |
this |
- Opens the bound tooltip at the specified Opens the bound tooltip at the specified |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
getTooltip() |
- Tooltip |
+ Tooltip |
Returns the tooltip bound to this layer. |
@@ -5879,7 +5892,7 @@ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
addEventParent( |
+ addEventParent( |
this |
- Adds an event parent - an Adds an event parent - an |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removeEventParent( |
+ removeEventParent( |
this |
Removes an event parent, so it will stop receiving propagated events @@ -5971,42 +5984,42 @@Extension methods | addEventListener(…) |
this |
- Alias to Alias to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
removeEventListener(…) |
this |
- Alias to Alias to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
clearAllEventListeners(…) |
this |
- Alias to Alias to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
addOneTimeEventListener(…) |
this |
- Alias to Alias to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fireEvent(…) |
this |
- Alias to Alias to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hasEventListeners(…) |
Boolean |
- Alias to Alias to |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
L.tileLayer.wms( |
+ L.tileLayer.wms( |
Instantiates a WMS tile layer object given a base URL of the WMS service and a WMS parameters/options object. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
crs |
-CRS
+CRS
|
null |
Coordinate Reference System to use for the WMS requests, defaults to
@@ -6153,7 +6166,7 @@ Options
-
+
Options
-
+
OptionsLoad 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.keepBuffer option in desktop browsers. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
updateWhenZooming |
@@ -6302,7 +6315,7 @@ 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. |
+ 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 |
@@ -6323,10 +6336,10 @@ |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bounds |
-LatLngBounds
+LatLngBounds
|
undefined |
- If set, tiles will only be loaded inside the set LatLngBounds. |
+ If set, tiles will only be loaded inside the set LatLngBounds. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
maxNativeZoom |
@@ -6356,8 +6369,8 @@ 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
+effect when the map CRS doesn't wrap around. Can be used
+in combination with bounds to prevent requesting
tiles outside the CRS limits. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
null |
- String to be shown in the attribution control, describes the layer data, e.g. "© Mapbox". | +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. |
loading
- EventEventFired when the grid layer starts loading tiles.
tileunload
- TileEventTileEventFired when a tile is removed (e.g. when a tile goes off the screen).
tileloadstart
- TileEventTileEventFired when a tile is requested and starts loading.
tileerror
- TileErrorEventTileErrorEventFired when there is an error loading a tile.
tileload
- TileEventTileEventFired when a tile loads.
load
- EventEventFired when the grid layer loaded all visible tiles.
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
setUrl(<String> url, <Boolean> noRedraw?)thisUpdates the layer's URL template and redraws it (unless noRedraw is set to true).
Updates the layer's URL template and redraws it (unless noRedraw is set to true).
+If the URL does not change, the layer will not be redrawn unless
+the noRedraw parameter is set to false.
createTile(<Object> coords, <Function> done?)HTMLElementCalled only internally, overrides GridLayer's createTile()
+
Called only internally, overrides GridLayer's createTile()
to return an <img> HTML element with the appropriate image URL given coords. The done
callback is called when the tile has been loaded.
setZIndex(<Number> zIndex)thisChanges the zIndex of the grid layer.
+Changes the zIndex of the grid layer.
getTileSize()PointPointNormalizes the tileSize option into a point. Used by the createTile() method.
Normalizes the tileSize option into a point. Used by the createTile() method.
removeFrom(<Map> map)removeFrom(<Map> map)thisRemoves the layer from the given map
@@ -6798,7 +6813,7 @@getAttribution()StringUsed by the attribution control, returns the attribution option.
Used by the attribution control, returns the attribution option.
bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)thisBinds a popup to the layer with the passed content and sets up the
@@ -6842,10 +6857,10 @@
openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)thisOpens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
getPopup()PopupPopupReturns the popup bound to this layer.
bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)thisBinds a tooltip to the layer with the passed content and sets up the
@@ -6924,10 +6939,10 @@
openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)thisOpens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
getTooltip()TooltipTooltipReturns the tooltip bound to this layer.
addEventParent(<Evented> obj)addEventParent(<Evented> obj)thisAdds an event parent - an Evented that will receive propagated events
Adds an event parent - an Evented that will receive propagated events
removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)thisRemoves an event parent, so it will stop receiving propagated events
@@ -7065,42 +7080,42 @@addEventListener(…)thisAlias to on(…)
Alias to on(…)
removeEventListener(…)thisAlias to off(…)
Alias to off(…)
clearAllEventListeners(…)thisAlias to off()
Alias to off()
addOneTimeEventListener(…)thisAlias to once(…)
Alias to once(…)
fireEvent(…)thisAlias to fire(…)
Alias to fire(…)
hasEventListeners(…)BooleanAlias to listens(…)
Alias to listens(…)
Used to load and display a single image over specific bounds of the map. Extends Layer.
Used to load and display a single image over specific bounds of the map. Extends Layer.
L.imageOverlay(<String> imageUrl, <LatLngBounds> bounds, <ImageOverlay options> options?)L.imageOverlay(<String> imageUrl, <LatLngBounds> bounds, <ImageOverlay options> options?)Boolean
falsetrue, the image overlay will emit mouse events when clicked or hovered.true, the image overlay will emit mouse events when clicked or hovered.crossOrigintruetrue, a mouse event on this layer will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).L.DomEvent.stopPropagation is used).
String
'overlayPane'attributionString
nullload
- EventEventFired when the ImageOverlay layer has loaded its image
error
- EventEventFired when the ImageOverlay layer fails to load its image
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -7421,7 +7436,7 @@ Events
-
+
@@ -7439,13 +7454,13 @@ Events
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
@@ -7457,7 +7472,7 @@ Events
-
+
@@ -7475,13 +7490,13 @@ Events
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
@@ -7493,7 +7508,7 @@ Events
-
+
@@ -7511,13 +7526,13 @@ Events
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
@@ -7574,7 +7589,7 @@ Methods
- setBounds(<LatLngBounds> bounds)setBounds(<LatLngBounds> bounds)this
Update the bounds that this ImageOverlay covers
@@ -7584,12 +7599,12 @@ Methods
setZIndex(<Number> value)this
-Changes the zIndex of the image overlay.
+Changes the zIndex of the image overlay.
getBounds()LatLngBoundsLatLngBounds
Get the bounds that this ImageOverlay covers
@@ -7609,7 +7624,7 @@ Methods
-
+
@@ -7640,7 +7655,7 @@ Methods
- removeFrom(<Map> map)removeFrom(<Map> map)this
Removes the layer from the given map
@@ -7657,7 +7672,7 @@ Methods
getAttribution()String
-Used by the attribution control, returns the attribution option.
+Used by the attribution control, returns the attribution option.
@@ -7668,7 +7683,7 @@ Methods
-
+
@@ -7685,7 +7700,7 @@ Methods
- bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)this
Binds a popup to the layer with the passed content and sets up the
@@ -7701,10 +7716,10 @@
Methods
- openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)this
-Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
+Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
@@ -7737,7 +7752,7 @@ Methods
getPopup()PopupPopup
Returns the popup bound to this layer.
@@ -7750,7 +7765,7 @@ Methods
-
+
@@ -7767,7 +7782,7 @@ Methods
- bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)this
Binds a tooltip to the layer with the passed content and sets up the
@@ -7783,10 +7798,10 @@
Methods
- openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)this
-Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
+Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
@@ -7819,7 +7834,7 @@ Methods
getTooltip()TooltipTooltip
Returns the tooltip bound to this layer.
@@ -7832,7 +7847,7 @@ Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -7924,42 +7939,42 @@ Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -7970,7 +7985,7 @@ Methods
VideoOverlay
-Used to load and display a video player over specific bounds of the map. Extends ImageOverlay.
+
Used to load and display a video player over specific bounds of the map. Extends ImageOverlay.
A video overlay uses the <video>
HTML5 element.
@@ -8010,7 +8025,7 @@ Creation
- L.videoOverlay(<String|Array|HTMLVideoElement> video, <LatLngBounds> bounds, <VideoOverlay options> options?)L.videoOverlay(<String|Array|HTMLVideoElement> video, <LatLngBounds> bounds, <VideoOverlay options> options?)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.
@@ -8061,7 +8076,7 @@ Options
-
+
@@ -8100,7 +8115,7 @@ Options
Boolean
falseIf true, the image overlay will emit mouse events when clicked or hovered.
+ If true, the image overlay will emit mouse events when clicked or hovered.
crossOriginOptions
-
+
@@ -8168,7 +8183,7 @@ Options
trueWhen true, a mouse event on this layer will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).
+(unless L.DomEvent.stopPropagation is used).
@@ -8178,7 +8193,7 @@ Options
-
+
@@ -8201,7 +8216,7 @@ Options
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.
+ 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.
attributionOptions
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
@@ -8237,7 +8252,7 @@ Events
load
- EventEventFired when the video has finished loading the first frame
@@ -8248,7 +8263,7 @@ Events
-
+
@@ -8266,7 +8281,7 @@ Events
error
- EventEventFired when the ImageOverlay layer fails to load its image
@@ -8278,7 +8293,7 @@ Events
-
+
@@ -8296,43 +8311,43 @@ Events
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -8347,7 +8362,7 @@ Events
-
+
@@ -8365,13 +8380,13 @@ Events
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
@@ -8383,7 +8398,7 @@ Events
-
+
@@ -8401,13 +8416,13 @@ Events
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
@@ -8419,7 +8434,7 @@ Events
-
+
@@ -8437,13 +8452,13 @@ Events
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
@@ -8486,7 +8501,7 @@ Methods
-
+
@@ -8531,7 +8546,7 @@ Methods
- setBounds(<LatLngBounds> bounds)setBounds(<LatLngBounds> bounds)this
Update the bounds that this ImageOverlay covers
@@ -8541,12 +8556,12 @@ Methods
setZIndex(<Number> value)this
-Changes the zIndex of the image overlay.
+Changes the zIndex of the image overlay.
getBounds()LatLngBoundsLatLngBounds
Get the bounds that this ImageOverlay covers
@@ -8559,7 +8574,7 @@ Methods
-
+
@@ -8590,7 +8605,7 @@ Methods
- removeFrom(<Map> map)removeFrom(<Map> map)this
Removes the layer from the given map
@@ -8607,7 +8622,7 @@ Methods
getAttribution()String
-Used by the attribution control, returns the attribution option.
+Used by the attribution control, returns the attribution option.
@@ -8618,7 +8633,7 @@ Methods
-
+
@@ -8635,7 +8650,7 @@ Methods
- bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)this
Binds a popup to the layer with the passed content and sets up the
@@ -8651,10 +8666,10 @@
Methods
- openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)this
-Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
+Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
@@ -8687,7 +8702,7 @@ Methods
getPopup()PopupPopup
Returns the popup bound to this layer.
@@ -8700,7 +8715,7 @@ Methods
-
+
@@ -8717,7 +8732,7 @@ Methods
- bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)this
Binds a tooltip to the layer with the passed content and sets up the
@@ -8733,10 +8748,10 @@
Methods
- openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)this
-Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
+Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
@@ -8769,7 +8784,7 @@ Methods
getTooltip()TooltipTooltip
Returns the tooltip bound to this layer.
@@ -8782,7 +8797,7 @@ Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -8874,42 +8889,42 @@ Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -8921,7 +8936,7 @@ Methods
Path
An abstract class that contains options and constants shared between vector
-overlays (Polygon, Polyline, Circle). Do not use it directly. Extends Layer.
+overlays (Polygon, Polyline, Circle). Do not use it directly. Extends Layer.
Options
@@ -8995,7 +9010,7 @@ Options
String
nullA string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
+ A string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
dashOffsetOptions
String
nullA string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas-powered layers in some old browsers.
+ 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.
fillOptions
String
*Fill color. Defaults to the value of the color option
+ Fill color. Defaults to the value of the color option
fillOpacityOptions
trueWhen true, a mouse event on this path will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).
+(unless L.DomEvent.stopPropagation is used).
renderer
-Renderer
+Renderer
Use this specific instance of Renderer for this path. Takes
-precedence over the map's default renderer.
+ Use this specific instance of Renderer for this path. Takes
+precedence over the map's default renderer.
classNameOptions
-
+
@@ -9103,7 +9118,7 @@ Options
-
+
@@ -9126,7 +9141,7 @@ Options
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.
+ 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.
attributionOptions
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
@@ -9150,7 +9165,7 @@ Events
-
+
@@ -9168,43 +9183,43 @@ Events
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -9219,7 +9234,7 @@ Events
-
+
@@ -9237,13 +9252,13 @@ Events
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
@@ -9255,7 +9270,7 @@ Events
-
+
@@ -9273,13 +9288,13 @@ Events
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
@@ -9291,7 +9306,7 @@ Events
-
+
@@ -9309,13 +9324,13 @@ Events
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
@@ -9351,10 +9366,10 @@ Methods
- setStyle(<Path options> style)setStyle(<Path options> style)this
-Changes the appearance of a Path based on the options in the Path options object.
+Changes the appearance of a Path based on the options in the Path options object.
@@ -9378,7 +9393,7 @@ Methods
-
+
@@ -9409,7 +9424,7 @@ Methods
- removeFrom(<Map> map)removeFrom(<Map> map)this
Removes the layer from the given map
@@ -9426,7 +9441,7 @@ Methods
getAttribution()String
-Used by the attribution control, returns the attribution option.
+Used by the attribution control, returns the attribution option.
@@ -9437,7 +9452,7 @@ Methods
-
+
@@ -9454,7 +9469,7 @@ Methods
- bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)this
Binds a popup to the layer with the passed content and sets up the
@@ -9470,10 +9485,10 @@
Methods
- openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)this
-Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
+Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
@@ -9506,7 +9521,7 @@ Methods
getPopup()PopupPopup
Returns the popup bound to this layer.
@@ -9519,7 +9534,7 @@ Methods
-
+
@@ -9536,7 +9551,7 @@ Methods
- bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)this
Binds a tooltip to the layer with the passed content and sets up the
@@ -9552,10 +9567,10 @@
Methods
- openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)this
-Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
+Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
@@ -9588,7 +9603,7 @@ Methods
getTooltip()TooltipTooltip
Returns the tooltip bound to this layer.
@@ -9601,7 +9616,7 @@ Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -9693,42 +9708,42 @@ Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -9739,7 +9754,7 @@ Methods
Polyline
-A class for drawing polyline overlays on a map. Extends Path.
+A class for drawing polyline overlays on a map. Extends Path.
Usage example
@@ -9794,9 +9809,9 @@ Creation
- L.polyline(<LatLng[]> latlngs, <Polyline options> options?)L.polyline(<LatLng[]> latlngs, <Polyline options> options?)Instantiates a polyline object given an array of geographical points and
-optionally an options object. You can create a Polyline object with
+optionally an options object. You can create a Polyline object with
multiple separate lines (MultiPolyline) by passing an array of arrays
of geographic points.
@@ -9848,7 +9863,7 @@ Options
-
+
@@ -9919,7 +9934,7 @@ Options
String
nullA string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
+ A string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
dashOffsetOptions
String
nullA string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas-powered layers in some old browsers.
+ 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.
fillOptions
String
*Fill color. Defaults to the value of the color option
+ Fill color. Defaults to the value of the color option
fillOpacityOptions
trueWhen true, a mouse event on this path will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).
+(unless L.DomEvent.stopPropagation is used).
renderer
-Renderer
+Renderer
Use this specific instance of Renderer for this path. Takes
-precedence over the map's default renderer.
+ Use this specific instance of Renderer for this path. Takes
+precedence over the map's default renderer.
classNameOptions
-
+
@@ -10028,7 +10043,7 @@ Options
-
+
@@ -10051,7 +10066,7 @@ Options
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.
+ 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.
attributionOptions
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
@@ -10075,7 +10090,7 @@ Events
-
+
@@ -10093,43 +10108,43 @@ Events
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -10144,7 +10159,7 @@ Events
-
+
@@ -10162,13 +10177,13 @@ Events
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
@@ -10180,7 +10195,7 @@ Events
-
+
@@ -10198,13 +10213,13 @@ Events
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
@@ -10216,7 +10231,7 @@ Events
-
+
@@ -10234,13 +10249,13 @@ Events
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
@@ -10272,7 +10287,7 @@ Methods
toGeoJSON()Object
-Returns a GeoJSON representation of the polyline (as a GeoJSON LineString or MultiLineString Feature).
+Returns a GeoJSON representation of the polyline (as a GeoJSON LineString or MultiLineString Feature).
@@ -10297,33 +10312,33 @@ Methods
- closestLayerPoint(<Point> p)PointclosestLayerPoint(<Point> p)Point
Returns the point closest to p on the Polyline.
getCenter()LatLngLatLng
Returns the center (centroid) of the polyline.
getBounds()LatLngBoundsLatLngBounds
-Returns the LatLngBounds of the path.
+Returns the LatLngBounds of the path.
- addLatLng(<LatLng> latlng)addLatLng(<LatLng> latlng)this
Adds a given point to the polyline. By default, adds to the first ring of
the polyline in case of a multi-polyline, but can be overridden by passing
-a specific ring as a LatLng array (that you can earlier access with getLatLngs).
+a specific ring as a LatLng array (that you can earlier access with getLatLngs).
@@ -10333,7 +10348,7 @@ Methods
-
+
@@ -10357,10 +10372,10 @@ Methods
- setStyle(<Path options> style)setStyle(<Path options> style)this
-Changes the appearance of a Path based on the options in the Path options object.
+Changes the appearance of a Path based on the options in the Path options object.
@@ -10385,7 +10400,7 @@ Methods
-
+
@@ -10416,7 +10431,7 @@ Methods
- removeFrom(<Map> map)removeFrom(<Map> map)this
Removes the layer from the given map
@@ -10433,7 +10448,7 @@ Methods
getAttribution()String
-Used by the attribution control, returns the attribution option.
+Used by the attribution control, returns the attribution option.
@@ -10444,7 +10459,7 @@ Methods
-
+
@@ -10461,7 +10476,7 @@ Methods
- bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)this
Binds a popup to the layer with the passed content and sets up the
@@ -10477,10 +10492,10 @@
Methods
- openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)this
-Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
+Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
@@ -10513,7 +10528,7 @@ Methods
getPopup()PopupPopup
Returns the popup bound to this layer.
@@ -10526,7 +10541,7 @@ Methods
-
+
@@ -10543,7 +10558,7 @@ Methods
- bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)this
Binds a tooltip to the layer with the passed content and sets up the
@@ -10559,10 +10574,10 @@
Methods
- openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)this
-Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
+Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
@@ -10595,7 +10610,7 @@ Methods
getTooltip()TooltipTooltip
Returns the tooltip bound to this layer.
@@ -10608,7 +10623,7 @@ Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -10700,42 +10715,42 @@ Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -10746,7 +10761,7 @@ Methods
Polygon
-A class for drawing polygon overlays on a map. Extends Polyline.
+
A class for drawing polygon overlays on a map. Extends Polyline.
Note that points you pass when creating a polygon shouldn't have an additional last point equal to the first one — it's better to filter out such points.
@@ -10804,7 +10819,7 @@ Creation
- L.polygon(<LatLng[]> latlngs, <Polyline options> options?)L.polygon(<LatLng[]> latlngs, <Polyline options> options?)
@@ -10820,7 +10835,7 @@ Options
-
+
@@ -10862,7 +10877,7 @@ Options
-
+
@@ -10933,7 +10948,7 @@ Options
String
nullA string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
+ A string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
dashOffsetOptions
String
nullA string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas-powered layers in some old browsers.
+ 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.
fillOptions
String
*Fill color. Defaults to the value of the color option
+ Fill color. Defaults to the value of the color option
fillOpacityOptions
trueWhen true, a mouse event on this path will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).
+(unless L.DomEvent.stopPropagation is used).
renderer
-Renderer
+Renderer
Use this specific instance of Renderer for this path. Takes
-precedence over the map's default renderer.
+ Use this specific instance of Renderer for this path. Takes
+precedence over the map's default renderer.
classNameOptions
-
+
@@ -11042,7 +11057,7 @@ Options
-
+
@@ -11065,7 +11080,7 @@ Options
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.
+ 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.
attributionOptions
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
@@ -11089,7 +11104,7 @@ Events
-
+
@@ -11107,43 +11122,43 @@ Events
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -11158,7 +11173,7 @@ Events
-
+
@@ -11176,13 +11191,13 @@ Events
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
@@ -11194,7 +11209,7 @@ Events
-
+
@@ -11212,13 +11227,13 @@ Events
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
@@ -11230,7 +11245,7 @@ Events
-
+
@@ -11248,13 +11263,13 @@ Events
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
@@ -11286,7 +11301,7 @@ Methods
toGeoJSON()Object
-Returns a GeoJSON representation of the polygon (as a GeoJSON Polygon or MultiPolygon Feature).
+Returns a GeoJSON representation of the polygon (as a GeoJSON Polygon or MultiPolygon Feature).
@@ -11296,7 +11311,7 @@ Methods
-
+
@@ -11334,33 +11349,33 @@ Methods
- closestLayerPoint(<Point> p)PointclosestLayerPoint(<Point> p)Point
Returns the point closest to p on the Polyline.
getCenter()LatLngLatLng
Returns the center (centroid) of the polyline.
getBounds()LatLngBoundsLatLngBounds
-Returns the LatLngBounds of the path.
+Returns the LatLngBounds of the path.
- addLatLng(<LatLng> latlng)addLatLng(<LatLng> latlng)this
Adds a given point to the polyline. By default, adds to the first ring of
the polyline in case of a multi-polyline, but can be overridden by passing
-a specific ring as a LatLng array (that you can earlier access with getLatLngs).
+a specific ring as a LatLng array (that you can earlier access with getLatLngs).
@@ -11371,7 +11386,7 @@ Methods
-
+
@@ -11395,10 +11410,10 @@ Methods
- setStyle(<Path options> style)setStyle(<Path options> style)this
-Changes the appearance of a Path based on the options in the Path options object.
+Changes the appearance of a Path based on the options in the Path options object.
@@ -11423,7 +11438,7 @@ Methods
-
+
@@ -11454,7 +11469,7 @@ Methods
- removeFrom(<Map> map)removeFrom(<Map> map)this
Removes the layer from the given map
@@ -11471,7 +11486,7 @@ Methods
getAttribution()String
-Used by the attribution control, returns the attribution option.
+Used by the attribution control, returns the attribution option.
@@ -11482,7 +11497,7 @@ Methods
-
+
@@ -11499,7 +11514,7 @@ Methods
- bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)this
Binds a popup to the layer with the passed content and sets up the
@@ -11515,10 +11530,10 @@
Methods
- openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)this
-Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
+Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
@@ -11551,7 +11566,7 @@ Methods
getPopup()PopupPopup
Returns the popup bound to this layer.
@@ -11564,7 +11579,7 @@ Methods
-
+
@@ -11581,7 +11596,7 @@ Methods
- bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)this
Binds a tooltip to the layer with the passed content and sets up the
@@ -11597,10 +11612,10 @@
Methods
- openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)this
-Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
+Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
@@ -11633,7 +11648,7 @@ Methods
getTooltip()TooltipTooltip
Returns the tooltip bound to this layer.
@@ -11646,7 +11661,7 @@ Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -11738,42 +11753,42 @@ Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -11784,7 +11799,7 @@ Methods
Rectangle
-A class for drawing rectangle overlays on a map. Extends Polygon.
+A class for drawing rectangle overlays on a map. Extends Polygon.
Usage example
@@ -11825,7 +11840,7 @@ Creation
- L.rectangle(<LatLngBounds> latLngBounds, <Polyline options> options?)L.rectangle(<LatLngBounds> latLngBounds, <Polyline options> options?)
@@ -11841,7 +11856,7 @@ Options
-
+
@@ -11883,7 +11898,7 @@ Options
-
+
@@ -11954,7 +11969,7 @@ Options
String
nullA string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
+ A string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
dashOffsetOptions
String
nullA string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas-powered layers in some old browsers.
+ 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.
fillOptions
String
*Fill color. Defaults to the value of the color option
+ Fill color. Defaults to the value of the color option
fillOpacityOptions
trueWhen true, a mouse event on this path will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).
+(unless L.DomEvent.stopPropagation is used).
renderer
-Renderer
+Renderer
Use this specific instance of Renderer for this path. Takes
-precedence over the map's default renderer.
+ Use this specific instance of Renderer for this path. Takes
+precedence over the map's default renderer.
classNameOptions
-
+
@@ -12063,7 +12078,7 @@ Options
-
+
@@ -12086,7 +12101,7 @@ Options
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.
+ 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.
attributionOptions
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
@@ -12110,7 +12125,7 @@ Events
-
+
@@ -12128,43 +12143,43 @@ Events
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -12179,7 +12194,7 @@ Events
-
+
@@ -12197,13 +12212,13 @@ Events
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
@@ -12215,7 +12230,7 @@ Events
-
+
@@ -12233,13 +12248,13 @@ Events
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
@@ -12251,7 +12266,7 @@ Events
-
+
@@ -12269,13 +12284,13 @@ Events
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
@@ -12304,7 +12319,7 @@ Methods
- setBounds(<LatLngBounds> latLngBounds)setBounds(<LatLngBounds> latLngBounds)this
Redraws the rectangle with the passed bounds.
@@ -12317,7 +12332,7 @@ Methods
@@ -12348,7 +12363,7 @@ Methods
-
+
@@ -12386,33 +12401,33 @@ Methods
- closestLayerPoint(<Point> p)PointclosestLayerPoint(<Point> p)Point
Returns the point closest to p on the Polyline.
getCenter()LatLngLatLng
Returns the center (centroid) of the polyline.
getBounds()LatLngBoundsLatLngBounds
-Returns the LatLngBounds of the path.
+Returns the LatLngBounds of the path.
- addLatLng(<LatLng> latlng)addLatLng(<LatLng> latlng)this
Adds a given point to the polyline. By default, adds to the first ring of
the polyline in case of a multi-polyline, but can be overridden by passing
-a specific ring as a LatLng array (that you can earlier access with getLatLngs).
+a specific ring as a LatLng array (that you can earlier access with getLatLngs).
@@ -12423,7 +12438,7 @@ Methods
-
+
@@ -12447,10 +12462,10 @@ Methods
- setStyle(<Path options> style)setStyle(<Path options> style)this
-Changes the appearance of a Path based on the options in the Path options object.
+Changes the appearance of a Path based on the options in the Path options object.
@@ -12475,7 +12490,7 @@ Methods
-
+
@@ -12506,7 +12521,7 @@ Methods
- removeFrom(<Map> map)removeFrom(<Map> map)this
Removes the layer from the given map
@@ -12523,7 +12538,7 @@ Methods
getAttribution()String
-Used by the attribution control, returns the attribution option.
+Used by the attribution control, returns the attribution option.
@@ -12534,7 +12549,7 @@ Methods
-
+
@@ -12551,7 +12566,7 @@ Methods
- bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)this
Binds a popup to the layer with the passed content and sets up the
@@ -12567,10 +12582,10 @@
Methods
- openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)this
-Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
+Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
@@ -12603,7 +12618,7 @@ Methods
getPopup()PopupPopup
Returns the popup bound to this layer.
@@ -12616,7 +12631,7 @@ Methods
-
+
@@ -12633,7 +12648,7 @@ Methods
- bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)this
Binds a tooltip to the layer with the passed content and sets up the
@@ -12649,10 +12664,10 @@
Methods
- openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)this
-Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
+Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
@@ -12685,7 +12700,7 @@ Methods
getTooltip()TooltipTooltip
Returns the tooltip bound to this layer.
@@ -12698,7 +12713,7 @@ Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -12790,42 +12805,42 @@ Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -12836,7 +12851,7 @@ Methods
Circle
-A class for drawing circle overlays on a map. Extends CircleMarker.
+
A class for drawing circle overlays on a map. Extends CircleMarker.
It's an approximation and starts to diverge from a real circle closer to poles (due to projection distortion).
@@ -12873,12 +12888,12 @@ Creation
- L.circle(<LatLng> latlng, <Circle options> options?)L.circle(<LatLng> latlng, <Circle options> options?)Instantiates a circle object given a geographical point, and an options object
which contains the circle radius.
- L.circle(<LatLng> latlng, <Number> radius, <Circle options> options?)L.circle(<LatLng> latlng, <Number> radius, <Circle options> options?)Obsolete way of instantiating a circle, for compatibility with 0.7.x code.
Do not use in new applications or plugins.
@@ -12921,7 +12936,7 @@ Options
-
+
@@ -12992,7 +13007,7 @@ Options
String
nullA string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
+ A string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
dashOffsetOptions
String
nullA string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas-powered layers in some old browsers.
+ 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.
fillOptions
String
*Fill color. Defaults to the value of the color option
+ Fill color. Defaults to the value of the color option
fillOpacityOptions
trueWhen true, a mouse event on this path will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).
+(unless L.DomEvent.stopPropagation is used).
renderer
-Renderer
+Renderer
Use this specific instance of Renderer for this path. Takes
-precedence over the map's default renderer.
+ Use this specific instance of Renderer for this path. Takes
+precedence over the map's default renderer.
classNameOptions
-
+
@@ -13101,7 +13116,7 @@ Options
-
+
@@ -13124,7 +13139,7 @@ Options
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.
+ 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.
attributionOptions
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
@@ -13148,7 +13163,7 @@ Events
-
+
@@ -13166,43 +13181,43 @@ Events
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -13217,7 +13232,7 @@ Events
-
+
@@ -13235,13 +13250,13 @@ Events
add
- EventEventFired after the layer is added to a map
remove
- EventEventFired after the layer is removed from a map
@@ -13253,7 +13268,7 @@ Events
-
+
@@ -13271,13 +13286,13 @@ Events
popupopen
- PopupEventPopupEventFired when a popup bound to this layer is opened
popupclose
- PopupEventPopupEventFired when a popup bound to this layer is closed
@@ -13289,7 +13304,7 @@ Events
-
+
@@ -13307,13 +13322,13 @@ Events
tooltipopen
- TooltipEventTooltipEventFired when a tooltip bound to this layer is opened.
tooltipclose
- TooltipEventTooltipEventFired when a tooltip bound to this layer is closed.
@@ -13357,9 +13372,9 @@ Methods
getBounds()LatLngBoundsLatLngBounds
-Returns the LatLngBounds of the path.
+Returns the LatLngBounds of the path.
@@ -13369,7 +13384,7 @@ Methods
-
+
@@ -13389,11 +13404,11 @@ Methods
toGeoJSON()Object
-Returns a GeoJSON representation of the circle marker (as a GeoJSON Point Feature).
+Returns a GeoJSON representation of the circle marker (as a GeoJSON Point Feature).
- setLatLng(<LatLng> latLng)setLatLng(<LatLng> latLng)this
Sets the position of a circle marker to a new location.
@@ -13401,7 +13416,7 @@ Methods
getLatLng()LatLngLatLng
Returns the current geographical position of the circle marker
@@ -13414,7 +13429,7 @@ Methods
-
+
@@ -13438,10 +13453,10 @@ Methods
- setStyle(<Path options> style)setStyle(<Path options> style)this
-Changes the appearance of a Path based on the options in the Path options object.
+Changes the appearance of a Path based on the options in the Path options object.
@@ -13466,7 +13481,7 @@ Methods
-
+
@@ -13497,7 +13512,7 @@ Methods
- removeFrom(<Map> map)removeFrom(<Map> map)this
Removes the layer from the given map
@@ -13514,7 +13529,7 @@ Methods
getAttribution()String
-Used by the attribution control, returns the attribution option.
+Used by the attribution control, returns the attribution option.
@@ -13525,7 +13540,7 @@ Methods
-
+
@@ -13542,7 +13557,7 @@ Methods
- bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)bindPopup(<String|HTMLElement|Function|Popup> content, <Popup options> options?)this
Binds a popup to the layer with the passed content and sets up the
@@ -13558,10 +13573,10 @@
Methods
- openPopup(<LatLng> latlng?)openPopup(<LatLng> latlng?)this
-Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
+Opens the bound popup at the specified latlng or at the default popup anchor if no latlng is passed.
@@ -13594,7 +13609,7 @@ Methods
getPopup()PopupPopup
Returns the popup bound to this layer.
@@ -13607,7 +13622,7 @@ Methods
-
+
@@ -13624,7 +13639,7 @@ Methods
- bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)bindTooltip(<String|HTMLElement|Function|Tooltip> content, <Tooltip options> options?)this
Binds a tooltip to the layer with the passed content and sets up the
@@ -13640,10 +13655,10 @@
Methods
- openTooltip(<LatLng> latlng?)openTooltip(<LatLng> latlng?)this
-Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
+Opens the bound tooltip at the specified latlng or at the default tooltip anchor if no latlng is passed.
@@ -13676,7 +13691,7 @@ Methods
getTooltip()TooltipTooltip
Returns the tooltip bound to this layer.
@@ -13689,7 +13704,7 @@ Methods
- addEventParent(<Evented> obj)addEventParent(<Evented> obj)this
-Adds an event parent - an Evented that will receive propagated events
+Adds an event parent - an Evented that will receive propagated events
- removeEventParent(<Evented> obj)removeEventParent(<Evented> obj)this
Removes an event parent, so it will stop receiving propagated events
@@ -13781,42 +13796,42 @@ Methods
addEventListener(…)this
-Alias to on(…)
+Alias to on(…)
removeEventListener(…)this
-Alias to off(…)
+Alias to off(…)
clearAllEventListeners(…)this
-Alias to off()
+Alias to off()
addOneTimeEventListener(…)this
-Alias to once(…)
+Alias to once(…)
fireEvent(…)this
-Alias to fire(…)
+Alias to fire(…)
hasEventListeners(…)Boolean
-Alias to listens(…)
+Alias to listens(…)
@@ -13827,7 +13842,7 @@ Methods
CircleMarker
-A circle of a fixed size with radius specified in pixels. Extends Path.
+A circle of a fixed size with radius specified in pixels. Extends Path.
Creation
@@ -13846,7 +13861,7 @@ Creation
- L.circleMarker(<LatLng> latlng, <CircleMarker options> options?)L.circleMarker(<LatLng> latlng, <CircleMarker options> options?)Instantiates a circle marker object given a geographical point, and an optional options object.
@@ -13888,7 +13903,7 @@ Options
-
+
@@ -13959,7 +13974,7 @@ Options
String
nullA string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
+ A string that defines the stroke dash pattern. Doesn't work on Canvas-powered layers in some old browsers.
dashOffsetOptions
String
nullA string that defines the distance into the dash pattern to start the dash. Doesn't work on Canvas-powered layers in some old browsers.
+ 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.
fillOptions
String
*Fill color. Defaults to the value of the color option
+ Fill color. Defaults to the value of the color option
fillOpacityOptions
trueWhen true, a mouse event on this path will trigger the same event on the map
-(unless L.DomEvent.stopPropagation is used).
+(unless L.DomEvent.stopPropagation is used).
renderer
-Renderer
+Renderer
Use this specific instance of Renderer for this path. Takes
-precedence over the map's default renderer.
+ Use this specific instance of Renderer for this path. Takes
+precedence over the map's default renderer.
classNameOptions
-
+
@@ -14068,7 +14083,7 @@ Options
-
+
@@ -14091,7 +14106,7 @@ Options
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.
+ 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.
attributionOptions
String
nullString to be shown in the attribution control, describes the layer data, e.g. "© Mapbox".
+ 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.
@@ -14115,7 +14130,7 @@ Events
-
+
@@ -14133,43 +14148,43 @@ Events
click
- MouseEventMouseEventFired when the user clicks (or taps) the layer.
dblclick
- MouseEventMouseEventFired when the user double-clicks (or double-taps) the layer.
mousedown
- MouseEventMouseEventFired when the user pushes the mouse button on the layer.
mouseup
- MouseEventMouseEventFired when the user releases the mouse button pushed on the layer.
mouseover
- MouseEventMouseEventFired when the mouse enters the layer.
mouseout
- MouseEventMouseEventFired when the mouse leaves the layer.
contextmenu
- MouseEventMouseEventFired 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
@@ -14184,7 +14199,7 @@ Events
map.getPaneor -map.getPanesmethods. New panes can be created with the -map.createPanemethod. -Every map has the following default panes that differ only in zIndex.