1052 lines
35 KiB
HTML
1052 lines
35 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<title>Leaflet - a modern, lightweight JavaScript library for interactive maps by CloudMade - API reference</title>
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
<!-- Blueprint -->
|
|
<link rel="stylesheet" href="docs/css/blueprint/screen.css" media="screen, projection">
|
|
<link rel="stylesheet" href="docs/css/blueprint/print.css" media="print">
|
|
<!--[if lt IE 8]><link rel="stylesheet" href="docs/css/blueprint/ie.css" media="screen, projection"><![endif]-->
|
|
|
|
<link rel="stylesheet" href="docs/css/screen.css" media="screen, projection" />
|
|
|
|
<script src="docs/highlight/highlight.pack.js"></script>
|
|
<link rel="stylesheet" href="docs/highlight/styles/github.css" />
|
|
|
|
<!-- Leaflet -->
|
|
<link rel="stylesheet" href="dist/leaflet.css" />
|
|
<!--[if lte IE 8]><link rel="stylesheet" href="dist/leaflet.ie.css" /><![endif]-->
|
|
<script src="dist/leaflet.js"></script>
|
|
</head>
|
|
<body>
|
|
<div class="container">
|
|
<h1>Leaflet</h1>
|
|
<h3 class="alt">A Modern, Lightweight Open-Source JavaScript Library for Interactive Maps by <a href="http://cloudmade.com">CloudMade</a></h3>
|
|
|
|
<hr />
|
|
<p class="nav large quiet">
|
|
<a href="index.html">Home</a> |
|
|
<a href="features.html">Features</a> |
|
|
<span>Documentation</span> |
|
|
<a href="#">Examples</a> |
|
|
<a href="http://github.com/CloudMade/Leaflet/zipball/master">Download (zip)</a> |
|
|
<a class="github-link" href="http://github.com/CloudMade/Leaflet">Source on GitHub</a> |
|
|
<a class="twitter-link" href="http://twitter.com/LeafletJS">Follow on Twitter</a>
|
|
</p>
|
|
<hr />
|
|
|
|
<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">Constructor</a></li>
|
|
<li><a href="#map-options">Options</a></li>
|
|
<li><a href="#map-interaction-handlers">Interaction handlers</a></li>
|
|
<li><a href="#map-events">Events</a></li>
|
|
</ul>
|
|
<h4>Map methods</h4>
|
|
<ul>
|
|
<li><a href="#map-set-methods">Methods that modify map state</a></li>
|
|
<li><a href="#map-get-methods">Methods that get map state</a></li>
|
|
<li><a href="#map-conversion-methods">Conversion methods</a></li>
|
|
<li><a class="nodocs" href="#">Methods for controls</a></li>
|
|
<li><a class="nodocs" href="#">Misc. methods</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 class="nodocs" href="#">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="#polygon">Polygon</a></li>
|
|
<li><a href="#circle">Circle</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="span-3">
|
|
<h4>Basic types</h4>
|
|
<ul>
|
|
<li><a href="#latlng">LatLng</a></li>
|
|
<li><a class="nodocs" href="#">LatLngBounds</a></li>
|
|
<li><a href="#point">Point</a></li>
|
|
<li><a class="nodocs" href="#">Bounds</a></li>
|
|
<li><a class="nodocs" href="#">Icon</a></li>
|
|
</ul>
|
|
<h4>Interfaces</h4>
|
|
<ul>
|
|
<li><a href="#ihandler">IHandler</a></li>
|
|
<li><a class="nodocs" href="#">ILayer</a></li>
|
|
<li><a class="nodocs" href="#">IControl</a></li>
|
|
<li><a class="nodocs" href="#">IProjection</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="span-4 last">
|
|
<h4>Utility</h4>
|
|
<ul>
|
|
<li><a class="nodocs" href="#">Class</a></li>
|
|
<li><a class="nodocs" href="#">Browser</a></li>
|
|
<li><a class="nodocs" href="#">Util</a></li>
|
|
<!-- <li><a class="nodocs" href="#">LineUtil</a></li>
|
|
<li><a class="nodocs" href="#">PolyUtil</a></li> -->
|
|
</ul>
|
|
<h4>DOM utility</h4>
|
|
<ul>
|
|
<li><a class="nodocs" href="#">DomEvent</a></li>
|
|
<li><a class="nodocs" href="#">DomUtil</a></li>
|
|
<!-- <li><a class="nodocs" href="#">Transition</a></li>
|
|
<li><a class="nodocs" href="#">Draggable</a></li> -->
|
|
</ul>
|
|
<!-- <ul>
|
|
<li><a class="nodocs" href="#">Transformation</a></li>
|
|
<li><a class="nodocs" href="#">Projection.Mercator</a></li>
|
|
</ul> -->
|
|
<h4>Mixins</h4>
|
|
<ul>
|
|
<li><a class="nodocs" href="#">Mixin.Events</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<hr />
|
|
|
|
<h2 id="map-class">L.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 = new L.Map('map', {
|
|
center: new L.LatLng(51.505, -0.09),
|
|
zoom: 13
|
|
});
|
|
|
|
// create a CloudMade tile layer
|
|
var cloudmadeUrl = 'http://{s}.tile.cloudmade.com/YOUR-API-KEY/997/256/{z}/{x}/{y}.png',
|
|
cloudmade = new L.TileLayer(cloudmadeUrl, {maxZoom: 18});
|
|
|
|
// add the CloudMade layer to the map
|
|
map.addLayer(cloudmade);</code></pre>
|
|
|
|
<h3 id="map-constructor">Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Map( <HTMLElement|String> <i>id</i>, <<a href="#map-options">Map options</a>> <i>options?</i> )</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>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Option</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>center</code></td>
|
|
<td><code><a href="#latlng">LatLng</a></code></td>
|
|
<td><code>null</code></td>
|
|
<td>Initial geographical center of the map.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>zoom</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>null</code></td>
|
|
<td>Initial map zoom.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>layers</code></td>
|
|
<td><code>ILayer[]</code></td>
|
|
<td><code>[]</code></td>
|
|
<td>Layers that will be added to the map initially.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dragging</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Whether the map be draggable with mouse/touch or not.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>touchZoom</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Whether the map can be zoomed by touch-dragging with two fingers.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>scrollWheelZoom</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Whether the map can be zoomed by using the mouse wheel.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>doubleClickZoom</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Whether the map can be zoomed in by double clicking on it.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>trackResize</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Whether the map automatically handles browser window resize to update itself.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3 id="map-interaction-handlers">Interaction handlers</h3>
|
|
|
|
<p>Interaction handlers are properties of a map instance 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>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Property</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td>dragging</td>
|
|
<td><a href="#ihandler">IHandler</a></td>
|
|
<td>Map dragging handler (by both mouse and touch).</td>
|
|
</tr>
|
|
<tr>
|
|
<td>touchZoom</td>
|
|
<td><a href="#ihandler">IHandler</a></td>
|
|
<td>Touch zoom handler.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>doubleClickZoom</td>
|
|
<td><a href="#ihandler">IHandler</a></td>
|
|
<td>Double click zoom handler.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>scrollWheelZoom</td>
|
|
<td><a href="#ihandler">IHandler</a></td>
|
|
<td>Scroll wheel zoom handler.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>shiftDragZoom</td>
|
|
<td><a href="#ihandler">IHandler</a></td>
|
|
<td>Shift-drag zoom handler.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3 id="map-set-methods">Methods that modify map state</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Method</th>
|
|
<th>Returns</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>setView( <<a href="#latlng">LatLng</a>> <i>center</i>, <Number> <i>zoom</i>, <Boolean> <i>forceReset?</i> )</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Sets the view of the map (geographical center and zoom). If <code>forceReset</code> is set to <code>true</code>, the map is reloaded even if it's eligible for pan or zoom animation (<code>false</code> by default).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>setZoom( <Number> <i>zoom</i> )</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Sets the zoom of the map.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>zoomIn()</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Increases the zoom of the map by 1.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>zoomOut()</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Decreases the zoom of the map by 1.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fitBounds( <LatLngBounds> <i>bounds</i> )</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Sets a map view that contains the given geographical bounds with the maximum zoom level possible.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>panTo( <<a href="#latlng">LatLng</a>> <i>latlng</i> )</code></td>
|
|
<td><code>this</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>
|
|
<td><code>panBy( <<a href="#point">Point</a>> <i>point</i> )</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Pans the map by a given number of pixels (animated).</td>
|
|
</tr>
|
|
<tr id="map-addlayer">
|
|
<td><code>addLayer( <ILayer> <i>layer</i> )</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Adds the given layer to the map.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>removeLayer( <ILayer> <i>layer</i> )</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Removes the given layer from the map.</td>
|
|
</tr>
|
|
<tr id="map-openpopup">
|
|
<td><code>openPopup( <<a href="#popup">Popup</a>> <i>popup</i> )</code></td>
|
|
<td><code>this</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-closepopup">
|
|
<td><code>closePopup()</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Closes the popup opened with <a href="#map-openpopup">openPopup</a>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>invalidateSize()</code></td>
|
|
<td><code>this</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.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3 id="map-get-methods">Methods that get map state</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Method</th>
|
|
<th>Returns</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>getCenter()</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>getZoom()</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>Returns the current zoom of the map view.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>getMinZoom()</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>Returns the minimum zoom level of the map.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>getMaxZoom()</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>Returns the maximum zoom level of the map.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>getBoundsZoom( <LatLngBounds> <i>bounds</i> )</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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>getSize()</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>getPixelBounds()</code></td>
|
|
<td><code>Bounds</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>getPixelOrigin()</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>
|
|
<tr>
|
|
<td><code>getPanes()</code></td>
|
|
<td><code>Panes</code></td>
|
|
<td>Returns an object for accessing different panes of the map (tile pane, marker pane, etc.).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h3 id="map-conversion-methods">Conversion methods</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Method</th>
|
|
<th>Returns</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>latLngToLayerPoint( <<a href="#latlng">LatLng</a>> <i>latlng</i> )</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>layerPointToLatLng( <<a href="#point">Point</a>> <i>point</i> )</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>mouseEventToContainerPoint( <MouseEvent> <i>event</i> )</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>mouseEventToLayerPoint( <MouseEvent> <i>event</i> )</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>mouseEventToLatLng( <MouseEvent> <i>event</i> )</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>
|
|
<tr>
|
|
<td><code>containerPointToLayerPoint( <<a href="#point">Point</a>> <i>point</i> )</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>layerPointToContainerPoint( <<a href="#point">Point</a>> <i>point</i> )</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>project( <<a href="#latlng">LatLng</a>> <i>latlng</i>, <Number> <i>zoom?</i> )</code></td>
|
|
<td><code><a href="#point">Point</a></code></td>
|
|
<td>Projects the given geographical coordinates to pixel coordinates for the given zoom level (current zoom level by default).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>unproject( <<a href="#point">Point</a>> <i>point</i>, <Number> <i>zoom?</i> )</code></td>
|
|
<td><code><a href="#latlng">LatLng</a></code></td>
|
|
<td>Projects the given pixel coordinates to geographical coordinates for the given zoom level (current zoom level by default).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h2 id="marker">L.Marker</h2>
|
|
|
|
<p>Used to put markers on the map.</p>
|
|
|
|
<h3>Usage example</h3>
|
|
<pre><code class="javascript">var marker = new L.Marker(latlng);
|
|
map.addLayer(marker);</code></pre>
|
|
|
|
<h3>Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Marker( <<a href="#latlng">LatLng</a>> <i>latlng</i>, <<a href="#marker-options">Marker options</a>> <i>options?</i> )</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>
|
|
<tr>
|
|
<th>Option</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>icon</code></td>
|
|
<td>Class<br />(<code><a href="#icon">L.Icon</a></code> or its child)</td>
|
|
<td><code>L.Icon</code></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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>clickable</code></td>
|
|
<td>Boolean</td>
|
|
<td><code>true</code></td>
|
|
<td>If false, the marker will not emit mouse events and will act as a part of the underlying map.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Methods</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Method</th>
|
|
<th>Returns</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>getLatLng()</code></td>
|
|
<td><code><a href="#latlng">LatLng</a></code></td>
|
|
<td>Returns the current geographical position of the marker.</td>
|
|
</tr>
|
|
<tr id="#marker-bindpopup">
|
|
<td><code>bindPopup( <String> <i>htmlContent</i>, <<a href="#popup-options">Popup options</a>> <i>options?</i> )</code></td>
|
|
<td><code>this</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-openpopup">
|
|
<td><code>openPopup()</code></td>
|
|
<td><code>this</code></td>
|
|
<td>Opens the popup previously bound by the <a href="#marker-bindpopup">bindPopup</a> method.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<h2 id="popup">L.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>
|
|
<pre><code class="javascript">var popupContent = '<p>Hello world!<br />This is a nice popup.</p>',
|
|
popup = new L.Popup(latlng, popupContent);
|
|
map.openPopup(popup);</code></pre>
|
|
<p>If you want to bind a popup to marker click and then open it, it's even easier:</p>
|
|
<pre><code class="javascript">marker.bindPopup(popupContent).openPopup();</code></pre>
|
|
|
|
<h3>Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Popup( <<a href="#latlng">LatLng</a>> <i>latlng</i>, <String> <i>htmlContent</i>, <<a href="#popup-options">Popup options</a>> <i>options?</i> )</code></td>
|
|
<td>Instantiates a Popup object given the geographical point where it will open, the HTML content it will have and optionally an options object.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3 id="popup-options">Options</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Option</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>maxWidth</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>300</code></td>
|
|
<td>Max width of the popup.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>autoPan</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Set it to false if you don't want the map to do panning animation to fit the opened popup.'</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>closeButton</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Controls the presense of a close button in the popup.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>closeMapOnClick</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Set it to false if you don't want the popup to close when user clicks the map.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>offset</code></td>
|
|
<td><code><a href="#point">Point</a></code></td>
|
|
<td><code>Point(0, 0)</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>
|
|
</table>
|
|
|
|
|
|
|
|
<h2 id="tilelayer">L.TileLayer</h2>
|
|
|
|
<p>Used to load and display tile layers on the map, implements <a href="#ilayer">ILayer</a> interface.</p>
|
|
|
|
<h3>Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.TileLayer( <String> <i><a href="url-template">urlTemplate</a></i>, <<a href="#tilelayer-options">TileLayer options</a>> <i>options?</i> )</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 randomly chosen subdomains (their range is 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>
|
|
|
|
<h3 id="tilelayer-options">Options</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Option</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>minZoom</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>0</code></td>
|
|
<td>Minimum zoom number.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>maxZoom</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>18</code></td>
|
|
<td>Maximum zoom number.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tileSize</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>256</code></td>
|
|
<td>Tile size (width and height in pixels, assuming tiles are square).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>subdomains</code></td>
|
|
<td><code>String</code> or <code>String[]</code></td>
|
|
<td><code>'abc'</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>errorTileUrl</code></td>
|
|
<td><code>String</code></td>
|
|
<td><code>''</code></td>
|
|
<td>URL to the tile image to show in place of the tile that failed to load.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>attribution</code></td>
|
|
<td><code>String</code></td>
|
|
<td><code>''</code></td>
|
|
<td>e.g. "© CloudMade" — the string used by the attribution control, describes the layer data.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>unloadInvisibleTiles</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td>depends</td>
|
|
<td>If <code>true</code>, all the tiles that are not visible after panning are removed (for better performance). <code>true</code> by default on mobile WebKit, otherwise <code>false</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>updateWhenIdle</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td>depends</td>
|
|
<td>If <code>false</code>, new tiles are loaded during panning, otherwise only after it (for better performance). <code>true</code> by default on mobile WebKit, otherwise <code>false</code>.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
<h2 id="path">L.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>
|
|
<tr>
|
|
<th>Option</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>stroke</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>true</code></td>
|
|
<td>Whether to draw stroke along the path. Set it to <code>false</code> to disable borders on polygons or circles.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>color</code></td>
|
|
<td><code>String</code></td>
|
|
<td><code>'#03f'</code></td>
|
|
<td>Stroke color.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>weight</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>5</code></td>
|
|
<td>Stroke width in pixels.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>opacity</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>0.5</code></td>
|
|
<td>Stroke opacity.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fill</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td>depends</td>
|
|
<td>Whether to fill the path with color. Set it to <code>false</code> to disable filling on polygons or circles.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fillColor</code></td>
|
|
<td><code>String</code></td>
|
|
<td>same as color</td>
|
|
<td>Fill color.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>fillOpacity</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>0.2</td>
|
|
<td>Fill opacity.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Constants</h3>
|
|
<table>
|
|
<tr>
|
|
<th>Constant</th>
|
|
<th>Type</th>
|
|
<th>Value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Path.SVG</code></th>
|
|
<td><code>Boolean</code></th>
|
|
<td>depends</th>
|
|
<td>True if SVG is used for vector rendering (true for most modern browsers).</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Path.VML</code></th>
|
|
<td><code>Boolean</code></th>
|
|
<td>depends</th>
|
|
<td>True if VML is used for vector rendering (IE 6-8).</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Path.CLIP_PADDING</code></th>
|
|
<td><code>Number</code></th>
|
|
<td>0.5 for SVG<br />0.02 for VML</th>
|
|
<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. </th>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h2 id="polyline">L.Polyline</h2>
|
|
|
|
<p>A class for drawing polyline overlays on a map. Extends Path. 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 arrays of LatLng points
|
|
var polyline = new L.Polyline(latlngs, {color: 'red'});
|
|
|
|
// zoom the map to the polyline
|
|
map.fitBounds(new L.LatLngBounds(latlngs));
|
|
|
|
// add the polyline to the map
|
|
map.addLayer(polyline);</code></pre>
|
|
|
|
<h3>Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Polyline( <<a href="#latlng">LatLng</a>[]> <i>latlngs</i>, <<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</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>
|
|
<tr>
|
|
<th>Option</th>
|
|
<th>Type</th>
|
|
<th>Default value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>smoothFactor</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>1.0</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>noClip</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td><code>false</code></td>
|
|
<td>Disabled polyline clipping.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h2 id="polygon">L.Polygon</h2>
|
|
|
|
<p>A class for drawing polygon overlays on a map. Extends Polyline. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
|
|
|
|
<h3>Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Polygon( <<a href="#latlng">LatLng</a>[]> <i>latlngs</i>, <<a href="#polyline-options">Polyline options</a>> <i>options?</i> )</code></td>
|
|
<td>Instantiates a polygon object given an array of geographical points and optionally an options object (the same as for Polyline).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
<h2 id="circle">L.Circle</h2>
|
|
|
|
<p>A class for drawing circle overlays on a map. Extends Path. Use <a href="#map-addlayer">Map#addLayer</a> to add it to the map.</p>
|
|
|
|
<h3>Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Circle( <<a href="#latlng">LatLng</a>> <i>latlng</i>, <Number> <i>radius</i>, <<a href="#path-options">Path options</a>> <i>options?</i> )</code></td>
|
|
<td>Instantiates a polygon object given an geographical point, a radius in pixels and optionally an options object.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<h2 id="latlng">L.LatLng</h2>
|
|
|
|
<p>Represents a geographical point with a certain latitude and longitude.</p>
|
|
<pre><code class="javascript">var latlng = new L.LatLng(50.5, 30.5);</code></pre>
|
|
|
|
<h3>Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.LatLng( <Number> <i>latitude</i>, <Number> <i>longitude</i>, <Boolean> <i>noWrap?</i> )</code></td>
|
|
<td>Creates a LatLng object with the given latitude and longitude. Wraps longitude to lie between -180 and 180 and clamps longitude between -90 and 90 by default — you can disable this with the noWrap argument.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Properties</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Property</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>lat</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>Latitude in degrees.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>lng</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>Longitude in degrees.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Methods</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Method</th>
|
|
<th>Returns</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>equals( <<a href="#latlng">LatLng</a>> <i>otherLatlng</i> )</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td>Returns true if the given LatLng point is at the same position (within a small margin of error).</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>toString()</code></td>
|
|
<td><code>String</code></td>
|
|
<td>Returns a string representation of the point (for debugging purposes).</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Constants</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constant</th>
|
|
<th>Type</th>
|
|
<th>Value</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>DEG_TO_RAD</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>Math.PI / 180</code></td>
|
|
<td>A multiplier for converting degrees into radians.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>RAD_TO_DEG</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>180 / Math.PI</code></td>
|
|
<td>A multiplier for converting radians into degrees.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>MAX_MARGIN</code></td>
|
|
<td><code>Number</code></td>
|
|
<td><code>1.0E-9</code></td>
|
|
<td>Max margin of error for the equality check.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<h2 id="point">L.Point</h2>
|
|
|
|
<p>Represents a point with x and y coordinates in pixels.
|
|
|
|
<h3>Constructor</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Constructor</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>L.Point( <Number> <i>x</i>, <Number> <i>y</i> )</code></td>
|
|
<td>Creates a Point object with the given x and y coordinates.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Properties</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Property</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>x</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>The x coordinate.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>y</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>The y coordinate.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Methods</h3>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Method</th>
|
|
<th>Returns</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>add( <<a href="#point">Point</a>> <i>otherPoint</i> )</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>subtract( <<a href="#point">Point</a>> <i>otherPoint</i> )</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>multiplyBy( <Number> <i>number</i> )</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>divideBy( <Number> <i>number</i> )</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.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>distanceTo( <<a href="#point">Point</a>> <i>otherPoint</i> )</code></td>
|
|
<td><code>Number</code></td>
|
|
<td>Returns the distance between the current and the given points.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>clone()</code></td>
|
|
<td><code><a href="#point">Point</a></code></td>
|
|
<td>Returns a copy of the current point.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>round()</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>toString()</code></td>
|
|
<td><code>String</code></td>
|
|
<td>Returns a string representation of the point for debugging purposes.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<h2 id="ihandler">IHandler</h2>
|
|
<p>An interface implemented by <a href="#map-interaction-handlers">interaction handlers</a>.</p>
|
|
|
|
<table>
|
|
<tr>
|
|
<th>Method</th>
|
|
<th>Returns</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code>enable()</code></td>
|
|
<td>-</td>
|
|
<td>Enables the handler.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>disable()</code></td>
|
|
<td>-</td>
|
|
<td>Disables the handler.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>enabled()</code></td>
|
|
<td><code>Boolean</code></td>
|
|
<td>Returns true if the handler is enabled.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
|
|
<hr />
|
|
|
|
<p class="quiet">© 2011 <a href="http://cloudmade.com">CloudMade</a>. Map data © 2011 <a href="http://openstreetmap.org">OpenStreetMap</a> contributors, <a href="http://creativecommons.org/licenses/by-sa/2.0/">CC-BY-SA</a>.</p>
|
|
</div>
|
|
|
|
<a href="http://github.com/CloudMade/Leaflet"><img id="forkme" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
|
|
|
|
<script>
|
|
hljs.tabReplace = ' ';
|
|
hljs.initHighlightingOnLoad();
|
|
</script>
|
|
</body>
|
|
</html> |