UNPKG

leafdoc

Version:

A lightweight NaturalDocs-like LeafletJS-style documentation generator

981 lines (860 loc) 21.1 kB
<!DOCTYPE html> <html> <head> <title></title> <meta charset="utf-8"> <style> table { border-collapse: collapse; } table td, table th { border: 1px solid #888; } pre code { display: inline-block; background: #eee; } td:last-child code { background: #eee; } body { font-family: Sans; max-width: 50em; margin: auto; } </style> </head> <body> <h2>Leafdoc generated API reference</h2> <h2 id='map'>Map</h2> <h3 id='map-method'>Methods</h3> <section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='map-panto'> <td><code><b>panTo</b>(<nobr>&lt;LatLng&gt; <i>latlng</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='map-getcenter'> <td><code><b>getCenter</b>()</nobr></code></td> <td><code>LatLng</code></td> <td></td> </tr> <tr id='map-setzoom'> <td><code><b>setZoom</b>(<nobr>&lt;Number&gt; <i>zoom</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='map-getzoom'> <td><code><b>getZoom</b>()</nobr></code></td> <td><code>Number</code></td> <td></td> </tr> </tbody></table> </section> <details> <summary>Methods inherited from <a href='#evented'>Evented</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='map-on'> <td><code><b>on</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='map-off'> <td><code><b>off</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='map-extend'> <td><code><b>extend</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='map-include'> <td><code><b>include</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='map-initialize'> <td><code><b>initialize</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h3 id=''>Properties</h3> <details> <summary>Properties inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr id='map-options'> <td><code><b>options</b> <td><code>Object</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h2 id='evented'>Evented</h2> <h3 id='evented-method'>Methods</h3> <section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='evented-on'> <td><code><b>on</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='evented-off'> <td><code><b>off</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> </tbody></table> </section> <details> <summary>Methods inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='evented-extend'> <td><code><b>extend</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='evented-include'> <td><code><b>include</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='evented-initialize'> <td><code><b>initialize</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h3 id=''>Properties</h3> <details> <summary>Properties inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr id='evented-options'> <td><code><b>options</b> <td><code>Object</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h2 id='class'>Class</h2> <h3 id='class-method'>Methods</h3> <section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='class-extend'> <td><code><b>extend</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='class-include'> <td><code><b>include</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='class-initialize'> <td><code><b>initialize</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> </tbody></table> </section> <h3 id='class-property'>Properties</h3> <section> <table><thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr id='class-options'> <td><code><b>options</b> <td><code>Object</code></td> <td></td> </tr> </tbody></table> </section> <h2 id='layer'>Layer</h2> <h3 id='layer-method'>Methods</h3> <section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='layer-addto'> <td><code><b>addTo</b>(<nobr>&lt;<a href='#map'>Map</a>&gt; <i>map</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='layer-remove'> <td><code><b>remove</b>(<nobr>&lt;<a href='#map'>Map</a>&gt; <i>map?</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='layer-onadd'> <td><code><b>onAdd</b>()</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='layer-onremove'> <td><code><b>onRemove</b>()</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='layer-getattribution'> <td><code><b>getAttribution</b>()</nobr></code></td> <td><code>String</code></td> <td></td> </tr> </tbody></table> </section> <details> <summary>Methods inherited from <a href='#evented'>Evented</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='layer-on'> <td><code><b>on</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='layer-off'> <td><code><b>off</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='layer-extend'> <td><code><b>extend</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='layer-include'> <td><code><b>include</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='layer-initialize'> <td><code><b>initialize</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h3 id=''>Properties</h3> <details> <summary>Properties inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr id='layer-options'> <td><code><b>options</b> <td><code>Object</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h2 id='marker'>Marker</h2> <h3 id=''>Methods</h3> <details> <summary>Methods inherited from <a href='#layer'>Layer</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='marker-addto'> <td><code><b>addTo</b>(<nobr>&lt;<a href='#map'>Map</a>&gt; <i>map</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='marker-remove'> <td><code><b>remove</b>(<nobr>&lt;<a href='#map'>Map</a>&gt; <i>map?</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='marker-onadd'> <td><code><b>onAdd</b>()</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='marker-onremove'> <td><code><b>onRemove</b>()</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='marker-getattribution'> <td><code><b>getAttribution</b>()</nobr></code></td> <td><code>String</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#evented'>Evented</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='marker-on'> <td><code><b>on</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='marker-off'> <td><code><b>off</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='marker-extend'> <td><code><b>extend</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='marker-include'> <td><code><b>include</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='marker-initialize'> <td><code><b>initialize</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h3 id=''>Properties</h3> <details> <summary>Properties inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr id='marker-options'> <td><code><b>options</b> <td><code>Object</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h2 id='tilelayer'>TileLayer</h2> <h3 id='tilelayer-option'>Options</h3> <section> <table><thead> <tr> <th>Option</th> <th>Type</th> <th>Default</th> <th>Description</th> </tr> </thead><tbody> <tr id='tilelayer-minzoom'> <td><code><b>minZoom</b></code></td> <td><code>Number</code> <td><code>0</code></td> <td></td> </tr> <tr id='tilelayer-maxzoom'> <td><code><b>maxZoom</b></code></td> <td><code>Number</code> <td><code>18</code></td> <td></td> </tr> <tr id='tilelayer-zoomoffset'> <td><code><b>zoomOffset</b></code></td> <td><code>Number</code> <td><code>0</code></td> <td></td> </tr> <tr id='tilelayer-zoomreverse'> <td><code><b>zoomReverse</b></code></td> <td><code>Boolean</code> <td><code>false</code></td> <td></td> </tr> </tbody></table> </section> <details> <summary>Options inherited from <a href='#gridlayer'>GridLayer</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Option</th> <th>Type</th> <th>Default</th> <th>Description</th> </tr> </thead><tbody> <tr id='tilelayer-tilesize'> <td><code><b>tileSize</b></code></td> <td><code>Number|Point</code> <td><code>256</code></td> <td></td> </tr> <tr id='tilelayer-opacity'> <td><code><b>opacity</b></code></td> <td><code>Number</code> <td><code>1.0</code></td> <td></td> </tr> <tr id='tilelayer-nowrap'> <td><code><b>noWrap</b></code></td> <td><code>Boolean</code> <td><code>false</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h3 id='tilelayer-method'>Methods</h3> <section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='tilelayer-gettileurl'> <td><code><b>getTileUrl</b>(<nobr>&lt;Object&gt; <i>coords</i></nobr>)</nobr></code></td> <td><code></code></td> <td></td> </tr> </tbody></table> </section> <details> <summary>Methods inherited from <a href='#gridlayer'>GridLayer</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='tilelayer-createtile'> <td><code><b>createTile</b>(<nobr>&lt;Object&gt; <i>coords</i></nobr>)</nobr></code></td> <td><code></code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#layer'>Layer</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='tilelayer-addto'> <td><code><b>addTo</b>(<nobr>&lt;<a href='#map'>Map</a>&gt; <i>map</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='tilelayer-remove'> <td><code><b>remove</b>(<nobr>&lt;<a href='#map'>Map</a>&gt; <i>map?</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='tilelayer-onadd'> <td><code><b>onAdd</b>()</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='tilelayer-onremove'> <td><code><b>onRemove</b>()</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='tilelayer-getattribution'> <td><code><b>getAttribution</b>()</nobr></code></td> <td><code>String</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#evented'>Evented</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='tilelayer-on'> <td><code><b>on</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='tilelayer-off'> <td><code><b>off</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='tilelayer-extend'> <td><code><b>extend</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='tilelayer-include'> <td><code><b>include</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='tilelayer-initialize'> <td><code><b>initialize</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h3 id=''>Properties</h3> <details> <summary>Properties inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr id='tilelayer-options'> <td><code><b>options</b> <td><code>Object</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h2 id='gridlayer'>GridLayer</h2> <h3 id='gridlayer-option'>Options</h3> <section> <table><thead> <tr> <th>Option</th> <th>Type</th> <th>Default</th> <th>Description</th> </tr> </thead><tbody> <tr id='gridlayer-tilesize'> <td><code><b>tileSize</b></code></td> <td><code>Number|Point</code> <td><code>256</code></td> <td></td> </tr> <tr id='gridlayer-opacity'> <td><code><b>opacity</b></code></td> <td><code>Number</code> <td><code>1.0</code></td> <td></td> </tr> <tr id='gridlayer-minzoom'> <td><code><b>minZoom</b></code></td> <td><code>Number</code> <td><code>0</code></td> <td></td> </tr> <tr id='gridlayer-maxzoom'> <td><code><b>maxZoom</b></code></td> <td><code>Number</code> <td><code>undefined</code></td> <td></td> </tr> <tr id='gridlayer-nowrap'> <td><code><b>noWrap</b></code></td> <td><code>Boolean</code> <td><code>false</code></td> <td></td> </tr> </tbody></table> </section> <h3 id='gridlayer-method'>Methods</h3> <section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='gridlayer-createtile'> <td><code><b>createTile</b>(<nobr>&lt;Object&gt; <i>coords</i></nobr>)</nobr></code></td> <td><code></code></td> <td></td> </tr> </tbody></table> </section> <details> <summary>Methods inherited from <a href='#layer'>Layer</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='gridlayer-addto'> <td><code><b>addTo</b>(<nobr>&lt;<a href='#map'>Map</a>&gt; <i>map</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='gridlayer-remove'> <td><code><b>remove</b>(<nobr>&lt;<a href='#map'>Map</a>&gt; <i>map?</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='gridlayer-onadd'> <td><code><b>onAdd</b>()</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='gridlayer-onremove'> <td><code><b>onRemove</b>()</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='gridlayer-getattribution'> <td><code><b>getAttribution</b>()</nobr></code></td> <td><code>String</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#evented'>Evented</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='gridlayer-on'> <td><code><b>on</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> <tr id='gridlayer-off'> <td><code><b>off</b>(<nobr>&lt;String&gt; <i>evtype</i></nobr>, <nobr>&lt;Function&gt; <i>handler</i></nobr>)</nobr></code></td> <td><code>this</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <details> <summary>Methods inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Method</th> <th>Returns</th> <th>Description</th> </tr> </thead><tbody> <tr id='gridlayer-extend'> <td><code><b>extend</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='gridlayer-include'> <td><code><b>include</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> <tr id='gridlayer-initialize'> <td><code><b>initialize</b>(<nobr><i>Object</i></nobr>)</nobr></code></td> <td><code><a href='#class'>Class</a></code></td> <td></td> </tr> </tbody></table> </section> </div> </details> <h3 id=''>Properties</h3> <details> <summary>Properties inherited from <a href='#class'>Class</a></summary> <div class='accordion-content'><section> <table><thead> <tr> <th>Property</th> <th>Type</th> <th>Description</th> </tr> </thead><tbody> <tr id='gridlayer-options'> <td><code><b>options</b> <td><code>Object</code></td> <td></td> </tr> </tbody></table> </section> </div> </details> </body></html>