6382 lines
216 KiB
HTML
6382 lines
216 KiB
HTML
---
|
||
layout: default
|
||
title: Documentation
|
||
bodyclass: api-page
|
||
---
|
||
|
||
<div id="toc" class="clearfix">
|
||
<div class="span-5 colborder">
|
||
<h4>Map</h4>
|
||
<ul>
|
||
<li><a href="#map-usage">Usage example</a></li>
|
||
<li><a href="#map-constructor">Creation</a></li>
|
||
<li><a href="#map-options">Options</a></li>
|
||
<li><a href="#map-events">Events</a></li>
|
||
</ul>
|
||
<h4>Map Methods</h4>
|
||
<ul>
|
||
<li><a href="#map-set-methods">For modifying map state</a></li>
|
||
<li><a href="#map-get-methods">For getting map state</a></li>
|
||
<li><a href="#map-stuff-methods">For layers and controls</a></li>
|
||
<li><a href="#map-conversion-methods">Conversion methods</a></li>
|
||
<li><a href="#map-misc-methods">Other methods</a></li>
|
||
</ul>
|
||
<h4>Map Misc</h4>
|
||
<ul>
|
||
<li><a href="#map-properties">Properties</a></li>
|
||
<li><a href="#map-panes">Panes</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span-3">
|
||
<h4>UI Layers</h4>
|
||
<ul>
|
||
<li><a href="#marker">Marker</a></li>
|
||
<li><a href="#popup">Popup</a></li>
|
||
</ul>
|
||
<h4>Raster Layers</h4>
|
||
<ul>
|
||
<li><a href="#tilelayer">TileLayer</a></li>
|
||
<li><a href="#tilelayer-wms">TileLayer.WMS</a></li>
|
||
<li><a href="#tilelayer-canvas">TileLayer.Canvas</a></li>
|
||
<li><a href="#imageoverlay">ImageOverlay</a></li>
|
||
</ul>
|
||
<h4>Vector Layers</h4>
|
||
<ul>
|
||
<li><a href="#path">Path</a></li>
|
||
<li><a href="#polyline">Polyline</a></li>
|
||
<li><a href="#multipolyline">MultiPolyline</a></li>
|
||
<li><a href="#polygon">Polygon</a></li>
|
||
<li><a href="#multipolygon">MultiPolygon</a></li>
|
||
<li><a href="#rectangle">Rectangle</a></li>
|
||
<li><a href="#circle">Circle</a></li>
|
||
<li><a href="#circlemarker">CircleMarker</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span-3">
|
||
<h4>Other Layers</h4>
|
||
<ul>
|
||
<li><a href="#layergroup">LayerGroup</a></li>
|
||
<li><a href="#featuregroup">FeatureGroup</a></li>
|
||
<li><a href="#geojson">GeoJSON</a></li>
|
||
</ul>
|
||
<h4>Basic Types</h4>
|
||
<ul>
|
||
<li><a href="#latlng">LatLng</a></li>
|
||
<li><a href="#latlngbounds">LatLngBounds</a></li>
|
||
<li><a href="#point">Point</a></li>
|
||
<li><a href="#bounds">Bounds</a></li>
|
||
<li><a href="#icon">Icon</a></li>
|
||
<li><a href="#divicon">DivIcon</a></li>
|
||
</ul>
|
||
<h4>Controls</h4>
|
||
<ul>
|
||
<li><a href="#control">Control</a></li>
|
||
<li><a href="#control-zoom">Zoom</a></li>
|
||
<li><a href="#control-attribution">Attribution</a></li>
|
||
<li><a href="#control-layers">Layers</a></li>
|
||
<li><a href="#control-scale">Scale</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span-3">
|
||
<h4>Events</h4>
|
||
<ul>
|
||
<li><a href="#events">Event methods</a></li>
|
||
<li><a href="#event-objects">Event objects</a></li>
|
||
</ul>
|
||
<h4>Utility</h4>
|
||
<ul>
|
||
<li><a href="#class">Class</a></li>
|
||
<li><a href="#browser">Browser</a></li>
|
||
<li><a href="#util">Util</a></li>
|
||
<li><a href="#transformation">Transformation</a></li>
|
||
<li><a href="#lineutil">LineUtil</a></li>
|
||
<li><a href="#polyutil">PolyUtil</a></li>
|
||
</ul>
|
||
<h4>DOM Utility</h4>
|
||
<ul>
|
||
<li><a href="#domevent">DomEvent</a></li>
|
||
<li><a href="#domutil">DomUtil</a></li>
|
||
<li><a href="#posanimation">PosAnimation</a></li>
|
||
<li><a href="#draggable">Draggable</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="span-3 last">
|
||
<h4>Interfaces</h4>
|
||
<ul>
|
||
<li><a href="#ihandler">IHandler</a></li>
|
||
<li><a href="#ilayer">ILayer</a></li>
|
||
<!--<li><a class="nodocs" href="#">IFeature</a></li>-->
|
||
<li><a href="#icontrol">IControl</a></li>
|
||
<li><a href="#iprojection">IProjection</a></li>
|
||
<li><a href="#icrs">ICRS</a></li>
|
||
</ul>
|
||
|
||
<h4>Misc</h4>
|
||
<ul>
|
||
<li><a href="#global">global switches</a></li>
|
||
<li><a href="#noconflict">noConflict</a></li>
|
||
<li><a href="#version">version</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<!--<a href="#toc" id="back-to-top">↑</a>-->
|
||
|
||
<hr />
|
||
<p>This reference reflects <strong>Leaflet 0.7</strong>.
|
||
Docs for 0.6 are available <a href="https://github.com/Leaflet/Leaflet/archive/gh-pages-0.6.zip">in the source form</a> (see <a href="https://github.com/Leaflet/Leaflet/blob/master/CONTRIBUTING.md#improving-documentation">instructions for running docs</a>).</p>
|
||
|
||
<h2 id="map-class">Map</h2>
|
||
|
||
<p>The central class of the API — it is used to create a map on a page and manipulate it.</p>
|
||
|
||
<h3 id="map-usage">Usage example</h3>
|
||
|
||
<pre><code class="javascript">// 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
|
||
});</code></pre>
|
||
|
||
<h3 id="map-constructor" class="left">Creation</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.map</b>(
|
||
<nobr><HTMLElement|String> <i>id</i>,</nobr>
|
||
<nobr><<a href="#map-options">Map options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates a map object given a div element (or its id) and optionally an object literal with map options described below.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h3 id="map-options">Options</h3>
|
||
|
||
<h4>Map State Options</h4>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>center</b></code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>Initial geographical center of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoom</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>Initial map zoom.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layers</b></code></td>
|
||
<td><code><a href="#ilayer">ILayer</a>[]</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>Layers that will be added to the map initially.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>minZoom</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>Minimum zoom level of the map. Overrides any <code>minZoom</code> set on map layers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maxZoom</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>Maximum zoom level of the map. This overrides any <code>maxZoom</code> set on map layers.</td>
|
||
</tr>
|
||
<tr id="map-maxbounds">
|
||
<td><code><b>maxBounds</b></code></td>
|
||
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>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 <a href="#map-setmaxbounds">setMaxBounds</a> method</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>crs</b></code></td>
|
||
<td><code><a href="#icrs">CRS</a></code></td>
|
||
<td><code>L.CRS.<br/>EPSG3857</code></td>
|
||
<td>Coordinate Reference System to use. Don't change this if you're not sure what it means.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Interaction Options</h4>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="width140">Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dragging</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the map be draggable with mouse/touch or not.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>touchZoom</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the map can be zoomed by touch-dragging with two fingers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>scrollWheelZoom</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the map can be zoomed by using the mouse wheel. If passed <code><span class="string">'center'</span></code>, it will zoom to the center of the view regardless of where the mouse was.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>doubleClickZoom</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the map can be zoomed in by double clicking on it and zoomed out by double clicking while holding shift. If passed <code><span class="string">'center'</span></code>, double-click zoom will zoom to the center of the view regardless of where the mouse was.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>boxZoom</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the map can be zoomed to a rectangular area specified by dragging the mouse while pressing shift.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tap</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Enables mobile hacks for supporting instant taps (fixing 200ms click delay on iOS/Android) and touch holds (fired as <code>contextmenu</code> events).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tapTolerance</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">15</span></code></td>
|
||
<td>The max number of pixels a user can shift his finger during touch for it to be considered a valid tap.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>trackResize</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the map automatically handles browser window resize to update itself.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>worldCopyJump</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>closePopupOnClick</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Set it to <code><span class="literal">false</span></code> if you don't want popups to close when user clicks the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bounceAtZoomLimits</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Set it to <code><span class="literal">false</span></code> if you don't want the map to zoom beyond min/max zoom and then bounce back when pinch-zooming.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Keyboard Navigation Options</h4>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="width140">Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>keyboard</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Makes the map focusable and allows users to navigate the map with keyboard arrows and <code>+</code>/<code>-</code> keys.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>keyboardPanOffset</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">80</span></code></td>
|
||
<td>Amount of pixels to pan when pressing an arrow key.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>keyboardZoomOffset</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">1</span></code></td>
|
||
<td>Number of zoom levels to change when pressing <code>+</code> or <code>-</code> key.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Panning Inertia Options</h4>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="width140">Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>inertia</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>inertiaDeceleration</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">3000</span></code></td>
|
||
<td>The rate with which the inertial movement slows down, in pixels/second<sup>2</sup>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>inertiaMaxSpeed</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">1500</span></code></td>
|
||
<td>Max speed of the inertial movement, in pixels/second.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>inertiaThreshold</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code>depends</code></td>
|
||
<td>Number of milliseconds that should pass between stopping the movement and releasing the mouse or touch to prevent inertial movement. <code><span class="number">32</span></code> for touch devices and <code><span class="number">14</span></code> for the rest by default.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Control options</h4>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="width140">Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomControl</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the <a href="#control-zoom">zoom control</a> is added to the map by default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>attributionControl</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the <a href="#control-attribution">attribution control</a> is added to the map by default.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h4>Animation options</h4>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="width140">Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>fadeAnimation</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>Whether the tile fade animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomAnimation</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>Whether the tile zoom animation is enabled. By default it's enabled in all browsers that support CSS3 Transitions except Android.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomAnimationThreshold</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><span class="number">4</span></td>
|
||
<td>Won't animate zoom if the zoom difference exceeds this value.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>markerZoomAnimation</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>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.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h3 id="map-events">Events</h3>
|
||
|
||
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Event</th>
|
||
<th>Data</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>click</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user clicks (or taps) the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dblclick</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user double-clicks (or double-taps) the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mousedown</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user pushes the mouse button on the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseup</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user releases the mouse button on the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseover</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the mouse enters the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseout</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the mouse leaves the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mousemove</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired while the mouse moves over the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contextmenu</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user pushes the right mouse button on the map, prevents default browser context menu from showing if there are listeners on this event. Also fired on mobile when the user holds a single touch for a second (also called long press).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>focus</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the user focuses the map either by tabbing to it or clicking/panning.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>blur</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the map loses focus.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>preclick</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired before mouse click on the map (sometimes useful when you want something to happen on click before any existing click handlers start running).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>load</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the map is initialized (when its center and zoom are set for the first time).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>unload</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the map is destroyed with <a href="#map-remove">remove</a> method.</td>
|
||
</tr>
|
||
<tr id="map-viewreset">
|
||
<td><code><b>viewreset</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the map needs to redraw its content (this usually happens on map zoom or load). Very useful for creating custom overlays.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>movestart</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the view of the map starts changing (e.g. user starts dragging the map).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>move</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired on any movement of the map view.</td>
|
||
</tr>
|
||
<tr id="map-moveend">
|
||
<td><code><b>moveend</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the view of the map ends changed (e.g. user stopped dragging the map).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dragstart</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the user starts dragging the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>drag</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired repeatedly while the user drags the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dragend</b></code></td>
|
||
<td><code><a href="#dragend-event">DragEndEvent</a></code></td>
|
||
<td>Fired when the user stops dragging the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomstart</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the map zoom is about to change (e.g. before zoom animation).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomend</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the map zoom changes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomlevelschange</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the number of zoomlevels on the map is changed due to adding or removing a layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>resize</b></code></td>
|
||
<td><code><a href="#resize-event">ResizeEvent</a></code></td>
|
||
<td>Fired when the map is resized.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>autopanstart</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the map starts autopanning when opening a popup.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layeradd</b></code></td>
|
||
<td><code><a href="#layer-event">LayerEvent</a></code></td>
|
||
<td>Fired when a new layer is added to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layerremove</b></code></td>
|
||
<td><code><a href="#layer-event">LayerEvent</a></code></td>
|
||
<td>Fired when some layer is removed from the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>baselayerchange</b></code></td>
|
||
<td><code><a href="#layer-event">LayerEvent</a></code>
|
||
<td>Fired when the base layer is changed through the <a href="#control-layers">layer control</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>overlayadd</b></code></td>
|
||
<td><code><a href="#layer-event">LayerEvent</a></code>
|
||
<td>Fired when an overlay is selected through the <a href="#control-layers">layer control</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>overlayremove</b></code></td>
|
||
<td><code><a href="#layer-event">LayerEvent</a></code>
|
||
<td>Fired when an overlay is deselected through the <a href="#control-layers">layer control</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>locationfound</b></code></td>
|
||
<td><code><a href="#location-event">LocationEvent</a></code>
|
||
<td>Fired when geolocation (using the <a href="#map-locate">locate</a> method) went successfully.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>locationerror</b></code></td>
|
||
<td><code><a href="#error-event">ErrorEvent</a></code>
|
||
<td>Fired when geolocation (using the <a href="map-locate">locate</a> method) failed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupopen</b></code></td>
|
||
<td><code><a href="#popup-event">PopupEvent</a></code></td>
|
||
<td>Fired when a popup is opened (using <code>openPopup</code> method).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupclose</b></code></td>
|
||
<td><code><a href="#popup-event">PopupEvent</a></code></td>
|
||
<td>Fired when a popup is closed (using <code>closePopup</code> method).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h3 id="map-set-methods">Methods for Modifying Map State</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setView</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>center</i>,</nobr>
|
||
<nobr><Number> <i>zoom?</i>,</nobr>
|
||
<nobr><<a href="#map-zoompanoptions">zoom/pan options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the view of the map (geographical center and zoom) with the given animation options.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setZoom</b>(
|
||
<nobr><Number> <i>zoom</i></nobr>,
|
||
<nobr><<a href="#map-zoomoptions">zoom options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the zoom of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomIn</b>(
|
||
<nobr><Number> <em>delta?</em></nobr>,
|
||
<nobr><<a href="#map-zoomoptions">zoom options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Increases the zoom of the map by <code>delta</code> (<code><span class="number">1</span></code> by default).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomOut</b>(
|
||
<nobr><Number> <em>delta?</em></nobr>,
|
||
<nobr><<a href="#map-zoomoptions">zoom options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Decreases the zoom of the map by <code>delta</code> (<code><span class="number">1</span></code> by default).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setZoomAround</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i>, </nobr>
|
||
<nobr><Number> <i>zoom</i></nobr>,
|
||
<nobr><<a href="#map-zoomoptions">zoom options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Zooms the map while keeping a specified point on the map stationary (e.g. used internally for scroll zoom and double-click zoom).</td>
|
||
</tr>
|
||
<tr id="map-fitbounds">
|
||
<td><code><b>fitBounds</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr>,
|
||
<nobr><<a href="#map-fitboundsoptions">fitBounds options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets a map view that contains the given geographical bounds with the maximum zoom level possible.</td>
|
||
</tr>
|
||
<tr id="map-fitworld">
|
||
<td><code><b>fitWorld</b>(
|
||
<nobr><<a href="#map-fitboundsoptions">fitBounds options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets a map view that mostly contains the whole world with the maximum zoom level possible.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>panTo</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
|
||
<nobr><<a href="#map-panoptions">pan options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Pans the map to a given center. Makes an animated pan if new center is not more than one screen away from the current one.</td>
|
||
</tr>
|
||
<tr id="map-paninsidebounds">
|
||
<td><code><b>panInsideBounds</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr>,
|
||
<nobr><<a href="#map-panoptions">pan options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>panBy</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
|
||
<nobr><<a href="#map-panoptions">pan options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Pans the map by a given number of pixels (animated).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>invalidateSize</b>(
|
||
<nobr><Boolean> <i>animate</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>invalidateSize</b>(
|
||
<nobr><<a href="#map-zoompanoptions">zoom/pan options</a>> <i>options</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>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 <code>options.pan</code> is <code><span class="literal">false</span></code>, panning will not occur. If <code>options.debounceMoveend</code> is <code><span class="literal">true</span></code>, it will delay <code>moveend</code> event so that it doesn't happen often even if the method is called many times in a row.</td>
|
||
</tr>
|
||
<tr id="map-setmaxbounds">
|
||
<td><code><b>setMaxBounds</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr><!--,
|
||
<nobr><<a href="#map-zoompanoptions">zoom/pan options</a>> <i>options?</i> )</nobr>-->
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Restricts the map view to the given bounds (see <a href="#map-maxbounds">map maxBounds</a> option)<!--, animating the map view if bounds are changed. The given animation options are passed through to `setView` or `panInsideBounds`, depending on map zoom level, and can be used to control how the map animates during this change-->.</td>
|
||
</tr>
|
||
<tr id="map-locate">
|
||
<td><code><b>locate</b>(
|
||
<nobr><<a href="#map-locate-options">Locate options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Tries to locate the user using the <a href="https://en.wikipedia.org/wiki/W3C_Geolocation_API">Geolocation API</a>, firing a <code>locationfound</code> event with location data on success or a <code>locationerror</code> 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). See <a href="#map-locate-options">Locate options</a> for more details.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>stopLocate</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Stops watching location previously initiated by <code><b>map.locate</b>({watch: true})</code> and aborts resetting the map view if <code>map.locate</code> was called with <code>{setView: true}</code>.</td>
|
||
</tr>
|
||
<tr id="map-remove">
|
||
<td><code><b>remove</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Destroys the map and clears all related event listeners.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="map-get-methods">Methods for Getting Map State</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getCenter</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the geographical center of the map view.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getZoom</b>()</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Returns the current zoom of the map view.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getMinZoom</b>()</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Returns the minimum zoom level of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getMaxZoom</b>()</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Returns the maximum zoom level of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getBounds</b>()</code></td>
|
||
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
|
||
<td>Returns the LatLngBounds of the current map view.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getBoundsZoom</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i>,</nobr>
|
||
<nobr><Boolean> <i>inside?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Number</code></td>
|
||
|
||
<td>Returns the maximum zoom level on which the given bounds fit to the map view in its entirety. If <code>inside</code> (optional) is set to <code><span class="literal">true</span></code>, the method instead returns the minimum zoom level on which the map view fits into the given bounds in its entirety.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getSize</b>()</code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the current size of the map container.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getPixelBounds</b>()</code></td>
|
||
<td><code><a href="#bounds">Bounds</a></code></td>
|
||
<td>Returns the bounds of the current map view in projected pixel coordinates (sometimes useful in layer and overlay implementations).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getPixelOrigin</b>()</code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the projected pixel coordinates of the top left point of the map layer (useful in custom layer and overlay implementations).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="map-stuff-methods">Methods for Layers and Controls</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr id="map-addlayer">
|
||
<td><code><b>addLayer</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i>,</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the given layer to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeLayer</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes the given layer from the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>hasLayer</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the given layer is currently added to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>eachLayer</b>(
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Iterates over the layers of the map, optionally specifying context of the iterator function.
|
||
<pre><code>map.eachLayer(function (layer) {
|
||
layer.bindPopup('Hello');
|
||
});</code></pre>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr id="map-openpopup">
|
||
<td><code><b>openPopup</b>(
|
||
<nobr><<a href="#popup">Popup</a>> <i>popup</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Opens the specified popup while closing the previously opened (to make sure only one is opened at one time for usability).</td>
|
||
</tr>
|
||
<tr id="map-openpopup2">
|
||
<td><code><b>openPopup</b>(
|
||
<nobr><String> <i>html</i> </nobr> | <nobr><HTMLElement> <i>el</i>,
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
|
||
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Creates a popup with the specified options and opens it in the given point on a map.</td>
|
||
</tr>
|
||
<tr id="map-closepopup">
|
||
<td><code><b>closePopup</b>(
|
||
<nobr><<a href="#popup">Popup</a>> <i>popup?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Closes the popup previously opened with <a href="#map-openpopup">openPopup</a> (or the given one).</td>
|
||
</tr>
|
||
<tr id="map-addcontrol">
|
||
<td><code><b>addControl</b>(
|
||
<nobr><<a href="#icontrol">IControl</a>> <i>control</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the given control to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeControl</b>(
|
||
<nobr><<a href="#icontrol">IControl</a>> <i>control</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes the given control from the map.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h3 id="map-conversion-methods">Conversion Methods</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="width200">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>latLngToLayerPoint</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the map layer point that corresponds to the given geographical coordinates (useful for placing overlays on the map).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layerPointToLatLng</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the geographical coordinates of a given map layer point.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>containerPointToLayerPoint</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Converts the point relative to the map container to a point relative to the map layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layerPointToContainerPoint</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Converts the point relative to the map layer to a point relative to the map container.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>latLngToContainerPoint</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the map container point that corresponds to the given geographical coordinates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>containerPointToLatLng</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the geographical coordinates of a given map container point.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>project</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i>,</nobr>
|
||
<nobr><Number> <i>zoom?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Projects the given geographical coordinates to absolute pixel coordinates for the given zoom level (current zoom level by default).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>unproject</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i>,</nobr>
|
||
<nobr><Number> <i>zoom?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Projects the given absolute pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseEventToContainerPoint</b>(
|
||
<nobr><MouseEvent> <i>event</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the pixel coordinates of a mouse click (relative to the top left corner of the map) given its event object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseEventToLayerPoint</b>(
|
||
<nobr><MouseEvent> <i>event</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the pixel coordinates of a mouse click relative to the map layer given its event object.
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseEventToLatLng</b>(
|
||
<nobr><MouseEvent> <i>event</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the geographical coordinates of the point the mouse clicked on given the click's event object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="map-misc-methods">Other Methods</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getContainer</b>()</code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Returns the container element of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getPanes</b>()</code></td>
|
||
<td><code><a href="#map-panes">MapPanes</a></code></td>
|
||
<td>Returns an object with different map panes (to render overlays in).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>whenReady</b>(
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr></code></td>
|
||
<td><code>this</code></td>
|
||
<td>Runs the given callback when the map gets initialized with a place and zoom, or immediately if it happened already, optionally passing a function context.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="map-locate-options">Locate options</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>watch</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, starts continous watching of location changes (instead of detecting it once) using W3C <code>watchPosition</code> method. You can later stop watching using <code><b>map.stopLocate</b>()</code> method.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setView</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, automatically sets the map view to the user location with respect to detection accuracy, or to world view if geolocation failed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maxZoom</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">Infinity</span></code></td>
|
||
<td>The maximum zoom for automatic view setting when using `setView` option.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>timeout</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">10000</span></code></td>
|
||
<td>Number of milliseconds to wait for a response from geolocation before firing a <code>locationerror</code> event.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maximumAge</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">0</span></code></td>
|
||
<td>Maximum age of detected location. If less than this amount of milliseconds passed since last geolocation response, <code>locate</code> will return a cached location.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>enableHighAccuracy</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>Enables high accuracy, see <a href="http://dev.w3.org/geo/api/spec-source.html#high-accuracy">description in the W3C spec</a>.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h3 id="map-zoompanoptions">Zoom/pan options</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>reset</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, the map view will be completely reset (without any animations).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>pan</b></code></td>
|
||
<td><code><a href="#map-panoptions">pan options</a></code></td>
|
||
<td><code>-</code></td>
|
||
<td>Sets the options for the panning (without the zoom change) if it occurs.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoom</b></code></td>
|
||
<td><code><a href="#map-zoomoptions">zoom options</a></code></td>
|
||
<td><code>-</code></td>
|
||
<td>Sets the options for the zoom change if it occurs.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>animate</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">-</span></code></td>
|
||
<td>An equivalent of passing <code>animate</code> to both zoom and pan options (see below).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="map-panoptions">Pan options</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>animate</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code>-</code></td>
|
||
<td>If <code><span class="literal">true</span></code>, panning will always be animated if possible. If <code><span class="literal">false</span></code>, 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).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>duration</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">0.25</span></code></td>
|
||
<td>Duration of animated panning.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>easeLinearity</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">0.25</span></code></td>
|
||
<td>The curvature factor of panning animation easing (third parameter of the <a href="http://cubic-bezier.com/">Cubic Bezier curve</a>). <span class="number">1.0</span> means linear animation, the less the more bowed the curve.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>noMoveStart</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, panning won't fire <code>movestart</code> event on start (used internally for panning inertia).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="map-zoomoptions">Zoom options</h3>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>animate</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code>-</code></td>
|
||
<td>If not specified, zoom animation will happen if the zoom origin is inside the current view. If <code><span class="literal">true</span></code>, the map will attempt animating zoom disregarding where zoom origin is. Setting <code><span class="literal">false</span></code> will make it always reset the view completely without animation.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="map-fitboundsoptions">fitBounds options</h3>
|
||
|
||
<p>The same as <a href="#map-zoompanoptions">zoom/pan options</a> and additionally:</p>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>paddingTopLeft</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td><code><nobr>[<span class="number">0</span>, <span class="number">0</span>]</nobr>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>paddingBottomRight</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td><code><nobr>[<span class="number">0</span>, <span class="number">0</span>]</nobr>
|
||
<td>The same for bottom right corner of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>padding</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td><code><nobr>[<span class="number">0</span>, <span class="number">0</span>]</nobr>
|
||
<td>Equivalent of setting both top left and bottom right padding to the same value.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maxZoom</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><nobr><span class="literal">null</span></nobr></code></td>
|
||
<td>The maximum possible zoom to use.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h3 id="map-properties">Properties</h3>
|
||
|
||
<p>Map properties include interaction handlers that allow you to control interaction behavior in runtime, enabling or disabling certain features such as dragging or touch zoom (see <a href="#ihandler">IHandler</a> methods). Example:</p>
|
||
|
||
<pre><code class="javascript">map.doubleClickZoom.disable();</code></pre>
|
||
|
||
<p>You can also access default map controls like attribution control through map properties:</p>
|
||
|
||
<pre><code class="javascript">map.attributionControl.addAttribution("Earthquake data &copy; GeoNames");</code></pre>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="minwidth">Property</th>
|
||
<th class="minwidth">Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dragging</b></code></td>
|
||
<td><a href="#ihandler"><code>IHandler</code></a></td>
|
||
<td>Map dragging handler (by both mouse and touch).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>touchZoom</b></code></td>
|
||
<td><a href="#ihandler"><code>IHandler</code></a></td>
|
||
<td>Touch zoom handler.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>doubleClickZoom</b></code></td>
|
||
<td><a href="#ihandler"><code>IHandler</code></a></td>
|
||
<td>Double click zoom handler.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>scrollWheelZoom</b></code></td>
|
||
<td><a href="#ihandler"><code>IHandler</code></a></td>
|
||
<td>Scroll wheel zoom handler.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>boxZoom</b></code></td>
|
||
<td><a href="#ihandler"><code>IHandler</code></a></td>
|
||
<td>Box (shift-drag with mouse) zoom handler.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>keyboard</b></code></td>
|
||
<td><a href="#ihandler"><code>IHandler</code></a></td>
|
||
<td>Keyboard navigation handler.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tap</b></code></td>
|
||
<td><a href="#ihandler"><code>IHandler</code></a></td>
|
||
<td>Mobile touch hacks (quick tap and touch hold) handler.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomControl</b></code></td>
|
||
<td><a href="#control-zoom"><code>Control.Zoom</code></a></td>
|
||
<td>Zoom control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>attributionControl</b></code></td>
|
||
<td><a href="#control-attribution"><code>Control.Attribution</code></a></td>
|
||
<td>Attribution control.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h3 id="map-panes">Map Panes</h3>
|
||
|
||
<p>An object literal (returned by <a href="#map-getpanes">map.getPanes</a></code>) that contains different map panes that you can use to put your custom overlays in. The difference is mostly in zIndex order that such overlays get.</p>
|
||
|
||
<table data-id='map'>
|
||
<tr>
|
||
<th class="width100">Property</th>
|
||
<th class="width100">Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mapPane</b></code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Pane that contains all other map panes.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tilePane</b></code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Pane for tile layers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>objectsPane</b></code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Pane that contains all the panes except tile pane.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>shadowPane</b></code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Pane for overlay shadows (e.g. marker shadows).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>overlayPane</b></code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Pane for overlays like polylines and polygons.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>markerPane</b></code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Pane for marker icons.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupPane</b></code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Pane for popups.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="marker">Marker</h2>
|
||
|
||
<p>Used to put markers on the map.</p>
|
||
|
||
<pre><code class="javascript">L.marker([50.5, 30.5]).addTo(map);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='marker'>
|
||
<tr>
|
||
<th class="width200">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.marker</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i>,</nobr>
|
||
<nobr><<a href="#marker-options">Marker options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Instantiates a Marker object given a geographical point and optionally an options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="marker-options">Options</h3>
|
||
|
||
<table data-id='marker'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>icon</b></code></td>
|
||
<td><code><a href="#icon">L.Icon</a></code></td>
|
||
<td>*</td>
|
||
<td>Icon class to use for rendering the marker. See <a href="#icon">Icon documentation</a> for details on how to customize the marker icon. Set to <code>new L.Icon.Default()</code> by default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>clickable</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>If <code><span class="literal">false</span></code>, the marker will not emit mouse events and will act as a part of the underlying map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>draggable</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>Whether the marker is draggable with mouse/touch or not.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>keyboard</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether the marker can be tabbed to with a keyboard and clicked by pressing enter.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>title</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">''</span></code></td>
|
||
<td>Text for the browser tooltip that appear on marker hover (no tooltip by default).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>alt</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">''</span></code></td>
|
||
<td>Text for the <code>alt</code> attribute of the icon image (useful for accessibility).</td>
|
||
</tr>
|
||
<tr id="marker-zindexoffset">
|
||
<td><code><b>zIndexOffset</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">0</span></code></td>
|
||
<td>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 <code>1000</code> (or high negative value, respectively).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>opacity</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">1.0</span></code></td>
|
||
<td>The opacity of the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>riseOnHover</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, the marker will get on top of others when you hover the mouse over it.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>riseOffset</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">250</span></code></td>
|
||
<td>The z-index offset used for the <code>riseOnHover</code> feature.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Events</h3>
|
||
|
||
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
|
||
|
||
<table data-id='marker'>
|
||
<tr>
|
||
<th class="width100">Event</th>
|
||
<th class="width100">Data</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>click</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user clicks (or taps) the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dblclick</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user double-clicks (or double-taps) the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mousedown</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user pushes the mouse button on the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseover</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the mouse enters the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseout</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the mouse leaves the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contextmenu</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code>
|
||
<td>Fired when the user right-clicks on the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dragstart</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the user starts dragging the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>drag</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired repeatedly while the user drags the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dragend</b></code></td>
|
||
<td><code><a href="#dragend-event">DragEndEvent</a></code></td>
|
||
<td>Fired when the user stops dragging the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>move</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the marker is moved via setLatLng. New coordinate include in event arguments.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>add</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the marker is added to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>remove</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the marker is removed from the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupopen</b></code></td>
|
||
<td><code><a href="#popup-event">PopupEvent</a></code></td>
|
||
<td>Fired when a popup bound to the marker is open.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupclose</b></code></td>
|
||
<td><code><a href="#popup-event">PopupEvent</a></code></td>
|
||
<td>Fired when a popup bound to the marker is closed.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='marker'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addTo</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the marker to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getLatLng</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the current geographical position of the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setLatLng</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Changes the marker position to the given point.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setIcon</b>(
|
||
<nobr><<a href="#icon">Icon</a>> <i>icon</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Changes the marker icon.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setZIndexOffset</b>(
|
||
<nobr><Number> <i>offset</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Changes the <a href="#marker-zindexoffset">zIndex offset</a> of the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setOpacity</b>(
|
||
<nobr><Number> <i>opacity</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Changes the opacity of the marker.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>update</b>()</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Updates the marker position, useful if coordinates of its <code>latLng</code> object were changed directly.</td>
|
||
</tr>
|
||
<tr id="marker-bindpopup">
|
||
<td><code><b>bindPopup</b>(
|
||
<nobr><String> <i>html</i> |</nobr> <nobr><HTMLElement> <i>el</i> |</nobr> <nobr><<a href="#popup">Popup</a>> <i>popup</i>,</nobr>
|
||
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Binds a popup with a particular HTML content to a click on this marker. You can also open the bound popup with the Marker <a href="#marker-openpopup">openPopup</a> method.</td>
|
||
</tr>
|
||
<tr id="marker-unbindpopup">
|
||
<td><code><b>unbindPopup</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Unbinds the popup previously bound to the marker with <code>bindPopup</code>.</td>
|
||
</tr>
|
||
<tr id="marker-openpopup">
|
||
<td><code><b>openPopup</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Opens the popup previously bound by the <a href="#marker-bindpopup">bindPopup</a> method.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getPopup</b>()</code></td>
|
||
<td><code><a href="#popup">Popup</a></code></td>
|
||
<td>Returns the popup previously bound by the <a href="#marker-bindpopup">bindPopup</a> method.</td>
|
||
</tr>
|
||
<tr id="marker-closepopup">
|
||
<td><code><b>closePopup</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Closes the bound popup of the marker if it's opened.</td>
|
||
</tr>
|
||
<tr id="marker-togglepopup">
|
||
<td><code><b>togglePopup</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Toggles the popup previously bound by the <a href="#marker-bindpopup">bindPopup</a> method.</td>
|
||
</tr>
|
||
<tr id="marker-bindpopup">
|
||
<td><code><b>setPopupContent</b>(
|
||
<nobr><String> <i>html</i> |</nobr> <nobr><HTMLElement> <i>el</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets an HTML content of the popup of this marker.</td>
|
||
</tr>
|
||
<tr id="marker-togeojson">
|
||
<td><code><b>toGeoJSON</b>()</code></td>
|
||
<td><code>Object</code></td>
|
||
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the marker (GeoJSON Point Feature).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="marker-interaction-handlers">Interaction handlers</h3>
|
||
|
||
<p>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 <a href="#ihandler">IHandler</a> methods). Example:</p>
|
||
|
||
<pre><code class="javascript">marker.dragging.disable();</code></pre>
|
||
|
||
<table data-id='marker'>
|
||
<tr>
|
||
<th class="width100">Property</th>
|
||
<th class="width100">Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td>dragging</td>
|
||
<td><a href="#ihandler"><code>IHandler</code></a></td>
|
||
<td>Marker dragging handler (by both mouse and touch).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="popup">Popup</h2>
|
||
|
||
<p>Used to open popups in certain places of the map. Use <a href="#map-openpopup">Map#openPopup</a> to open popups while making sure that only one popup is open at one time (recommended for usability), or use <a href="#map-addlayer">Map#addLayer</a> to open as many as you want.</p>
|
||
|
||
<h3>Usage example</h3>
|
||
<p>If you want to just bind a popup to marker click and then open it, it's really easy:</p>
|
||
<pre><code class="javascript">marker.bindPopup(popupContent).openPopup();</code></pre>
|
||
<p>Path overlays like polylines also have a <code>bindPopup</code> method. Here's a more complicated way to open a popup on a map:</p>
|
||
|
||
<pre><code class="javascript">var popup = L.popup()
|
||
.setLatLng(latlng)
|
||
.setContent('<p>Hello world!<br />This is a nice popup.</p>')
|
||
.openOn(map);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='popup'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.popup</b>(
|
||
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i>,</nobr>
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>source?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>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 ILayer to which it refers.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="popup-options">Options</h3>
|
||
|
||
<table data-id='popup'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maxWidth</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">300</span></code></td>
|
||
<td>Max width of the popup.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>minWidth</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">50</span></code></td>
|
||
<td>Min width of the popup.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maxHeight</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>If set, creates a scrollable container of the given height inside a popup if its content exceeds it.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>autoPan</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Set it to <code><span class="literal">false</span></code> if you don't want the map to do panning animation to fit the opened popup.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>keepInView</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>Set it to <code><span class="literal">true</span></code> if you want to prevent users from panning the popup off of the screen while it is open.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>closeButton</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Controls the presense of a close button in the popup.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>offset</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td><code><nobr>Point(<span class="number">0</span>, <span class="number">6</span>)</nobr>
|
||
</code></td>
|
||
<td>The offset of the popup position. Useful to control the anchor of the popup when opening it on some overlays.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>autoPanPaddingTopLeft</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
</code></td>
|
||
<td>The margin between the popup and the top left corner of the map view after autopanning was performed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>autoPanPaddingBottomRight</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
</code></td>
|
||
<td>The margin between the popup and the bottom right corner of the map view after autopanning was performed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>autoPanPadding</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td><code><nobr>Point(<span class="number">5</span>, <span class="number">5</span>)</nobr>
|
||
</code></td>
|
||
<td>Equivalent of setting both top left and bottom right autopan padding to the same value.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomAnimation</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether to animate the popup on zoom. Disable it if you have problems with Flash content inside popups.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>closeOnClick</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>Set it to <code><span class="literal">false</span></code> if you want to override the default behavior of the popup closing when user clicks the map (set globally by the <code>Map</code> <code>closePopupOnClick</code> option).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>className</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code class="javascript"><span class="string">''</span></code></td>
|
||
<td>A custom class name to assign to the popup.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='popup'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th class="minwidth">Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addTo</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the popup to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>openOn</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the popup to the map and closes the previous one. The same as <code>map.openPopup(popup)</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setLatLng</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the geographical point where the popup will open.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getLatLng</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the geographical point of popup.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setContent</b>(
|
||
<nobr><String|HTMLElement> <i>htmlContent</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the HTML content of the popup.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getContent</b>()</code></td>
|
||
<td><code><String|HTMLElement></code></td>
|
||
<td>Returns the content of the popup.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>update</b>()</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Updates the popup content, layout and position. Useful for updating the popup after something inside changed, e.g. image loaded.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="tilelayer">TileLayer</h2>
|
||
|
||
<p>Used to load and display tile layers on the map, implements <a href="#ilayer">ILayer</a> interface.</p>
|
||
|
||
<h3>Usage example</h3>
|
||
|
||
<pre><code class="javascript">L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar'}).addTo(map);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='tilelayer'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.tileLayer</b>(
|
||
<nobr><String> <i><a href="#url-template">urlTemplate</a></i>,</nobr>
|
||
<nobr><<a href="#tilelayer-options">TileLayer options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates a tile layer object given a <a href="#url-template">URL template</a> and optionally an options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="url-template">URL template</h3>
|
||
|
||
<p>A string of the following form:</p>
|
||
|
||
<pre><code class="javascript">'http://{s}.somedomain.com/blabla/{z}/{x}/{y}.png'</code></pre>
|
||
|
||
<p><code>{s}</code> means one of the available subdomains (used sequentially to help with browser parallel requests per domain limitation; subdomain values are specified in options; <code>a</code>, <code>b</code> or <code>c</code> by default, can be omitted), <code>{z}</code> — zoom level, <code>{x}</code> and <code>{y}</code> — tile coordinates.</p>
|
||
|
||
<p>You can use custom keys in the template, which will be <a href="#util-template">evaluated</a> from TileLayer options, like this:</p>
|
||
|
||
<pre><code class="javascript">L.tileLayer('http://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});</code></pre>
|
||
|
||
<h3 id="tilelayer-options">Options</h3>
|
||
|
||
<table data-id='tilelayer'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>minZoom</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">0</span></code></td>
|
||
<td>Minimum zoom number.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maxZoom</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">18</span></code></td>
|
||
<td>Maximum zoom number.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maxNativeZoom</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>Maximum zoom number the tiles source has available. If it is specified, the tiles on all zoom levels higher than <code>maxNativeZoom</code> will be loaded from <code>maxZoom</code> level and auto-scaled.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tileSize</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">256</span></code></td>
|
||
<td>Tile size (width and height in pixels, assuming tiles are square).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>subdomains</b></code></td>
|
||
<td><code>String</code> or <code>String[]</code></td>
|
||
<td><code><span class="string">'abc'</span></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>errorTileUrl</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">''</span></code></td>
|
||
<td>URL to the tile image to show in place of the tile that failed to load.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>attribution</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">''</span></code></td>
|
||
<td>e.g. "© Mapbox" — the string used by the attribution control, describes the layer data.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tms</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, inverses Y axis numbering for tiles (turn this on for TMS services).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>continuousWorld</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If set to <code><span class="literal">true</span></code>, the tile coordinates won't be wrapped by world width (-180 to 180 longitude) or clamped to lie within world height (-90 to 90). Use this if you use Leaflet for maps that don't reflect the real world (e.g. game, indoor or photo maps).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>noWrap</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If set to <code><span class="literal">true</span></code>, the tiles just won't load outside the world width (-180 to 180 longitude) instead of repeating.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomOffset</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">0</span></code></td>
|
||
<td>The zoom number used in tile URLs will be offset with this value.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomReverse</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If set to <code><span class="literal">true</span></code>, the zoom number used in tile URLs will be reversed (<code>maxZoom - zoom</code> instead of <code>zoom</code>)</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>opacity</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">1.0</span></code></td>
|
||
<td>The opacity of the tile layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zIndex</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>The explicit zIndex of the tile layer. Not set by default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>unloadInvisibleTiles</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>If <code><span class="literal">true</span></code>, all the tiles that are not visible after panning are removed (for better performance). <code><span class="literal">true</span></code> by default on mobile WebKit, otherwise <code><span class="literal">false</span></code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>updateWhenIdle</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>If <code><span class="literal">false</span></code>, new tiles are loaded during panning, otherwise only after it (for better performance). <code><span class="literal">true</span></code> by default on mobile WebKit, otherwise <code><span class="literal">false</span></code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>detectRetina</b></code></td>
|
||
<td><code><code>Boolean</code></code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code> 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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>reuseTiles</b></code></td>
|
||
<td><code><code>Boolean</code></code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, all the tiles that are not visible after panning are placed in a reuse queue from which they will be fetched when new tiles become visible (as opposed to dynamically creating new ones). This will in theory keep memory usage low and eliminate the need for reserving new memory whenever a new tile is needed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bounds</b></code></td>
|
||
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>When this option is set, the TileLayer only loads tiles that are in the given geographical bounds.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Events</h3>
|
||
|
||
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
|
||
|
||
<table data-id='tilelayer'>
|
||
<tr>
|
||
<th class="width100">Event</th>
|
||
<th class="width100">Data</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>loading</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the tile layer starts loading tiles.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>load</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the tile layer loaded all visible tiles.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tileloadstart</b></code></td>
|
||
<td><code><a href="#tile-event">TileEvent</a></code></td>
|
||
<td>Fired when a tile is requested and starts loading.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tileload</b></code></td>
|
||
<td><code><a href="#tile-event">TileEvent</a></code></td>
|
||
<td>Fired when a tile loads.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tileunload</b></code></td>
|
||
<td><code><a href="#tile-event">TileEvent</a></code></td>
|
||
<td>Fired when a tile is removed (e.g. when you have <code>unloadInvisibleTiles</code> on).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='tilelayer'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addTo</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the layer to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bringToFront</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Brings the tile layer to the top of all tile layers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bringToBack</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Brings the tile layer to the bottom of all tile layers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setOpacity</b>(
|
||
<nobr><Number> <i>opacity</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Changes the opacity of the tile layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setZIndex</b>(
|
||
<nobr><Number> <i>zIndex</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the zIndex of the tile layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>redraw</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Causes the layer to clear all the tiles and request them again.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setUrl</b>(
|
||
<nobr><String> <i><a href="#url-template">urlTemplate</a></i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Updates the layer's URL template and redraws it.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getContainer</b>()</nobr>
|
||
</code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Returns the HTML element that contains the tiles for this layer.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="tilelayer-wms">TileLayer.WMS</h2>
|
||
|
||
<p>Used to display WMS services as tile layers on the map. Extends <a href="#tilelayer">TileLayer</a>.</p>
|
||
|
||
<h3>Usage example</h3>
|
||
|
||
<pre><code class="javascript">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"
|
||
});</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='tilelayer-wms'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.tileLayer.wms</b>(
|
||
<nobr><String> <i>baseUrl</i></nobr>,
|
||
<nobr><<a href="#tilelayer-wms-options">TileLayer.WMS options</a>> <i>options</i> )</nobr>
|
||
|
||
|
||
<td>Instantiates a WMS tile layer object given a base URL of the WMS service and a WMS parameters/options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="tilelayer-wms-options">Options</h3>
|
||
|
||
<p>Includes all <a href="#tilelayer-options">TileLayer options</a> and additionally:</p>
|
||
|
||
<table data-id='tilelayer-wms'>
|
||
<tr>
|
||
<th class="width100">Option</th>
|
||
<th class="width100">Type</th>
|
||
<th class="width100">Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layers</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">''</span></code></td>
|
||
<td><b>(required)</b> Comma-separated list of WMS layers to show.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>styles</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">''</span></code></td>
|
||
<td>Comma-separated list of WMS styles.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>format</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'image/jpeg'</span></code></td>
|
||
<td>WMS image format (use <code><span class="string">'image/png'</span></code> for layers with transparency).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>transparent</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, the WMS service will return images with transparency.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>version</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'1.1.1'</span></code></td>
|
||
<td>Version of the WMS service to use.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>crs</b></code></td>
|
||
<td><code><a href="#icrs">CRS</a></code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='tilelayer-wms'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setParams</b>(
|
||
<nobr><<a href="#tilelayer-wms-options">WMS parameters</a>> <i>params</i></nobr>,
|
||
<nobr><Boolean> <i>noRedraw?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Merges an object with the new parameters and re-requests tiles on the current screen (unless <code>noRedraw</code> was set to <code><span class="literal">true</span></code>).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="tilelayer-canvas">TileLayer.Canvas</h2>
|
||
|
||
<p>Used to create Canvas-based tile layers where tiles get drawn on the browser side. Extends <a href="#tilelayer">TileLayer</a>.</p>
|
||
|
||
<h3>Usage example</h3>
|
||
|
||
<pre><code class="javascript">var canvasTiles = L.tileLayer.canvas();
|
||
|
||
canvasTiles.drawTile = function(canvas, tilePoint, zoom) {
|
||
var ctx = canvas.getContext('2d');
|
||
// draw something on the tile canvas
|
||
}</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='tilelayer-canvas'>
|
||
<tr>
|
||
<th class="width200">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.tileLayer.canvas</b>(
|
||
<nobr><<a href="#tilelayer-options">TileLayer options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Instantiates a Canvas tile layer object given an options object (optionally).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Options</h3>
|
||
<table data-id='tilelayer-canvas'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>async</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>Indicates that tiles will be drawn asynchronously. <a href="#tilelayer-canvas-tiledrawn">tileDrawn</a> method should be called for each tile after drawing completion.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='tilelayer-canvas'>
|
||
<tr>
|
||
<th class="width200">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr id = "tilelayer-canvas-drawtile">
|
||
<td><code><b>drawTile</b>(
|
||
<nobr><HTMLCanvasElement> <i>canvas</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>tilePoint</i></nobr>,
|
||
<nobr><Number> <i>zoom</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>You need to define this method after creating the instance to draw tiles; <code>canvas</code> is the actual canvas tile on which you can draw, <code>tilePoint</code> represents the tile numbers, and <code>zoom</code> is the current zoom.</td>
|
||
</tr>
|
||
<tr id="tilelayer-canvas-tiledrawn">
|
||
<td><code><b>tileDrawn</b>( <nobr><HTMLCanvasElement> <i>canvas</i></nobr> )</code></td>
|
||
<td>-</td>
|
||
<td>If <code>async</code> option is defined, this function should be called for each tile after drawing completion. <code>canvas</code> is the same canvas element, that was passed to <a href="#tilelayer-canvas-drawtile">drawTile</a>.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="imageoverlay">ImageOverlay</h2>
|
||
|
||
<p>Used to load and display a single image over specific bounds of the map, implements <a href="#ilayer">ILayer</a> interface.</p>
|
||
|
||
<h3>Usage example</h3>
|
||
|
||
<pre><code class="javascript">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);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='imageoverlay'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.ImageOverlay</b>(
|
||
<nobr><String> <i>imageUrl</i></nobr>,
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr>,
|
||
<nobr><<a href="#imageoverlay-options">ImageOverlay options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates an image overlay object given the URL of the image and the geographical bounds it is tied to.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="imageoverlay-options">Options</h3>
|
||
<table data-id='imageoverlay'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th class="minwidth">Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>opacity</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">1.0</span></code></td>
|
||
<td>The opacity of the image overlay.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>attribution</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">''</span></code></td>
|
||
<td>The attribution text of the image overlay.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="imageoverlay-methods">Methods</h3>
|
||
<table data-id='imageoverlay'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addTo</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the overlay to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setOpacity</b>(
|
||
<nobr><Number> <i>opacity</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the opacity of the overlay.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setUrl</b>(
|
||
<nobr><String> <i>imageUrl</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Changes the URL of the image.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bringToFront</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Brings the layer to the top of all overlays.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bringToBack</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Brings the layer to the bottom of all overlays.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="path">Path</h2>
|
||
<p>An abstract class that contains options and constants shared between vector overlays (Polygon, Polyline, Circle). Do not use it directly.
|
||
|
||
<h3 id="path-options">Options</h3>
|
||
<table data-id='path'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th class="minwidth">Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>stroke</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether to draw stroke along the path. Set it to <code><span class="literal">false</span></code> to disable borders on polygons or circles.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>color</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'#03f'</span></code></td>
|
||
<td>Stroke color.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>weight</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">5</span></code></td>
|
||
<td>Stroke width in pixels.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>opacity</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">0.5</span></code></td>
|
||
<td>Stroke opacity.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>fill</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>Whether to fill the path with color. Set it to <code><span class="literal">false</span></code> to disable filling on polygons or circles.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>fillColor</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>same as color</td>
|
||
<td>Fill color.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>fillOpacity</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">0.2</span></code></td>
|
||
<td>Fill opacity.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dashArray</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>A string that defines the stroke <a href="https://developer.mozilla.org/en/SVG/Attribute/stroke-dasharray">dash pattern</a>. Doesn't work on canvas-powered layers (e.g. Android 2).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>lineCap</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>A string that defines <a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linecap">shape to be used at the end</a> of the stroke.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>lineJoin</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>A string that defines <a href="https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-linejoin">shape to be used at the corners</a> of the stroke.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>clickable</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>If <code><span class="literal">false</span></code>, the vector will not emit mouse events and will act as a part of the underlying map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>pointerEvents</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="literal">null</span></code></td>
|
||
<td>Sets the <code>pointer-events</code> attribute on the path if SVG backend is used.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>className</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">''</span></code></td>
|
||
<td>Custom class name set on an element.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Events</h3>
|
||
|
||
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
|
||
|
||
<table data-id='path'>
|
||
<tr>
|
||
<th class="width100">Event</th>
|
||
<th class="width100">Data</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>click</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user clicks (or taps) the object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dblclick</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user double-clicks (or double-taps) the object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mousedown</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user pushes the mouse button on the object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseover</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the mouse enters the object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseout</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the mouse leaves the object.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contextmenu</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user pushes the right mouse button on the object, prevents default browser context menu from showing if there are listeners on this event.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>add</b></code></td>
|
||
<td><code><a href="#event">Event</a></code>
|
||
<td>Fired when the path is added to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>remove</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the path is removed from the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupopen</b></code></td>
|
||
<td><code><a href="#popup-event">PopupEvent</a></code></td>
|
||
<td>Fired when a popup bound to the path is open.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupclose</b></code></td>
|
||
<td><code><a href="#popup-event">PopupEvent</a></code></td>
|
||
<td>Fired when a popup bound to the path is closed.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="path-methods">Methods</h3>
|
||
<table data-id='path'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addTo</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the layer to the map.</td>
|
||
</tr>
|
||
<tr id="path-bindpopup">
|
||
<td><code><b>bindPopup</b>(
|
||
<nobr><String> <i>html</i> |</nobr> <nobr><HTMLElement> <i>el</i> |</nobr> <nobr><<a href="#popup">Popup</a>> <i>popup</i>,</nobr>
|
||
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Binds a popup with a particular HTML content to a click on this path.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bindPopup</b>(
|
||
<nobr><<a href="#popup">Popup</a>> <i>popup</i></nobr>,
|
||
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Binds a given popup object to the path.</td>
|
||
</tr>
|
||
<tr id="path-unbindpopup">
|
||
<td><code><b>unbindPopup</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Unbinds the popup previously bound to the path with <code>bindPopup</code>.</td>
|
||
</tr>
|
||
<tr id="path-openpopup">
|
||
<td><code><b>openPopup</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Opens the popup previously bound by the <a href="#path-bindpopup">bindPopup</a> method in the given point, or in one of the path's points if not specified.</td>
|
||
</tr>
|
||
<tr id="path-closepopup">
|
||
<td><code><b>closePopup</b>()</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Closes the path's bound popup if it is opened.</td>
|
||
</tr>
|
||
<tr id="path-setstyle">
|
||
<td><code><b>setStyle</b>(
|
||
<nobr><<a href="#path-options">Path options</a>> <i>object</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Changes the appearance of a Path based on the options in the <a href="#path-options">Path options</a> object.</td>
|
||
</tr>
|
||
<tr id="path-getbounds">
|
||
<td><code><b>getBounds</b>()</code></td>
|
||
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
|
||
<td>Returns the LatLngBounds of the path.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bringToFront</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Brings the layer to the top of all path layers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bringToBack</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Brings the layer to the bottom of all path layers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>redraw</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Redraws the layer. Sometimes useful after you changed the coordinates that the path uses.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Static properties</h3>
|
||
<table data-id='path'>
|
||
<tr>
|
||
<th>Constant</th>
|
||
<th>Type</th>
|
||
<th>Value</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code>SVG</code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>True if SVG is used for vector rendering (true for most modern browsers).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>VML</code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>True if VML is used for vector rendering (IE 6-8).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>CANVAS</code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>depends</td>
|
||
<td>True if Canvas is used for vector rendering (Android 2). You can also force this by setting global variable <code>L_PREFER_CANVAS</code> to <code><span class="literal">true</span></code> <em>before</em> the Leaflet include on your page — sometimes it can increase performance dramatically when rendering thousands of circle markers, but currently suffers from a bug that causes removing such layers to be extremely slow.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code>CLIP_PADDING</code></td>
|
||
<td><code>Number</code></td>
|
||
<td><nobr><code><span class="number">0.5</span></code> for SVG</nobr><br /><nobr><code><span class="number">0.02</span></code> for VML</nobr></td>
|
||
<td>How much to extend the clip area around the map view (relative to its size, e.g. 0.5 is half the screen in each direction). Smaller values mean that you will see clipped ends of paths while you're dragging the map, and bigger values decrease drawing performance.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="polyline">Polyline</h2>
|
||
|
||
<p>A class for drawing polyline overlays on a map. Extends <a href="#path">Path</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
|
||
|
||
<h3>Usage example</h3>
|
||
<pre><code class="javascript">// create a red polyline from an array of LatLng points
|
||
var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
|
||
|
||
// zoom the map to the polyline
|
||
map.fitBounds(polyline.getBounds());</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='polyline'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.polyline</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>[]> <i>latlngs</i></nobr>,
|
||
<nobr><<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates a polyline object given an array of geographical points and optionally an options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="polyline-options">Options</h3>
|
||
|
||
<p>You can use <a href="#path-options">Path options</a> and additionally the following options:</p>
|
||
|
||
<table data-id='polyline'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>smoothFactor</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">1.0</span></code></td>
|
||
<td>How much to simplify the polyline on each zoom level. More means better performance and smoother look, and less means more accurate representation.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>noClip</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>Disabled polyline clipping.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<p>You can use <a href="#path-methods">Path methods</a> and additionally the following methods:</p>
|
||
|
||
<table data-id='polyline'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addLatLng</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds a given point to the polyline.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setLatLngs</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>[]> <i>latlngs</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Replaces all the points in the polyline with the given array of geographical points.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getLatLngs</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a>[]</code></td>
|
||
<td>Returns an array of the points in the path.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>spliceLatLngs</b>(
|
||
<nobr><Number> <i>index</i></nobr>,
|
||
<nobr><Number> <i>pointsToRemove</i></nobr>,
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng?</i>, … )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a>[]</code></td>
|
||
<td>Allows adding, removing or replacing points in the polyline. Syntax is the same as in <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array/splice">Array#splice</a>. Returns the array of removed points (if any).</td>
|
||
</tr>
|
||
<tr id="path-getbounds">
|
||
<td><code><b>getBounds</b>()</code></td>
|
||
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
|
||
<td>Returns the LatLngBounds of the polyline.</td>
|
||
</tr>
|
||
<tr id="polyline-togeojson">
|
||
<td><code><b>toGeoJSON</b>()</code></td>
|
||
<td><code>Object</code></td>
|
||
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the polyline (GeoJSON LineString Feature).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="multipolyline">MultiPolyline</h2>
|
||
|
||
<p>Extends <a href="#featuregroup">FeatureGroup</a> to allow creating multi-polylines (single layer that consists of several polylines that share styling/popup).</p>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='multipolyline'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.multiPolyline</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i></nobr>,
|
||
<nobr><<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
|
||
<td>Instantiates a multi-polyline object given an array of arrays of geographical points (one for each individual polyline) and optionally an options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<p>MultiPolylines accept all <a href="#polyline">Polyline methods</a> but
|
||
have different behavior around their coordinate contents since they can contain
|
||
multiple line features:</p>
|
||
|
||
<table data-id='multipolyline'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setLatLngs</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Replace all lines and their paths with the given array of arrays of
|
||
geographical points.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getLatLngs</b>()</td>
|
||
|
||
<td><code><nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i></nobr>
|
||
</code></td>
|
||
<td>Returns an array of arrays of geographical points in each line.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>openPopup</b>()</td>
|
||
|
||
<td><code>this</code></td>
|
||
<td>Opens the popup previously bound by <a href="#path-bindpopup">bindPopup</a>.</td>
|
||
</tr>
|
||
<tr id="multipolyline-togeojson">
|
||
<td><code><b>toGeoJSON</b>()</code></td>
|
||
<td><code>Object</code></td>
|
||
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the multipolyline (GeoJSON MultiLineString Feature).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="polygon">Polygon</h2>
|
||
|
||
<p>A class for drawing polygon overlays on a map. Extends <a href="#polyline">Polyline</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
|
||
|
||
<p>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.</p>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='polygon'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.polygon</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>[]> <i>latlngs</i></nobr>,
|
||
<nobr><<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates a polygon object given an array of geographical points and optionally an options object (the same as for Polyline). You can also create a polygon with holes by passing an array of arrays of latlngs, with the first latlngs array representing the exterior ring while the remaining represent the holes inside.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<p>Polygon has the same options and methods as Polyline, with the following differences:</p>
|
||
|
||
<table data-id='polygon'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr id="polygon-togeojson">
|
||
<td><code><b>toGeoJSON</b>()</code></td>
|
||
<td><code>Object</code></td>
|
||
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the polygon (GeoJSON Polygon Feature).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="multipolygon">MultiPolygon</h2>
|
||
|
||
<p>Extends <a href="#featuregroup">FeatureGroup</a> to allow creating multi-polygons (single layer that consists of several polygons that share styling/popup).</p>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='multipolygon'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.multiPolygon</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i></nobr>,
|
||
<nobr><<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates a multi-polygon object given an array of latlngs arrays (one for each individual polygon) and optionally an options object (the same as for MultiPolyline).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<p>MultiPolygons accept all <a href="#polyline">Polyline methods</a> but
|
||
have different behavior around their coordinate contents since they can contain
|
||
multiple polygon features:</p>
|
||
|
||
<table data-id='multipolygon'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setLatLngs</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Replace all polygons and their paths with the given array of arrays of
|
||
geographical points.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getLatLngs</b>()</td>
|
||
|
||
<td><code><nobr><<a href="#latlng">LatLng</a>[][]> <i>latlngs</i></nobr>
|
||
</code></td>
|
||
<td>Returns an array of arrays of geographical points in each polygon.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>openPopup</b>()</td>
|
||
|
||
<td><code>this</code></td>
|
||
<td>Opens the popup previously bound by <a href="#path-bindpopup">bindPopup</a>.</td>
|
||
</tr>
|
||
<tr id="multipolygon-togeojson">
|
||
<td><code><b>toGeoJSON</b>()</code></td>
|
||
<td><code>Object</code></td>
|
||
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the multipolygon (GeoJSON MultiPolygon Feature).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h2 id="rectangle">Rectangle</h2>
|
||
|
||
<p>A class for drawing rectangle overlays on a map. Extends <a href="#polygon">Polygon</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
|
||
|
||
<h3>Usage example</h3>
|
||
<pre><code class="javascript">// 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);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='rectangle'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.rectangle</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i></nobr>,
|
||
<nobr><<a href="#path-options">Path options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates a rectangle object with the given geographical bounds and optionally an options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<p>You can use <a href="#path-methods">Path methods</a> and additionally the following methods:</p>
|
||
|
||
<table data-id='rectangle'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setBounds</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>bounds</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Redraws the rectangle with the passed bounds.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="circle">Circle</h2>
|
||
|
||
<p>A class for drawing circle overlays on a map. Extends <a href="#path">Path</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
|
||
|
||
<pre><code class="javascript">L.circle([50.5, 30.5], 200).addTo(map);</pre></code>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='circle'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.circle</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
|
||
<nobr><Number> <i>radius</i></nobr>,
|
||
<nobr><<a href="#path-options">Path options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates a circle object given a geographical point, a radius in meters and optionally an options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='circle'>
|
||
<tr>
|
||
<th class="width200">Method</th>
|
||
<th class="minwidth">Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getLatLng</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the current geographical position of the circle.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getRadius</b>()</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Returns the current radius of a circle. Units are in meters.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setLatLng</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the position of a circle to a new location.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setRadius</b>(
|
||
<nobr><Number> <i>radius</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the radius of a circle. Units are in meters.</td>
|
||
</tr>
|
||
<tr id="circle-togeojson">
|
||
<td><code><b>toGeoJSON</b>()</code></td>
|
||
<td><code>Object</code></td>
|
||
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the circle (GeoJSON Point Feature).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="circlemarker">CircleMarker</h2>
|
||
|
||
<p>A circle of a fixed size with radius specified in pixels. Extends <a href="#circle">Circle</a>. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='circlemarker'>
|
||
<tr>
|
||
<th class="width200">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.circleMarker</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
|
||
<nobr><<a href="#path-options">Path options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Instantiates a circle marker given a geographical point and optionally an options object. The default radius is 10 and can be altered by passing a "radius" member in the path options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='circlemarker'>
|
||
<tr>
|
||
<th class="width200">Method</th>
|
||
<th class="minwidth">Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setLatLng</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the position of a circle marker to a new location.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setRadius</b>(
|
||
<nobr><Number> <i>radius</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the radius of a circle marker. Units are in pixels.</td>
|
||
</tr>
|
||
<tr id="circlemarker-togeojson">
|
||
<td><code><b>toGeoJSON</b>()</code></td>
|
||
<td><code>Object</code></td>
|
||
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the circle marker (GeoJSON Point Feature).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="layergroup">LayerGroup</h2>
|
||
|
||
<p>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. Implements <a href="#ilayer">ILayer</a> interface.</p>
|
||
|
||
<pre><code class="javascript">L.layerGroup([marker1, marker2])
|
||
.addLayer(polyline)
|
||
.addTo(map);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='layergroup'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.layerGroup</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>[]> <i>layers?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Create a layer group, optionally given an initial set of layers.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='layergroup'>
|
||
<tr>
|
||
<th class="width200">Method</th>
|
||
<th class="minwidth">Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addTo</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the group of layers to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addLayer</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds a given layer to the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeLayer</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes a given layer from the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeLayer</b>(
|
||
<nobr><String> <i>id</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes a given layer of the given id from the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>hasLayer</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the given layer is currently added to the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getLayer</b>(
|
||
<nobr><String> <i>id</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#ilayer">ILayer</a></code></td>
|
||
<td>Returns the layer with the given id.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getLayers</b>()</code></td>
|
||
<td><code>Array</code></td>
|
||
<td>Returns an array of all the layers added to the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>clearLayers</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes all the layers from the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>eachLayer</b>(
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Iterates over the layers of the group, optionally specifying context of the iterator function.
|
||
<pre><code>group.eachLayer(function (layer) {
|
||
layer.bindPopup('Hello');
|
||
});</code></pre>
|
||
</td>
|
||
</tr>
|
||
<tr id="layergroup-togeojson">
|
||
<td><code><b>toGeoJSON</b>()</code></td>
|
||
<td><code>Object</code></td>
|
||
<td>Returns a <a href="http://en.wikipedia.org/wiki/GeoJSON">GeoJSON</a> representation of the layer group (GeoJSON FeatureCollection).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="featuregroup">FeatureGroup</h2>
|
||
|
||
<p>Extended <a href="#layergroup">layerGroup</a> that also has mouse events (propagated from members of the group) and a shared bindPopup method. Implements <a href="#ilayer">ILayer</a> interface.</p>
|
||
|
||
<pre><code class="javascript">L.featureGroup([marker1, marker2, polyline])
|
||
.bindPopup('Hello world!')
|
||
.on('click', function() { alert('Clicked on a group!'); })
|
||
.addTo(map);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='featuregroup'>
|
||
<tr>
|
||
<th class="width300">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.featureGroup</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>[]> <i>layers?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
|
||
<td>Create a layer group, optionally given an initial set of layers.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<p>Has all <a href="#layergroup">layerGroup</a> methods and additionally:</p>
|
||
|
||
<table data-id='featuregroup'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bindPopup</b>(
|
||
<nobr><String> <i>htmlContent</i></nobr>,
|
||
<nobr><<a href="#popup-options">Popup options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Binds a popup with a particular HTML content to a click on any layer from the group that has a <code>bindPopup</code> method.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getBounds</b>()</code></td>
|
||
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
|
||
<td>Returns the LatLngBounds of the Feature Group (created from bounds and coordinates of its children).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setStyle</b>(
|
||
<nobr><<a href="#path-options">Path options</a>> <i>style</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the given path options to each layer of the group that has a <code>setStyle</code> method.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bringToFront</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Brings the layer group to the top of all other layers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bringToBack</b>()</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Brings the layer group to the bottom of all other layers.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Events</h3>
|
||
|
||
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
|
||
|
||
<table data-id='featuregroup'>
|
||
<tr>
|
||
<th class="width100">Event</th>
|
||
<th class="width100">Data</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>click</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user clicks (or taps) the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dblclick</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user double-clicks (or double-taps) the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseover</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the mouse enters the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mouseout</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the mouse leaves the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mousemove</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired while the mouse moves over the layers of the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contextmenu</b></code></td>
|
||
<td><code><a href="#mouse-event">MouseEvent</a></code></td>
|
||
<td>Fired when the user right-clicks on one of the layers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layeradd</b></code></td>
|
||
<td><code><a href="#layer-event">LayerEvent</a></code>
|
||
<td>Fired when a layer is added to the group.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layerremove</b></code></td>
|
||
<td><code><a href="#layer-event">LayerEvent</a></code>
|
||
<td>Fired when a layer is removed from the map.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="geojson">GeoJson</h2>
|
||
|
||
<p>Represents a <a href="http://geojson.org/geojson-spec.html">GeoJSON</a> layer. Allows you to parse GeoJSON data and display it on the map. Extends <a href="#featuregroup">FeatureGroup</a>.</p>
|
||
|
||
<pre><code class="javascript">L.geoJson(data, {
|
||
style: function (feature) {
|
||
return {color: feature.properties.color};
|
||
},
|
||
onEachFeature: function (feature, layer) {
|
||
layer.bindPopup(feature.properties.description);
|
||
}
|
||
}).addTo(map);</code></pre>
|
||
|
||
<p>Each feature layer created by it gets a <code>feature</code> property that links to the GeoJSON feature data the layer was created from (so that you can access its properties later).</p>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='geojson'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.geoJson</b>(
|
||
<nobr><Object> <i>geojson?</i></nobr>,
|
||
<nobr><<a href="#geojson-options">GeoJSON options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Creates a GeoJSON layer. Optionally accepts an object in <a href="http://geojson.org/geojson-spec.html">GeoJSON format</a> to display on the map (you can alternatively add it later with <code>addData</code> method) and an options object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="geojson-options">Options</h3>
|
||
|
||
<table data-id='geojson'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr id="geojson-pointtolayer">
|
||
<td><code><b>pointToLayer</b>(
|
||
<nobr><GeoJSON> <i>featureData</i></nobr>,
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Function that will be used for creating layers for GeoJSON points (if not specified, simple markers will be created).</td>
|
||
</tr>
|
||
<tr id="geojson-style">
|
||
<td><code><b>style</b>(
|
||
<nobr><GeoJSON> <i>featureData</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Function that will be used to get style options for vector layers created for GeoJSON features.</td>
|
||
</tr>
|
||
<tr id="geojson-oneachfeature">
|
||
<td><code><b>onEachFeature</b>(
|
||
<nobr><GeoJSON> <i>featureData</i></nobr>,
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Function that will be called on each created feature layer. Useful for attaching events and popups to features.</td>
|
||
</tr>
|
||
<tr id="geojson-filter">
|
||
<td><code><b>filter</b>(
|
||
<nobr><GeoJSON> <i>featureData</i></nobr>,
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Function that will be used to decide whether to show a feature or not.</td>
|
||
</tr>
|
||
<tr id="geojson-coordstolatlng">
|
||
<td><code><b>coordsToLatLng</b>(
|
||
<nobr><Array> <i>coords</i></nobr> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Function that will be used for converting GeoJSON coordinates to <a href="#latlng">LatLng</a> points (if not specified, coords will be assumed to be WGS84 — standard <code>[longitude, latitude]</code> values in degrees).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<p>Additionally accepts all <a href="#path-options">Path options</a> for polylines and polygons.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='geojson'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th class="minwidth">Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addData</b>(
|
||
<nobr><GeoJSON> <i>data</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>this</code></td>
|
||
<td>Adds a GeoJSON object to the layer.</td>
|
||
</tr>
|
||
<tr id="geojson-setstyle">
|
||
<td><code><b>setStyle</b>(
|
||
<nobr><Function> <i><a href="#geojson-style">style</a></i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Changes styles of GeoJSON vector layers with the given style function.</td>
|
||
</tr>
|
||
<tr id="geojson-resetstyle">
|
||
<td><code><b>resetStyle</b>(
|
||
<nobr><<a href="#path">Path</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Resets the given vector layer's style to the original GeoJSON style, useful for resetting style after hover events.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Static methods</h3>
|
||
|
||
<table data-id='geojson'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>geometryToLayer</b>(
|
||
<nobr><GeoJSON> <i>featureData</i></nobr>,
|
||
<nobr><<a href="#geojson-pointtolayer">Function</a>> <i>pointToLayer?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#ilayer">ILayer</a></code></td>
|
||
<td>Creates a layer from a given GeoJSON feature.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>coordsToLatLng</b>(
|
||
<nobr><Array> <i>coords</i></nobr>,
|
||
<nobr><Boolean> <i>reverse?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Creates a LatLng object from an array of 2 numbers (latitude, longitude) used in GeoJSON for points. If <code>reverse</code> is set to <code><span class="literal">true</span></code>, the numbers will be interpreted as (longitude, latitude).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>coordsToLatLngs</b>(
|
||
<nobr><Array> <i>coords</i></nobr>,
|
||
<nobr><Number> <i>levelsDeep?</i></nobr>,
|
||
<nobr><Boolean> <i>reverse?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Array</code></td>
|
||
<td>Creates a multidimensional array of LatLng objects from a GeoJSON coordinates array. <code>levelsDeep</code> specifies the nesting level (0 is for an array of points, 1 for an array of arrays of points, etc., 0 by default). If <code>reverse</code> is set to <code><span class="literal">true</span></code>, the numbers will be interpreted as (longitude, latitude).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h2 id="latlng">LatLng</h2>
|
||
|
||
<p>Represents a geographical point with a certain latitude and longitude.</p>
|
||
<pre><code class="javascript">var latlng = L.latLng(50.5, 30.5);</code></pre>
|
||
|
||
<p>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:</p>
|
||
|
||
<pre><code>map.panTo([50, 30]);
|
||
map.panTo({lon: 30, lat: 50});
|
||
map.panTo({lat: 50, lng: 30});
|
||
map.panTo(L.latLng(50, 30));</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='latlng'>
|
||
<tr>
|
||
<th class="width200">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.latLng</b>(
|
||
<nobr><Number> <i>latitude</i></nobr>,
|
||
<nobr><Number> <i>longitude</i></nobr>,
|
||
<nobr><Number> <i>altitude?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Creates an object representing a geographical point with the given latitude and longitude (and optionally altitude).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Properties</h3>
|
||
|
||
<table data-id='latlng'>
|
||
<tr>
|
||
<th class="width100">Property</th>
|
||
<th class="width100">Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>lat</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Latitude in degrees.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>lng</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Longitude in degrees.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='latlng'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>distanceTo</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>otherLatlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Number</code></td>
|
||
<td>Returns the distance (in meters) to the given LatLng calculated using the Haversine formula. See <a href="http://en.wikipedia.org/wiki/Haversine_formula">description on wikipedia</a></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>equals</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>otherLatlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the given LatLng point is at the same position (within a small margin of error).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>toString</b>()</code></td>
|
||
<td><code>String</code></td>
|
||
<td>Returns a string representation of the point (for debugging purposes).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>wrap</b>(
|
||
<nobr><Number> <i>left</i></nobr>,
|
||
<nobr><Number> <i>right</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns a new <code>LatLng</code> object with the longitude wrapped around <code>left</code> and <code>right</code> boundaries (<code><span class="number">-180</span></code> to <code><span class="number">180</span></code> by default).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Constants</h3>
|
||
|
||
<table data-id='latlng'>
|
||
<tr>
|
||
<th class="width100">Constant</th>
|
||
<th class="width100">Type</th>
|
||
<th class="width100">Value</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>DEG_TO_RAD</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code>Math.PI / <span class="number">180</span></code></td>
|
||
<td>A multiplier for converting degrees into radians.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>RAD_TO_DEG</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">180</span> / Math.PI</code></td>
|
||
<td>A multiplier for converting radians into degrees.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>MAX_MARGIN</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">1.0E-9</span></code></td>
|
||
<td>Max margin of error for the equality check.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h2 id="latlngbounds">LatLngBounds</h2>
|
||
|
||
<p>Represents a rectangular geographical area on a map.</p>
|
||
<pre><code class="javascript">var southWest = L.latLng(40.712, -74.227),
|
||
northEast = L.latLng(40.774, -74.125),
|
||
bounds = L.latLngBounds(southWest, northEast);</code></pre>
|
||
|
||
<p>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:</p>
|
||
|
||
<pre><code class="javascript">map.fitBounds([
|
||
[40.712, -74.227],
|
||
[40.774, -74.125]
|
||
]);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='latlngbounds'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td>
|
||
<code><b>L.latLngBounds</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>southWest</i></nobr>,
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>northEast</i></nobr> )</code>
|
||
</td>
|
||
|
||
|
||
|
||
<td>Creates a latLngBounds object by defining south-west and north-east corners of the rectangle.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.latLngBounds</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>[]> <i>latlngs</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>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 <a href="#map-fitbounds">fitBounds</a>.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='latlngbounds'>
|
||
<tr>
|
||
<th class="width300">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>extend</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>|<a href="#latlngbounds">LatLngBounds</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Extends the bounds to contain the given point or bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getSouthWest</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the south-west point of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getNorthEast</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the north-east point of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getNorthWest</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the north-west point of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getSouthEast</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the south-east point of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getWest</b>()</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Returns the west longitude of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getSouth</b>()</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Returns the south latitude of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getEast</b>()</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Returns the east longitude of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getNorth</b>()</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Returns the north latitude of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getCenter</b>()</code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Returns the center point of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contains</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>otherBounds</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the rectangle contains the given one.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contains</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the rectangle contains the given point.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>intersects</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>otherBounds</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the rectangle intersects the given bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>equals</b>(
|
||
<nobr><<a href="#latlngbounds">LatLngBounds</a>> <i>otherBounds</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the rectangle is equivalent (within a small margin of error) to the given bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>toBBoxString</b>()</code></td>
|
||
<td><code>String</code></td>
|
||
<td>Returns a string with bounding box coordinates in a <code><span class="string">'southwest_lng,southwest_lat,northeast_lng,northeast_lat'</span></code> format. Useful for sending requests to web services that return geo data.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>pad</b>(
|
||
<nobr><Number> <i>bufferRatio</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
|
||
<td>Returns bigger bounds created by extending the current bounds by a given percentage in each direction.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>isValid</b>()</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the bounds are properly initialized.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h2 id="point">Point</h2>
|
||
|
||
<p>Represents a point with x and y coordinates in pixels.</p>
|
||
|
||
<pre><code>var point = L.point(200, 300);</code></pre>
|
||
|
||
<p>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:</p>
|
||
|
||
<pre><code>map.panBy([200, 300]);
|
||
map.panBy(L.point(200, 300));</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='point'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.point</b>(
|
||
<nobr><Number> <i>x</i>, <Number> <i>y</i></nobr>,
|
||
<nobr><Boolean> <i>round?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Creates a Point object with the given <code>x</code> and <code>y</code> coordinates. If optional <code>round</code> is set to <code><span class="literal">true</span></code>, rounds the <code>x</code> and <code>y</code> values.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Properties</h3>
|
||
|
||
<table data-id='point'>
|
||
<tr>
|
||
<th class="width100">Property</th>
|
||
<th class="width100">Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>x</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>The x coordinate.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>y</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>The y coordinate.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='point'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>add</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the result of addition of the current and the given points.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>subtract</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the result of subtraction of the given point from the current.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>multiplyBy</b>(
|
||
<nobr><Number> <i>number</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the result of multiplication of the current point by the given number.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>divideBy</b>(
|
||
<nobr><Number> <i>number</i></nobr>,
|
||
<nobr><Boolean> <i>round?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the result of division of the current point by the given number. If optional <code>round</code> is set to <code><span class="literal">true</span></code>, returns a rounded result.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>distanceTo</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Number</code></td>
|
||
<td>Returns the distance between the current and the given points.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>clone</b>()</code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns a copy of the current point.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>round</b>()</code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns a copy of the current point with rounded coordinates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>floor</b>()</code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns a copy of the current point with floored coordinates (rounded down).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>equals</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the given point has the same coordinates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contains</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>otherPoint</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the both coordinates of the given point are less than the corresponding current point coordinates (in absolute values).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>toString</b>()</code></td>
|
||
<td><code>String</code></td>
|
||
<td>Returns a string representation of the point for debugging purposes.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="bounds">Bounds</h2>
|
||
|
||
<p>Represents a rectangular area in pixel coordinates.</p>
|
||
<pre><code class="javascript">var p1 = L.point(10, 10),
|
||
p2 = L.point(40, 60),
|
||
bounds = L.bounds(p1, p2);</code></pre>
|
||
|
||
<p>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:</p>
|
||
|
||
<pre><code class="javascript">otherBounds.intersects([[10, 10], [40, 60]]);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='bounds'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.bounds</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>topLeft</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>bottomRight</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Creates a Bounds object from two coordinates (usually top-left and bottom-right corners).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.bounds</b>(
|
||
<nobr><<a href="#point">Point</a>[]> <i>points</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
|
||
<td>Creates a Bounds object defined by the points it contains.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Properties</h3>
|
||
|
||
<table data-id='bounds'>
|
||
<tr>
|
||
<th class="width100">Property</th>
|
||
<th class="width100">Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>min</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>The top left corner of the rectangle.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>max</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>The bottom right corner of the rectangle.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='bounds'>
|
||
<tr>
|
||
<th class="width250">Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>extend</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>-</td>
|
||
<td>Extends the bounds to contain the given point.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getCenter</b>()</code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the center point of the bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contains</b>(
|
||
<nobr><<a href="#bounds">Bounds</a>> <i>otherBounds</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the rectangle contains the given one.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>contains</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the rectangle contains the given point.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>intersects</b>(
|
||
<nobr><<a href="#bounds">Bounds</a>> <i>otherBounds</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the rectangle intersects the given bounds.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>isValid</b>()</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the bounds are properly initialized.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getSize</b>()</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the size of the given bounds.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="icon">Icon</h2>
|
||
|
||
<p>Represents an icon to provide when creating a marker.</p>
|
||
|
||
<pre><code class="javascript">var myIcon = L.icon({
|
||
iconUrl: 'my-icon.png',
|
||
iconRetinaUrl: 'my-icon@2x.png',
|
||
iconSize: [38, 95],
|
||
iconAnchor: [22, 94],
|
||
popupAnchor: [-3, -76],
|
||
shadowUrl: 'my-icon-shadow.png',
|
||
shadowRetinaUrl: 'my-icon-shadow@2x.png',
|
||
shadowSize: [68, 95],
|
||
shadowAnchor: [22, 94]
|
||
});
|
||
|
||
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);</code></pre>
|
||
|
||
<p><code>L.Icon.Default</code> extends <code>L.Icon</code> and is the blue icon Leaflet uses for markers by default.</p>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='icon'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.icon</b>(
|
||
<nobr><<a href="#icon-options">Icon options</a>> <i>options</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Creates an icon instance with the given options.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="icon-options">Options</h3>
|
||
|
||
<table data-id='icon'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>iconUrl</b></code></td>
|
||
<td><code>String</code>
|
||
<td>(required) The URL to the icon image (absolute or relative to your script path).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>iconRetinaUrl</b></code></td>
|
||
<td><code>String</code>
|
||
<td>The URL to a retina sized version of the icon image (absolute or relative to your script path). Used for Retina screen devices.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>iconSize</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Size of the icon image in pixels.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>iconAnchor</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>shadowUrl</b></code></td>
|
||
<td><code>String</code>
|
||
<td>The URL to the icon shadow image. If not specified, no shadow image will be created.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>shadowRetinaUrl</b></code></td>
|
||
<td><code>String</code>
|
||
<td>The URL to the retina sized version of the icon shadow image. If not specified, no shadow image will be created. Used for Retina screen devices.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>shadowSize</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Size of the shadow image in pixels.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>shadowAnchor</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>The coordinates of the "tip" of the shadow (relative to its top left corner) (the same as <code>iconAnchor</code> if not specified).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupAnchor</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>The coordinates of the point from which popups will "open", relative to the icon anchor.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>className</b></code></td>
|
||
<td><code>String</code>
|
||
<td>A custom class name to assign to both icon and shadow images. Empty by default.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="divicon">DivIcon</h2>
|
||
|
||
<p>Represents a lightweight icon for markers that uses a simple <code>div</code> element instead of an image.</p>
|
||
|
||
<pre><code class="javascript">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);</code></pre>
|
||
|
||
<p>By default, it has a <code><span class="string">'leaflet-div-icon'</span></code> class and is styled as a little white square with a shadow.</p>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='divicon'>
|
||
<tr>
|
||
<th class="width250">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.divIcon</b>(
|
||
<nobr><<a href="#divicon-options">DivIcon options</a>> <i>options</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
|
||
<td>Creates a div icon instance with the given options.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="divicon-options">Options</h3>
|
||
|
||
<table data-id='divicon'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>iconSize</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Size of the icon in pixels. Can be also set through CSS.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>iconAnchor</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popupAnchor</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>The coordinates of the point from which popups will "open", relative to the icon anchor.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>className</b></code></td>
|
||
<td><code>String</code>
|
||
<td>A custom class name to assign to the icon. <code><span class="string">'leaflet-div-icon'</span></code> by default.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>html</b></code></td>
|
||
<td><code>String</code>
|
||
<td>A custom HTML code to put inside the div element, empty by default.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h2 id="control">Control</h2>
|
||
|
||
<p>The base class for all Leaflet controls. Implements <a href="#icontrol">IControl</a> interface. You can add controls to the map like this:</p>
|
||
|
||
<pre><code>control.addTo(map);
|
||
// the same as
|
||
map.addControl(control);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
<table data-id='control'>
|
||
<tr>
|
||
<th class="width300">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.control</b>(
|
||
<nobr><<a href="#control-options">Control options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
|
||
<td>Creates a control with the given options.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Options</h3>
|
||
<table data-id='control'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>position</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'topright'</span></td>
|
||
<td>The initial position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
<table data-id='control'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setPosition</b>(
|
||
<nobr><String> <i>position</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the position of the control. See <a href="#control-positions">control positions</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getPosition</b>()</code></td>
|
||
<td><code>String</code></td>
|
||
<td>Returns the current position of the control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addTo</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds the control to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeFrom</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes the control from the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getContainer</b>()</code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Returns the HTML container of the control.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="control-positions">Control Positions</h3>
|
||
|
||
<p>Control positions (map corner to put a control to) are set using strings. Margins between controls and the map border are set with CSS, so that you can easily override them.</p>
|
||
|
||
<table data-id='control'>
|
||
<tr>
|
||
<th class="minwidth">Position</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><span class="string">'topleft'</span></code></td>
|
||
<td>Top left of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><span class="string">'topright'</span></code></td>
|
||
<td>Top right of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><span class="string">'bottomleft'</span></code></td>
|
||
<td>Bottom left of the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><span class="string">'bottomright'</span></code></td>
|
||
<td>Bottom right of the map.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="control-zoom">Control.zoom</h2>
|
||
|
||
<p>A basic zoom control with two buttons (zoom in and zoom out). It is put on the map by default unless you set its <code>zoomControl</code> option to <code><span class="literal">false</span></code>. Extends <a href="#control">Control</a>.</p>
|
||
|
||
<h3>Creation</h3>
|
||
<table data-id='control-zoom'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
|
||
<th class="width200">Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.control.zoom</b>(
|
||
<nobr><<a href="#control-zoom-options">Control.Zoom options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
<td>Creates a zoom control.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="control-zoom-options">Options</h3>
|
||
<table data-id='control-zoom'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>position</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'topleft'</span></td>
|
||
<td>The position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomInText</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'+'</span></td>
|
||
<td>The text set on the zoom in button.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomOutText</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'-'</span></td>
|
||
<td>The text set on the zoom out button.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomInTitle</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'Zoom in'</span></td>
|
||
<td>The title set on the zoom in button.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>zoomOutTitle</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'Zoom out'</span></td>
|
||
<td>The title set on the zoom out button.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="control-attribution">Control.Attribution</h2>
|
||
|
||
<p>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 <code>attributionControl</code> option to <code><span class="literal">false</span></code>, and it fetches attribution texts from layers with <code>getAttribution</code> method automatically. Extends <a href="#control">Control</a>.</p>
|
||
|
||
<h3>Creation</h3>
|
||
<table data-id='control-attribution'>
|
||
<tr>
|
||
<th class="width200">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.control.attribution</b>(
|
||
<nobr><<a href="#control-attribution-options">Control.Attribution options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
|
||
<td>Creates an attribution control.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="control-attribution-options">Options</h3>
|
||
<table data-id='control-attribution'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>position</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'bottomright'</span></td>
|
||
<td>The position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>prefix</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'Leaflet'</span></td>
|
||
<td>The HTML text shown before the attributions. Pass <code><span class="literal">false</span></code> to disable.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
<table data-id='control-attribution'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setPrefix</b>(
|
||
<nobr><String> <i>prefix</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Sets the text before the attributions.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addAttribution</b>(
|
||
<nobr><String> <i>text</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds an attribution text (e.g. <code><span class="string">'Vector data &copy; Mapbox'</span></code>).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeAttribution</b>(
|
||
<nobr><String> <i>text</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes an attribution text.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="control-layers">Control.Layers</h2>
|
||
|
||
<p>The layers control gives users the ability to switch between different base layers and switch overlays on/off (check out the <a href="http://leafletjs.com/examples/layers-control.html">detailed example</a>). Extends <a href="#control">Control</a>.</p>
|
||
|
||
<pre><code>var baseLayers = {
|
||
"Mapbox": mapbox,
|
||
"OpenStreetMap": osm
|
||
};
|
||
|
||
var overlays = {
|
||
"Marker": marker,
|
||
"Roads": roadsLayer
|
||
};
|
||
|
||
L.control.layers(baseLayers, overlays).addTo(map);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
<table data-id='control-layers'>
|
||
<tr>
|
||
<th>Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.control.layers</b>(
|
||
<nobr><<a href="#control-layers-config">Layer Config</a>> <i>baseLayers?</i></nobr>,
|
||
<nobr><<a href="#control-layers-config">Layer Config</a>> <i>overlays?</i></nobr>,
|
||
<nobr><<a href="#control-layers-options">Control.Layers options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
<table data-id='control-layers'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addBaseLayer</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i></nobr>,
|
||
<nobr><String> <i>name</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds a base layer (radio button entry) with the given name to the control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addOverlay</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i></nobr>,
|
||
<nobr><String> <i>name</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds an overlay (checkbox entry) with the given name to the control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeLayer</b>(
|
||
<nobr><<a href="#ilayer">ILayer</a>> <i>layer</i> )</nobr>
|
||
</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Remove the given layer from the control.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="control-layers-options">Options</h3>
|
||
|
||
<table data-id='control-layers'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>position</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'topright'</span></td>
|
||
<td>The position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>collapsed</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, the control will be collapsed into an icon and expanded on mouse hover or touch.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>autoZIndex</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, the control will assign zIndexes in increasing order to all of its layers so that the order is preserved when switching them on/off.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h3 id="control-layers-config">Layer Config</h3>
|
||
|
||
<p>An object literal with layer names as keys and layer objects as values:</p>
|
||
|
||
<pre><code>{
|
||
"<someName1>": layer1,
|
||
"<someName2>": layer2
|
||
}</code></pre>
|
||
|
||
<p>The layer names can contain HTML, which allows you to add additional styling to the items:</p>
|
||
|
||
<pre><code>{"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}</code></pre>
|
||
|
||
|
||
<h3>Events</h3>
|
||
|
||
<p>You can subscribe to the following events on the <a href="#map-class">Map</a> object using <a href="#events">these methods</a>.</p>
|
||
|
||
<table data-id='control-layers'>
|
||
<tr>
|
||
<th class="width100">Event</th>
|
||
<th class="width100">Data</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>baselayerchange</b></code></td>
|
||
<td><code><a href="#layers-control-event">LayersControlEvent</a></code>
|
||
<td>Fired when the base layer is changed through the control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>overlayadd</b></code></td>
|
||
<td><code><a href="#layers-control-event">LayersControlEvent</a></code>
|
||
<td>Fired when an overlay is selected through the control.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>overlayremove</b></code></td>
|
||
<td><code><a href="#layers-control-event">LayersControlEvent</a></code>
|
||
<td>Fired when an overlay is deselected through the control.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="control-scale">Control.Scale</h2>
|
||
|
||
<p>A simple scale control that shows the scale of the current center of screen in metric (m/km) and imperial (mi/ft) systems. Extends <a href="#control">Control</a>.</p>
|
||
|
||
<pre><code>L.control.scale().addTo(map);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
<table data-id='control-scale'>
|
||
<tr>
|
||
<th class="width200">Factory</th>
|
||
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.control.scale</b>(
|
||
<nobr><<a href="#control-scale-options">Control.Scale options</a>> <i>options?</i> )</nobr>
|
||
</code></td>
|
||
|
||
|
||
|
||
<td>Creates an scale control with the given options.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="control-scale-options">Options</h3>
|
||
|
||
<table data-id='control-scale'>
|
||
<tr>
|
||
<th>Option</th>
|
||
<th>Type</th>
|
||
<th>Default</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>position</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td><code><span class="string">'bottomleft'</span></td>
|
||
<td>The position of the control (one of the map corners). See <a href="#control-positions">control positions</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>maxWidth</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td><code><span class="number">100</span></code></td>
|
||
<td>Maximum width of the control in pixels. The width is set dynamically to show round values (e.g. 100, 200, 500).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>metric</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether to show the metric scale line (m/km).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>imperial</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code></td>
|
||
<td>Whether to show the imperial scale line (mi/ft).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>updateWhenIdle</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">false</span></code></td>
|
||
<td>If <code><span class="literal">true</span></code>, the control is updated on <code>moveend</code>, otherwise it's always up-to-date (updated on <code>move</code>).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="events">Events methods</h2>
|
||
|
||
<p>A set of methods shared between event-powered classes (like Map). 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 <code><span class="string">'click'</span></code> event).</p>
|
||
|
||
<h3>Example</h3>
|
||
|
||
<pre><code class="javascript">map.on('click', function(e) {
|
||
alert(e.latlng);
|
||
});</code></pre>
|
||
|
||
<p>Leaflet deals with event listeners by reference, so if you want to add a listener and then remove it, define it as a function:</p>
|
||
|
||
<pre><code>function onClick(e) { ... }
|
||
|
||
map.on('click', onClick);
|
||
map.off('click', onClick);</code></pre>
|
||
|
||
<h3>Methods</h3>
|
||
<table data-id='events'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addEventListener</b>(
|
||
<nobr><String> <i>type</i></nobr>,
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds a listener function (<code>fn</code>) to a particular event type of the object. You can optionally specify the context of the listener (object the <code><span class="keyword">this</span></code> keyword will point to). You can also pass several space-separated types (e.g. <code><span class="string">'click dblclick'</span></code>).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addOneTimeEventListener</b>(
|
||
<nobr><String> <i>type</i></nobr>,
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>The same as above except the listener will only get fired once and then removed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addEventListener</b>(
|
||
<nobr><Object> <i>eventMap</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds a set of type/listener pairs, e.g. <code>{click: onClick, mousemove: onMouseMove}</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeEventListener</b>(
|
||
<nobr><String> <i>type</i></nobr>,
|
||
<nobr><Function> <i>fn?</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>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 <code>addEventListener</code>, you must pass the same context to <code>removeEventListener</code> in order to remove the listener.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeEventListener</b>(
|
||
<nobr><Object> <i>eventMap</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes a set of type/listener pairs.</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeEventListener</b>()</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes all listeners. An alias to <code>clearAllEventListeners</code> when you use it without arguments.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>hasEventListeners</b>(
|
||
<nobr><String> <i>type</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if a particular event type has some listeners attached to it.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>fireEvent</b>(
|
||
<nobr><String> <i>type</i></nobr>,
|
||
<nobr><Object> <i>data?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>clearAllEventListeners</b>()</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes all listeners to all events on the object.</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>on</b>( … )</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Alias to <code>addEventListener</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>once</b>( … )</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Alias to <code>addOneTimeEventListener</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>off</b>( … )</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Alias to <code>removeEventListener</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>fire</b>( … )</code></td>
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Alias to <code>fireEvent</code>.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="event-objects">Event objects</h2>
|
||
|
||
<p>Event object is an object that you receive as an argument in a listener function when some event is fired, containing useful information about that event. For example:</p>
|
||
|
||
<pre><code class="javascript">map.on('click', function(e) {
|
||
alert(e.latlng); // e is an event object (MouseEvent in this case)
|
||
});</code></pre>
|
||
|
||
<h3 id="event">Event</h3>
|
||
|
||
<p>The base event object. All other event objects contain these properties too.</p>
|
||
|
||
<table data-id='events'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>type</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>The event type (e.g. <code><span class="string">'click'</span></code>).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>target</b></code></td>
|
||
<td><code>Object</code></td>
|
||
<td>The object that fired the event.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="mouse-event">MouseEvent</h3>
|
||
|
||
<table data-id='events'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th>type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>latlng</b></code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>The geographical point where the mouse event occured.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layerPoint</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Pixel coordinates of the point where the mouse event occured relative to the map layer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>containerPoint</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Pixel coordinates of the point where the mouse event occured relative to the map сontainer.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>originalEvent</b></code></td>
|
||
<td><code>DOMMouseEvent</code></td>
|
||
<td>The original DOM mouse event fired by the browser.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="location-event">LocationEvent</h3>
|
||
|
||
<table data-id='events'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th>type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>latlng</b></code></td>
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>Detected geographical location of the user.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bounds</b></code></td>
|
||
<td><code><a href="#latlngbounds">LatLngBounds</a></code></td>
|
||
<td>Geographical bounds of the area user is located in (with respect to the accuracy of location).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>accuracy</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Accuracy of location in meters.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>altitude</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Height of the position above the WGS84 ellipsoid in meters.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>altitudeAccuracy</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Accuracy of altitude in meters.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>heading</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>The direction of travel in degrees counting clockwise from true North.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>speed</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Current velocity in meters per second.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>timestamp</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>The time when the position was acquired.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="error-event">ErrorEvent</h3>
|
||
|
||
<table data-id='error-event'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>message</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>Error message.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>code</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Error code (if applicable).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="layer-event">LayerEvent</h3>
|
||
|
||
<table data-id='layer-event'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layer</b></code></td>
|
||
<td><code><a href="#ilayer">ILayer</a></code></td>
|
||
<td>The layer that was added or removed.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="layers-control-event">LayersControlEvent</h3>
|
||
|
||
<table data-id='layer-control-event'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layer</b></code></td>
|
||
<td><code><a href="#ilayer">ILayer</a></code></td>
|
||
<td>The layer that was added or removed.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>name</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>The name of the layer that was added or removed.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="tile-event">TileEvent</h3>
|
||
|
||
<table data-id='tile-event'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>tile</b></code></td>
|
||
<td><code>HTMLElement</code></td>
|
||
<td>The tile element (image).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>url</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>The source URL of the tile.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="resize-event">ResizeEvent</h3>
|
||
|
||
<table data-id='resize-event'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>oldSize</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>The old size before resize event.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>newSize</b></code></td>
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>The new size after the resize event.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="geojson-event">GeoJSON event</h3>
|
||
|
||
<table data-id='geojson-event'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>layer</b></code></td>
|
||
<td><code><a href="#ilayer">ILayer</a></code></td>
|
||
<td>The layer for the GeoJSON feature that is being added to the map.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>properties</b></code></td>
|
||
<td><code>Object</code></td>
|
||
<td>GeoJSON properties of the feature.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>geometryType</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>GeoJSON geometry type of the feature.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>id</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>GeoJSON ID of the feature (if present).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="popup-event">Popup event</h3>
|
||
|
||
<table data-id='popup-event'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>popup</b></code></td>
|
||
<td><code><a href="#popup">Popup</a></code></td>
|
||
<td>The popup that was opened or closed.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3 id="dragend-event">DragEndEvent</h3>
|
||
|
||
<table data-id='layer-event'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>distance</b></code></td>
|
||
<td><code>Number</code></td>
|
||
<td>The distance in pixels the draggable element was moved by.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<!-- <h3>TileEvent</h3> -->
|
||
|
||
|
||
|
||
<h2 id="class">Class</h2>
|
||
|
||
<p><code>L.Class</code> powers the OOP facilities of Leaflet and is used to create almost all of the Leaflet classes documented here.</p>
|
||
<p>In addition to implementing a simple classical inheritance model, it introduces several special properties for convenient code organization — <code>options</code>, <code>includes</code> and <code>statics</code>.</p>
|
||
|
||
<pre><code>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");
|
||
</code></pre>
|
||
|
||
<p>The <code>initialize</code> method is your class's constructor function, meaning that it gets called when you do <code>new MyClass(...)</code>.</p>
|
||
|
||
|
||
<h3>Class Factories</h3>
|
||
|
||
<p>You may have noticed that Leaflet objects are created without using the <code>new</code> keyword. This is achieved by complementing each class with a lowercase factory method:</p>
|
||
|
||
<pre><code>new L.Map('map'); // becomes:
|
||
L.map('map');</code></pre>
|
||
|
||
<p>The factories are implemented very easily, and you can do this for your own classes:</p>
|
||
|
||
<pre><code>L.map = function (id, options) {
|
||
return new L.Map(id, options);
|
||
};</code></pre>
|
||
|
||
|
||
<h3>Inheritance</h3>
|
||
|
||
<p>You use <code>L.Class.extend</code> to define new classes, but you can use the same method on any class to inherit from it:</p>
|
||
|
||
<pre><code>var MyChildClass = MyClass.extend({
|
||
// ... new properties and methods
|
||
});</code></pre>
|
||
|
||
<p>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 <code>extend</code>. It will also properly react to <code>instanceof</code>:</p>
|
||
|
||
<pre><code>var a = new MyChildClass();
|
||
a instanceof MyChildClass; // true
|
||
a instanceof MyClass; // true
|
||
</code></pre>
|
||
|
||
<p>You can call parent methods (including constructor) from corresponding child ones (as you do with <code>super</code> calls in other languages) by accessing parent class prototype and using JavaScript's <code>call</code> or <code>apply</code>:</p>
|
||
|
||
<pre><code>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!"</code></pre>
|
||
|
||
<h3 id="class-options">Options</h3>
|
||
|
||
<p><code>options</code> is a special property that unlike other objects that you pass to <code>extend</code> will be merged with the parent one instead of overriding it completely, which makes managing configuration of objects and default values convenient:</p>
|
||
|
||
<pre><code>var MyClass = L.Class.extend({
|
||
options: {
|
||
myOption1: 'foo',
|
||
myOption2: 'bar'
|
||
}
|
||
});
|
||
|
||
var MyChildClass = MyClass.extend({
|
||
options: {
|
||
myOption1: 'baz',
|
||
myOption3: 5
|
||
}
|
||
});
|
||
|
||
var a = new MyChildClass();
|
||
a.options.myOption1; // 'baz'
|
||
a.options.myOption2; // 'bar'
|
||
a.options.myOption3; // 5</code></pre>
|
||
|
||
<p>There's also <code>L.Util.setOptions</code>, a method for conveniently merging options passed to constructor with the defauls defines in the class:</p>
|
||
|
||
<pre><code>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}</code></pre>
|
||
|
||
<h3>Includes</h3>
|
||
|
||
<p><code>includes</code> is a special class property that merges all specified objects into the class (such objects are called mixins). A good example of this is <code>L.Mixin.Events</code> that <a href="#events">event-related methods</a> like <code>on</code>, <code>off</code> and <code>fire</code> to the class.</p>
|
||
|
||
<pre><code> var MyMixin = {
|
||
foo: function () { ... },
|
||
bar: 5
|
||
};
|
||
|
||
var MyClass = L.Class.extend({
|
||
includes: MyMixin
|
||
});
|
||
|
||
var a = new MyClass();
|
||
a.foo();</code></pre>
|
||
|
||
<p>You can also do such includes in runtime with the <code>include</code> method:</p>
|
||
|
||
<pre><code><b>MyClass.include</b>(MyMixin);</code></pre>
|
||
|
||
<h3>Statics</h3>
|
||
|
||
<p><code>statics</code> is just a convenience property that injects specified object properties as the static properties of the class, useful for defining constants:</p>
|
||
|
||
<pre><code>var MyClass = L.Class.extend({
|
||
statics: {
|
||
FOO: 'bar',
|
||
BLA: 5
|
||
}
|
||
});
|
||
|
||
MyClass.FOO; // 'bar'</code></pre>
|
||
|
||
|
||
<h3>Constructor Hooks</h3>
|
||
|
||
<p>If you're a plugin developer, you often need to add additional initialization code to existing classes (e.g. editing hooks for <code>L.Polyline</code>). Leaflet comes with a way to do it easily using the <code>addInitHook</code> method:</p>
|
||
|
||
<pre><code>MyClass.addInitHook(function () {
|
||
// ... do something in constructor additionally
|
||
// e.g. add event listeners, set custom properties etc.
|
||
});</code></pre>
|
||
|
||
<p>You can also use the following shortcut when you just need to make one additional method call:</p>
|
||
|
||
<pre><code>MyClass.addInitHook('methodName', arg1, arg2, …);</code></pre>
|
||
|
||
|
||
<h2 id="browser">Browser</h2>
|
||
|
||
<p>A namespace with properties for browser/feature detection used by Leaflet internally.</p>
|
||
|
||
<pre><code>if (L.Browser.ie6) {
|
||
alert('Upgrade your browser, dude!');
|
||
}</code></pre>
|
||
|
||
<table data-id='browser'>
|
||
<tr>
|
||
<th class="width100">property</th>
|
||
<th class="width100">type</th>
|
||
<th>description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>ie</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for all Internet Explorer versions.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>ie6</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for Internet Explorer 6.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>ie7</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for Internet Explorer 7.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>webkit</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for webkit-based browsers like Chrome and Safari (including mobile versions).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>webkit3d</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for webkit-based browsers that support CSS 3D transformations.</td>
|
||
</tr>
|
||
<!--<tr>
|
||
<td><code><b>gecko</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for Gecko-based browsers like Firefox and Mozilla.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>opera</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for Opera.</td>
|
||
</tr>-->
|
||
<tr>
|
||
<td><code><b>android</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for Android mobile browser.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>android23</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for old Android stock browsers (2 and 3).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mobile</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for modern mobile browsers (including iOS Safari and different Android browsers).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mobileWebkit</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for mobile webkit-based browsers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>mobileOpera</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for mobile Opera.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>touch</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for all browsers on touch devices.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>msTouch</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for browsers with Microsoft touch model (e.g. IE10).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>retina</b></code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td><code><span class="literal">true</span></code> for devices with Retina screens.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="util">Util</h2>
|
||
|
||
<p>Various utility functions, used by Leaflet internally.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='util'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>extend</b>(
|
||
<nobr><Object> <i>dest</i></nobr>,
|
||
<nobr><Object> <i>src?..</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Object</code></td>
|
||
<td>Merges the properties of the <code>src</code> object (or multiple objects) into <code>dest</code> object and returns the latter. Has an <code>L.extend</code> shortcut.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>bind</b>(
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Object> <i>obj</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Function</code></td>
|
||
<td>Returns a function which executes function <code>fn</code> with the given scope <code>obj</code> (so that <code><span class="keyword">this</span></code> keyword refers to <code>obj</code> inside the function code). Has an <code>L.bind</code> shortcut. Not a polyfill for ES 5 <code>bind</code> (compare <code>L.bind</code> to the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind#Polyfill">MDN-recommended polyfill</a> for <code>Function.prototype.bind</code>).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>stamp</b>( <Object> <i>obj</i></nobr> )<nobr></code></td>
|
||
<td><code>String</code></td>
|
||
<td>Applies a unique key to the object and returns that key. Has an <code>L.stamp</code> shortcut.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>requestAnimFrame</b>(
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Object> <i>context?</i></nobr>,
|
||
<nobr><Boolean> <i>immediate?</i></nobr>,
|
||
<nobr><HTMLElement> <i>element?</i> )</nobr>
|
||
</code></td>
|
||
<td><code>Number</code></td>
|
||
<td>Schedules <code>fn</code> to be executed when the browser repaints. When <code>immediate</code> is set, <code>fn</code> is called immediately if the browser doesn't have native support for <code>requestAnimationFrame</code>, otherwise it's delayed. Returns an id that can be used to cancel the request</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>cancelAnimFrame</b>(
|
||
<nobr><Number> <i>id</i> )</nobr>
|
||
</code></td>
|
||
<td>-</td>
|
||
<td>Cancels a previous request to <code>requestAnimFrame</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>limitExecByInterval</b>(
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Number> <i>time</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Function</code></td>
|
||
<td>Returns a wrapper around the function <code>fn</code> that makes sure it's called not more often than a certain time interval <code>time</code>, but as fast as possible otherwise (for example, it is used for checking and requesting new tiles while dragging the map), optionally passing the scope (<code>context</code>) in which the function will be called.</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><code><b>falseFn</b>()</code></td>
|
||
<td><code>Function</code></td>
|
||
<td>Always returns <code><span class="literal">false</span></code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>formatNum</b>(
|
||
<nobr><Number> <i>num</i></nobr>,
|
||
<nobr><Number> <i>digits</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Number</code></td>
|
||
<td>Returns the number <code>num</code> rounded to <code>digits</code> decimals.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>splitWords</b>(
|
||
<nobr><String> <i>str</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>String[]</code></td>
|
||
<td>Trims and splits the string on whitespace and returns the array of parts.</code></td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setOptions</b>(
|
||
<nobr><Object> <i>obj</i></nobr>,
|
||
<nobr><Object> <i>options</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Object</code></td>
|
||
<td>Merges the given properties to the <code>options</code> of the <code>obj</code> object, returning the resulting options. See <a href="#class-options">Class options</a>. Has an <code>L.setOptions</code> shortcut.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getParamString</b>(
|
||
<nobr><Object> <i>obj</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>String</code></td>
|
||
<td>Converts an object into a parameter URL string, e.g. <nobr><code>{a: "foo", b: "bar"}</code></nobr> translates to <code><span class="string">'?a=foo&b=bar'</span></code>.</td>
|
||
</tr>
|
||
<tr id="util-template">
|
||
<td><code><b>template</b>(
|
||
<nobr><String> <i>str</i>, <Object> <i>data</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>String</code></td>
|
||
<td>Simple templating facility, accepts a template string of the form <code><span class="string">'Hello {a}, {b}'</span></code> and a data object like <code>{a: 'foo', b: 'bar'}</code>, returns evaluated string (<code><span class="string">'Hello foo, bar'</span></code>). You can also specify functions instead of strings for data values — they will be evaluated passing <code>data</code> as an argument.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>isArray</b>(
|
||
<nobr><Object> <i>obj</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the given object is an array.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>trim</b>(
|
||
<nobr><String> <i>str</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>String</code></td>
|
||
<td>Trims the whitespace from both ends of the string and returns the result.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Properties</h3>
|
||
|
||
<table data-id='util'>
|
||
<tr>
|
||
<th>Property</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>emptyImageUrl</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>Data URI string containing a base64-encoded empty GIF image. Used as a hack to free memory from unused images on WebKit-powered mobile devices (by setting image <code>src</code> to this string).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="transformation">Transformation</h2>
|
||
|
||
<p>Represents an affine transformation: a set of coefficients <code>a</code>, <code>b</code>, <code>c</code>, <code>d</code> for transforming a point of a form <code>(x, y)</code> into <code>(a*x + b, c*y + d)</code> and doing the reverse. Used by Leaflet in its projections code.</p>
|
||
|
||
<pre><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)
|
||
</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='transformation'>
|
||
<tr>
|
||
<th class="width250">Creation</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><nobr><span class='keyword'>new</span> <b>L.Transformation</b>(</nobr>
|
||
<nobr><Number> <i>a</i></nobr>,
|
||
<nobr><Number> <i>b</i></nobr>,
|
||
<nobr><Number> <i>c</i></nobr>,
|
||
<nobr><Number> <i>d</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Creates a transformation object with the given coefficients.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='transformation'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>transform</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
|
||
<nobr><Number> <i>scale?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns a transformed point, optionally multiplied by the given scale. Only accepts real <code>L.Point</code> instances, not arrays.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>untransform</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
|
||
<nobr><Number> <i>scale?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the reverse transformation of the given point, optionally divided by the given scale. Only accepts real <code>L.Point</code> instances, not arrays.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h2 id="lineutil">LineUtil</h2>
|
||
|
||
<p>Various utility functions for polyine points processing, used by Leaflet internally to make polylines lightning-fast.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='lineutil'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>simplify</b>(
|
||
<nobr><<a href="#point">Point</a>[]> <i>points</i></nobr>,
|
||
<nobr><Number> <i>tolerance</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a>[]</code></td>
|
||
|
||
<td>Dramatically reduces the number of points in a polyline while retaining its shape and returns a new array of simplified points. Used for a huge performance boost when processing/displaying Leaflet polylines for each zoom level and also reducing visual noise. <code>tolerance</code> affects the amount of simplification (lesser value means higher quality but slower and with more points). Also released as a separated micro-library <a href="http://mourner.github.com/simplify-js/">Simplify.js</a>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>pointToSegmentDistance</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>p</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>p1</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>p2</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Number</code></td>
|
||
|
||
<td>Returns the distance between point <code>p</code> and segment <code>p1</code> to <code>p2</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>closestPointOnSegment</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>p</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>p1</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>p2</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
|
||
<td>Returns the closest point from a point <code>p</code> on a segment <code>p1</code> to <code>p2</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>clipSegment</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>a</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>b</i></nobr>,
|
||
<nobr><<a href="#bounds">Bounds</a>> <i>bounds</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>-</code></td>
|
||
|
||
<td>Clips the segment <code>a</code> to <code>b</code> by rectangular bounds (modifying the segment points directly!). Used by Leaflet to only show polyline points that are on the screen or near, increasing performance.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="polyutil">PolyUtil</h2>
|
||
|
||
<p>Various utility functions for polygon geometries.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='polylineutil'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>clipPolygon</b>(
|
||
<nobr><<a href="#point">Point</a>[]> <i>points</i></nobr>,
|
||
<nobr><<a href="#bounds">Bounds</a>> <i>bounds</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a>[]</code></td>
|
||
|
||
<td>Clips the polygon geometry defined by the given points by rectangular bounds. 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.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h2 id="domevent">DomEvent</h2>
|
||
|
||
<p>Utility functions to work with the DOM events, used by Leaflet internally.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='domevent'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addListener</b>(
|
||
<nobr><HTMLElement> <i>el</i></nobr>,
|
||
<nobr><String> <i>type</i></nobr>,
|
||
<nobr><Function> <i>fn</i></nobr>,
|
||
<nobr><Object> <i>context?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds a listener <code>fn</code> to the element's DOM event of the specified type. <code><span class="keyword">this</span></code> keyword inside the listener will point to <code>context</code>, or to the element if not specified.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeListener</b>(
|
||
<nobr><HTMLElement> <i>el</i></nobr>,
|
||
<nobr><String> <i>type</i></nobr>,
|
||
<nobr><Function> <i>fn</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Removes an event listener from the element.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>stopPropagation</b>(
|
||
<nobr><DOMEvent> <i>e</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Stop the given event from propagation to parent elements. Used inside the listener functions:
|
||
<pre><code>L.DomEvent.addListener(div, 'click', function (e) {
|
||
L.DomEvent.stopPropagation(e);
|
||
});</code></pre>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>preventDefault</b>(
|
||
<nobr><DOMEvent> <i>e</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Prevents the default action of the event from happening (such as following a link in the <code>href</code> of the <code>a</code> element, or doing a <code>POST</code> request with page reload when <code>form</code> is submitted). Use it inside listener functions.</pre>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>stop</b>(
|
||
<nobr><DOMEvent> <i>e</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Does <code>stopPropagation</code> and <code>preventDefault</code> at the same time.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>disableClickPropagation</b>(
|
||
<nobr><HTMLElement> <i>el</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Adds <code>stopPropagation</code> to the element's <code><span class="string">'click'</span></code>, <code><span class="string">'doubleclick'</span></code>, <code><span class="string">'mousedown'</span></code> and <code><span class="string">'touchstart'</span></code> events.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getMousePosition</b>(
|
||
<nobr><DOMEvent> <i>e</i></nobr>,
|
||
<nobr><HTMLElement> <i>container?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Gets normalized mouse position from a DOM event relative to the container or to the whole page if not specified.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getWheelDelta</b>(
|
||
<nobr><DOMEvent> <i>e</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Number</code></td>
|
||
<td>Gets normalized wheel delta from a <code>mousewheel</code> DOM event.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h2 id="domutil">DomUtil</h2>
|
||
|
||
<p>Utility functions to work with the DOM tree, used by Leaflet internally.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='domutil'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>get</b>(
|
||
<nobr><String or HTMLElement> <i>id</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Returns an element with the given id if a string was passed, or just returns the element if it was passed directly.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getStyle</b>(
|
||
<nobr><HTMLElement> <i>el</i></nobr>,
|
||
<nobr><String> <i>style</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>String</code></td>
|
||
<td>Returns the value for a certain style attribute on an element, including computed values or values set through CSS.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getViewportOffset</b>(
|
||
<nobr><HTMLElement> <i>el</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><a href="#point"><code>Point</code></a></td>
|
||
<td>Returns the offset to the viewport for the requested element.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>create</b>(
|
||
<nobr><String> <i>tagName</i></nobr>,
|
||
<nobr><String> <i>className</i></nobr>,
|
||
<nobr><HTMLElement> <i>container?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>HTMLElement</code></td>
|
||
|
||
<td>Creates an element with <code>tagName</code>, sets the <code>className</code>, and optionally appends it to <code>container</code> element.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>disableTextSelection</b>()</code></td>
|
||
<td>-</td>
|
||
<td>Makes sure text cannot be selected, for example during dragging.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>enableTextSelection</b>()</code></td>
|
||
<td>-</td>
|
||
<td>Makes text selection possible again.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>hasClass</b>(
|
||
<nobr><HTMLElement> <i>el</i></nobr>,
|
||
<nobr><String> <i>name</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Boolean</code></td>
|
||
|
||
<td>Returns <code><span class="literal">true</span></code> if the element class attribute contains <code>name</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>addClass</b>(
|
||
<nobr><HTMLElement> <i>el</i></nobr>,
|
||
<nobr><String> <i>name</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>-</td>
|
||
|
||
<td>Adds <code>name</code> to the element's class attribute.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>removeClass</b>(
|
||
<nobr><HTMLElement> <i>el</i></nobr>,
|
||
<nobr><String> <i>name</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>-</td>
|
||
|
||
<td>Removes <code>name</code> from the element's class attribute.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setOpacity</b>(
|
||
<nobr><HTMLElement> <i>el</i></nobr>,
|
||
<nobr><Number> <i>value</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>-</td>
|
||
<td>Set the opacity of an element (including old IE support). Value must be from <code>0</code> to <code>1</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>testProp</b>(
|
||
<nobr><String[]> <i>props</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>String</code> or <code><span class="literal">false</span></code></td>
|
||
<td>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 <code><span class="literal">false</span></code>. Useful for vendor-prefixed styles like <code>transform</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getTranslateString</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>String</code></td>
|
||
<td>Returns a CSS transform string to move an element by the offset provided in the given point. Uses 3D translate on WebKit for hardware-accelerated transforms and 2D on other browsers.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getScaleString</b>(
|
||
<nobr><Number> <i>scale</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>origin</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>String</code></td>
|
||
<td>Returns a CSS transform string to scale an element (with the given scale origin).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>setPosition</b>(
|
||
<nobr><HTMLElement> <i>el</i></nobr>,
|
||
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
|
||
<nobr><Boolean> <i>disable3D?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>-</td>
|
||
<td>Sets the position of an element to coordinates specified by <code>point</code>, using CSS translate or top/left positioning depending on the browser (used by Leaflet internally to position its layers). Forces top/left positioning if <code>disable3D</code> is <code><span class="literal">true</span></code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getPosition</b>(
|
||
<nobr><HTMLElement> <i>el</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><a href="#point">Point</a></td>
|
||
<td>Returns the coordinates of an element previously positioned with <code>setPosition</code>.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Properties</h3>
|
||
|
||
<table data-id='domutil'>
|
||
<tr>
|
||
<th>Property</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>TRANSITION</b></nobr>
|
||
</code></td>
|
||
<td><code>String</code></td>
|
||
<td>Vendor-prefixed transition style name (e.g. <code><span class="string">'webkitTransition'</span></code> for WebKit).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>TRANSFORM</b></nobr>
|
||
</code></td>
|
||
<td><code>String</code></td>
|
||
<td>Vendor-prefixed transform style name.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="posanimation">PosAnimation</h2>
|
||
|
||
<p>Used internally for panning animations, utilizing CSS3 Transitions for modern browsers and a timer fallback for IE6-9.</p>
|
||
|
||
<pre><code class="javascript">var fx = new L.PosAnimation();
|
||
fx.run(el, [300, 500], 0.5);</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='posanimation'>
|
||
<tr>
|
||
<th class="width200">Creation</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><span class='keyword'>new</span> <b>L.PosAnimation</b>()</code></td>
|
||
|
||
<td>Creates a PosAnimation object.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='posanimation'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>run</b>(
|
||
<nobr><HTMLElement> <i>element</i>,</nobr>
|
||
<nobr><<a href="#point">Point</a>> <i>newPos</i></nobr>,
|
||
<nobr><Number> <i>duration?</i></nobr>,
|
||
<nobr><Number> <i>easeLinearity?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><span class="keyword">this</span></code></td>
|
||
<td>Run an animation of a given element to a new position, optionally setting duration in seconds (<code><span class="number">0.25</span></code> by default) and easing linearity factor (3rd argument of the <a href="http://cubic-bezier.com/#0,0,.5,1">cubic bezier curve</a>, <code><span class="number">0.5</span></code> by default)</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Events</h3>
|
||
|
||
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
|
||
|
||
<table data-id='posanimation'>
|
||
<tr>
|
||
<th class="width100">Event</th>
|
||
<th class="width100">Data</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>start</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the animation starts.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>step</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired continuously during the animation.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>end</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the animation ends.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
<h2 id="draggable">Draggable</h2>
|
||
|
||
<p>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 <a href="#domutil-setposition">DomUtil#setPosition</a></p>
|
||
|
||
<pre><code class="javascript">var draggable = new L.Draggable(elementToDrag);
|
||
draggable.enable();
|
||
</code></pre>
|
||
|
||
<h3>Creation</h3>
|
||
|
||
<table data-id='draggable'>
|
||
<tr>
|
||
<th class="width200">Creation</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b><span class='keyword'>new</span> L.Draggable</b>(
|
||
<nobr><HTMLElement> <i>element</i>,</nobr>
|
||
<nobr><HTMLElement> <i>dragHandle?</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>Creates a Draggable object for moving the given element when you start dragging the <code>dragHandle</code> element (equals the element itself by default).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Events</h3>
|
||
|
||
<p>You can subscribe to the following events using <a href="#events">these methods</a>.</p>
|
||
|
||
<table data-id='draggable'>
|
||
<tr>
|
||
<th class="width100">Event</th>
|
||
<th class="width100">Data</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dragstart</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the dragging starts.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>predrag</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired continuously during dragging <em>before</em> each corresponding update of the element position.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>drag</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired continuously during dragging.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>dragend</b></code></td>
|
||
<td><code><a href="#event">Event</a></code></td>
|
||
<td>Fired when the dragging ends.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='draggable'>
|
||
<tr>
|
||
<th class="width100">Method</th>
|
||
<th class="width100">Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>enable</b>()</code></td>
|
||
<td><code>-</code></td>
|
||
<td>Enables the dragging ability.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>disable</b>()</code></td>
|
||
<td><code>-</code></td>
|
||
<td>Disables the dragging ability.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<!--<h3>Static Properties</h3>
|
||
|
||
<table>
|
||
<tr>
|
||
<th>Property</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>START</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>Name of the DOM event that initiates dragging. <code><span class="string">'mousedown'</span></code> for desktop browsers, <code><span class="string">'touchstart'</span></code> for mobile devices.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>MOVE</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>Name of the DOM event for drag moving. <code><span class="string">'mousemove'</span></code> for desktop browsers, <code><span class="string">'touchmove'</span></code> for mobile devices.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>END</b></code></td>
|
||
<td><code>String</code></td>
|
||
<td>Name of the DOM event that ends dragging. <code><span class="string">'mouseup'</span></code> for desktop browsers, <code><span class="string">'touchend'</span></code> for mobile devices.</td>
|
||
</tr>
|
||
</table>-->
|
||
|
||
|
||
|
||
<h2 id="ihandler">IHandler</h2>
|
||
<p>An interface implemented by <a href="#map-interaction-handlers">interaction handlers</a>.</p>
|
||
|
||
<table data-id='ihandler'>
|
||
<tr>
|
||
<th class="width100">Method</th>
|
||
<th class="width100">Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>enable</b>()</code></td>
|
||
<td>-</td>
|
||
<td>Enables the handler.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>disable</b>()</code></td>
|
||
<td>-</td>
|
||
<td>Disables the handler.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>enabled</b>()</code></td>
|
||
<td><code>Boolean</code></td>
|
||
<td>Returns <code><span class="literal">true</span></code> if the handler is enabled.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
<h2 id="ilayer">ILayer</h2>
|
||
|
||
<p>Represents an object attached to a particular location (or a set of locations) on a map. Implemented by <a href="#tilelayer">tile layers</a>, <a href="#marker">markers</a>, <a href="#popup">popups</a>, <a href="#imageoverlay">image overlays</a>, <a href="#path">vector layers</a> and <a href="#layergroup">layer groups</a>.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='ilayer'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>onAdd</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>-</td>
|
||
<td>Should contain code that creates DOM elements for the overlay, adds them to <a href="#map-panes">map panes</a> where they should belong and puts listeners on relevant map events. Called on <code>map.addLayer(layer)</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>onRemove</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>-</td>
|
||
<td>Should contain all clean up code that removes the overlay's elements from the DOM and removes listeners previously added in <code>onAdd</code>. Called on <code>map.removeLayer(layer)</code>.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Implementing Custom Layers</h3>
|
||
|
||
<p>The most important things know about when implementing custom layers are Map <a href="#map-viewreset">viewreset</a> event and <a href="#map-latlngtolayerpoint">latLngToLayerPoint</a> method. <code>viewreset</code> is fired when the map needs to reposition its layers (e.g. on zoom), and <code>latLngToLayerPoint</code> is used to get coordinates for the layer's new position.</p>
|
||
|
||
<p>Another event often used in layer implementations is <a href="#map-moveend">moveend</a> which fires after any movement of the map (panning, zooming, etc.).</p>
|
||
|
||
<p>Another thing to note is that you'll usually need to add <code>leaflet-zoom-hide</code> class to the DOM elements you create for the layer so that it hides during zoom animation. Implementing zoom animation for custom layers is a complex topic and will be documented separately in future, but meanwhile you can take a look at how it's done for Leaflet layers (e.g. <code>ImageOverlay</code>) in the source.</p>
|
||
|
||
<h3>Custom Layer Example</h3>
|
||
|
||
<p>Here's how a custom layer implementation usually looks:</p>
|
||
|
||
<pre><code>var MyCustomLayer = L.Class.extend({
|
||
|
||
initialize: function (latlng) {
|
||
// save position of the layer or any options from the constructor
|
||
this._latlng = latlng;
|
||
},
|
||
|
||
onAdd: function (map) {
|
||
this._map = map;
|
||
|
||
// create a DOM element and put it into one of the map panes
|
||
this._el = L.DomUtil.create('div', 'my-custom-layer leaflet-zoom-hide');
|
||
map.getPanes().overlayPane.appendChild(this._el);
|
||
|
||
// add a viewreset event listener for updating layer's position, do the latter
|
||
map.on('viewreset', this._reset, this);
|
||
this._reset();
|
||
},
|
||
|
||
onRemove: function (map) {
|
||
// remove layer's DOM elements and listeners
|
||
map.getPanes().overlayPane.removeChild(this._el);
|
||
map.off('viewreset', this._reset, this);
|
||
},
|
||
|
||
_reset: function () {
|
||
// update layer's position
|
||
var pos = this._map.latLngToLayerPoint(this._latlng);
|
||
L.DomUtil.setPosition(this._el, pos);
|
||
}
|
||
});
|
||
|
||
map.addLayer(new MyCustomLayer(latlng));
|
||
</code></pre>
|
||
|
||
|
||
|
||
<h2 id="icontrol">IControl</h2>
|
||
|
||
<p>Represents a UI element in one of the corners of the map. Implemented by <a href="#control-zoom">zoom</a>, <a href="#control-attribution">attribution</a>, <a href="#control-scale">scale</a> and <a href="#control-layers">layers</a> controls.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<p>Every control in Leaflet should extend from <a href="#control">Control</a> class and additionally have the following methods:</p>
|
||
|
||
<table data-id='icontrol'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>onAdd</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>HTMLElement</code></td>
|
||
<td>Should contain code that creates all the neccessary DOM elements for the control, adds listeners on relevant map events, and returns the element containing the control. Called on <code>map.addControl(control)</code> or <code>control.addTo(map)</code>.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>onRemove</b>(
|
||
<nobr><<a href="#map-class">Map</a>> <i>map</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td>-</td>
|
||
<td>Optional, should contain all clean up code (e.g. removes control's event listeners). Called on <code>map.removeControl(control)</code> or <code>control.removeFrom(map)</code>. The control's DOM container is removed automatically.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Custom Control Example</h3>
|
||
|
||
<pre><code>var MyControl = L.Control.extend({
|
||
options: {
|
||
position: 'topright'
|
||
},
|
||
|
||
onAdd: function (map) {
|
||
// create the control container with a particular class name
|
||
var container = L.DomUtil.create('div', 'my-custom-control');
|
||
|
||
// ... initialize other DOM elements, add listeners, etc.
|
||
|
||
return container;
|
||
}
|
||
});
|
||
|
||
map.addControl(new MyControl());
|
||
</code></pre>
|
||
|
||
<p>If specify your own constructor for the control, you'll also probably want to process options properly:</p>
|
||
|
||
<pre><code>var MyControl = L.Control.extend({
|
||
initialize: function (foo, options) {
|
||
// ...
|
||
L.Util.setOptions(this, options);
|
||
},
|
||
// ...
|
||
});</code></pre>
|
||
|
||
<p>This will allow you to pass options like <code>position</code> when creating the control instances:</p>
|
||
|
||
<pre><code>map.addControl(new MyControl('bar', {position: 'bottomleft'}));</code></pre>
|
||
|
||
|
||
|
||
|
||
<h2 id="iprojection">IProjection</h2>
|
||
|
||
<p>An object with methods for projecting geographical coordinates of the world onto a flat surface (and back). See <a href="http://en.wikipedia.org/wiki/Map_projection">Map projection</a>.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='iprojection'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>project</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Projects geographical coordinates into a 2D point.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>unproject</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>The inverse of <code>project</code>. Projects a 2D point into geographical location.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Defined Projections</h3>
|
||
|
||
<p>Leaflet comes with a set of already defined projections out of the box:</p>
|
||
|
||
<table data-id='projections'>
|
||
<tr>
|
||
<th>Projection</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.Projection.SphericalMercator</b></code></td>
|
||
|
||
<td>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 <code>EPSG:3857</code> CRS.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.Projection.Mercator</b></code></td>
|
||
|
||
<td>Elliptical Mercator projection — more complex than Spherical Mercator. Takes into account that Earth is a geoid, not a perfect sphere. Used by the <code>EPSG:3395</code> CRS.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.Projection.LonLat</b></code></td>
|
||
|
||
<td>Equirectangular, or Plate Carree projection — the most simple projection, mostly used by GIS enthusiasts. Directly maps <code>x</code> as longitude, and <code>y</code> as latitude. Also suitable for flat worlds, e.g. game maps. Used by the <code>EPSG:3395</code> and <code>Simple</code> CRS.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
|
||
|
||
|
||
<h2 id="icrs">ICRS</h2>
|
||
|
||
<p>Defines coordinate reference systems for projecting geographical points into pixel (screen) coordinates and back (and to coordinates in other units for WMS services). See <a href="http://en.wikipedia.org/wiki/Coordinate_reference_system">Spatial reference system</a>.</p>
|
||
|
||
<h3>Methods</h3>
|
||
|
||
<table data-id='icrs'>
|
||
<tr>
|
||
<th>Method</th>
|
||
<th>Returns</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>latLngToPoint</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i></nobr>,
|
||
<nobr><Number> <i>zoom</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Projects geographical coordinates on a given zoom into pixel coordinates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>pointToLatLng</b>(
|
||
<nobr><<a href="#point">Point</a>> <i>point</i></nobr>,
|
||
<nobr><Number> <i>zoom</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#latlng">LatLng</a></code></td>
|
||
<td>The inverse of <code>latLngToPoint</code>. Projects pixel coordinates on a given zoom into geographical coordinates.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>project</b>(
|
||
<nobr><<a href="#latlng">LatLng</a>> <i>latlng</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Projects geographical coordinates into coordinates in units accepted for this CRS (e.g. meters for <code>EPSG:3857</code>, for passing it to WMS services).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>scale</b>(
|
||
<nobr><Number> <i>zoom</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code>Number</code></td>
|
||
<td>Returns the scale used when transforming projected coordinates into pixel coordinates for a particular zoom. For example, it returns <code>256 * 2^zoom</code> for Mercator-based CRS.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>getSize</b>(
|
||
<nobr><Number> <i>zoom</i> )</nobr>
|
||
</code></td>
|
||
|
||
<td><code><a href="#point">Point</a></code></td>
|
||
<td>Returns the size of the world in pixels for a particular zoom.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Properties</h3>
|
||
|
||
<table data-id='icrs'>
|
||
<tr>
|
||
<th>Property</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>projection</b></code></td>
|
||
|
||
<td><code><a href="#iprojection">IProjection</a></code></td>
|
||
<td>Projection that this CRS uses.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>transformation</b></code></td>
|
||
|
||
<td><code><a href="#transformation">Transformation</a></code></td>
|
||
<td>Transformation that this CRS uses to turn projected coordinates into screen coordinates for a particular tile service.</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td><code><b>code</b></code></td>
|
||
|
||
<td><code>String</code></td>
|
||
<td>Standard code name of the CRS passed into WMS services (e.g. <code><span class="string">'EPSG:3857'</span></code>).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h3>Defined CRS</h3>
|
||
|
||
<p>Leaflet comes with a set of already defined CRS to use out of the box:</p>
|
||
|
||
<table data-id='defined-crs'>
|
||
<tr>
|
||
<th>Projection</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.CRS.EPSG3857</b></code></td>
|
||
|
||
<td>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 <code>crs</code> option.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.CRS.EPSG4326</b></code></td>
|
||
|
||
<td>A common CRS among GIS enthusiasts. Uses simple Equirectangular projection.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.CRS.EPSG3395</b></code></td>
|
||
|
||
<td>Rarely used by some commercial tile providers. Uses Elliptical Mercator projection.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L.CRS.Simple</b></code></td>
|
||
|
||
<td>A simple CRS that maps longitude and latitude into <code>x</code> and <code>y</code> directly. May be used for maps of flat surfaces (e.g. game maps). Note that the <code>y</code> axis should still be inverted (going from bottom to top).</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<p>If you want to use some obscure CRS not listed here, take a look at the <a href="https://github.com/kartena/Proj4Leaflet">Proj4Leaflet</a> plugin.</p>
|
||
|
||
|
||
<h2 id="global">Global Switches</h2>
|
||
|
||
<p>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 <code><span class="literal">true</span></code> <em>before</em> including Leaflet on the page, like this:</p>
|
||
|
||
<pre><code><script>L_PREFER_CANVAS = true;</script>
|
||
<script src="leaflet.js"></script></code></pre>
|
||
|
||
<table data-id='global'>
|
||
<tr>
|
||
<th>Switch</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L_PREFER_CANVAS</b></code></td>
|
||
<td>Forces Leaflet to use the Canvas back-end (if available) for vector layers instead of SVG. This can increase performance considerably in some cases (e.g. many thousands of circle markers on the map).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L_NO_TOUCH</b></code></td>
|
||
<td>Forces Leaflet to not use touch events even if it detects them.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code><b>L_DISABLE_3D</b></code></td>
|
||
<td>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.</td>
|
||
</tr>
|
||
</table>
|
||
|
||
<h2 id="noconflict">noConflict</h2>
|
||
|
||
<p>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:<p>
|
||
|
||
<pre><code>// L points to some other library
|
||
...
|
||
// you include Leaflet, it replaces the L variable to Leaflet namespace
|
||
|
||
var Leaflet = L.noConflict();
|
||
// now L points to that other library again, and you can use Leaflet.Map etc.</code></pre>
|
||
|
||
|
||
<h2 id="version">version</h2>
|
||
|
||
<p>A constant that represents the Leaflet version in use.<p>
|
||
|
||
<pre><code>L.version // returns "0.5" (or whatever version is currently in use)</code></pre>
|
||
|
||
<script>
|
||
var tables = document.getElementsByTagName('table');
|
||
for (var i = 0, len = tables.length; i < len; i++) {
|
||
var id = tables[i].getAttribute('data-id'),
|
||
tds = tables[i].getElementsByTagName('td');
|
||
for (var j = 0, tdLen = tds.length; j < tdLen; j++) {
|
||
if (tds[j].cellIndex === 0) {
|
||
tds[j].parentNode.id = id + '-' + (tds[j].textContent || tds[j].innerText).split('(')[0].toLowerCase();
|
||
tds[j].parentNode.onclick = function(e) {
|
||
if ((window.innerWidth / 2) - e.clientX > 394) window.location.hash = '#' + this.id;
|
||
};
|
||
}
|
||
}
|
||
}
|
||
</script>
|