Log in
Restaurant Bootstrap Template Bootstrap Temple Menu Home Services Dishes Menu Gallery Reservation Contact reservation reservation Book table Email Number People Date Time Special request Book restaurant Bootstrap Template elegant Bootstrap template bring Bootstrap Temple amit visit restaurant amit follow Home Delivery check client rating review Restaurant Check story Sed unde natus error quae quasi sit eos qui provide follow speciality Clean Environment Lovely expert chef Fresh tasty food app available Download Play App Store Download template signature Dishes Fresh healthy food available Fried Shrimp Fried Shrimp Fried Shrimp Fried Shrimp Fried Shrimp Fried Shrimp Special Offers miss offer Dish Dish Dish food menu popular menu breakfast lunch party drink Wild Mushroom Kale Mushroom White Sources Recommended Lemon Garlic Green Beans Lemon Garlic Beans Recommended Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Lemon Garlic Green Beans Lemon Garlic Beans Recommended Wild Mushroom Kale Mushroom White Sources Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Lemon Garlic Green Beans Lemon Garlic Beans Recommended Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Wild Mushroom Kale Mushroom White Sources Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Lemon Garlic Green Beans Lemon Garlic Beans Recommended Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Lemon Garlic Green Beans Lemon Garlic Beans Recommended Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Lemon Garlic Green Beans Lemon Garlic Beans Recommended Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources Skewers Lamb Wine Butter Black Pepper Honey Pepper Chicken Honey Imported Oysters Grill piece Oysters Ginger Wild Mushroom Kale Mushroom White Sources upcoming event miss awesome event December italian Master Class December exercitation read Gallery Discover photo gallery order table enjoy meal restaurant reservation Book table Email Number People Date Time Special request Book contact feel free contact Email message send Sed unde natus error quae quasi Contact July Egypt Newsletter Subscribe Policy Privacy term Use Contact Restaurant build Leaflet reference Map Usage example Creation Options Events Map Methods Modifying map state get map state Layers control Conversion method method Map Misc Properties Panes Layers Marker Raster Layers Vector Layers Path Polygon Rectangle Circle Canvas Layers Basic Types point bound Icon Controls Zoom Attribution Layers Scale Utility Browser Util Transformation dom Utility Base Classes Class Layer Interactive layer Control Handler Projection CRS Renderer Misc Event object global switch version Map central class create map page manipulate usage example initialize map map div give center zoom var map center zoom Creation Factory Description option instantiate map object give DOM element optionally object literal Map option option instantiate map object give instance element optionally object literal Map option option Option Type Default Description boolean false Path render Canvas renderer default Path render renderer control option Option Type Default Description boolean true attribution control add map default boolean true zoom control add map default Interaction Options Option Type Default Description Boolean true set false want close user click map number force map zoom level multiple particularly right pinch zoom default zoom level snap near integer low value allow great granularity value mean zoom level snap pinch zoom number control map zoom level change press keyboard zoom control value small allow great granularity boolean true map automatically handle browser window resize update Boolean true map zoom rectangular area specify drag mouse press shift key true map zoom double clicking zoom double clicking hold shift pass center double click zoom zoom center view regardless mouse drag Boolean true map mouse touch Map State Options Option Type Default Description CRS Coordinate Reference System use change sure mean center undefine initial geographic center map zoom Number undefine initial map zoom level number minimum zoom level map specify map low option instead number maximum zoom level map specify map high option instead layer Layer array layer add map initially null option set map restrict view give geographical bound bounce user user try pan outside view set restriction dynamically use method renderer Renderer default method draw vector layer map default depend browser support Animation Options Option Type Default Description boolean true map zoom animation enable default enable browser support Transitions Android Number will animate zoom zoom difference exceed value boolean true tile fade animation enable default enable browser support Transitions Android boolean true marker animate zoom zoom animation disabled disappear length animation default enable browser support Transitions Android number define maximum size translation transform default value change web browser position layer wrong place large pan Inertia Options Option Type Default Description inertia Boolean enable pan map inertia effect map build momentum drag continue move direction time feel especially nice touch device enable default run old Android device number rate inertial movement slow pixels Number Infinity Max speed inertial movement pixels second Number boolean false option enable map track pan copy world seamlessly jump original overlay like marker vector layer visible number set option control solid bound drag map default value allow user drag outside bound normal speed high value slow map drag outside bound make bound fully solid prevent user drag outside bound Keyboard Navigation Options Option Type Default Description keyboard Boolean true make map focusable allow user navigate map keyboard arrow key Number pixel pan press arrow key mouse wheel option Option Type Default Description true map zoom mouse wheel pass center zoom center view regardless mouse number limit rate wheel fire millisecond default user zoom wheel number scroll pixel report mean change zoom level small value wheel zooming fast vice versa touch interaction option Option Type Default Description tap boolean true Enables mobile hack support instant tap fix click delay iOS Android touch hold fire event number max number pixel user shift finger touch consider valid tap map zoom touch dragging finger pass center zoom center view regardless touch event finger enable touch capable web browser old Androids boolean true set false want map zoom min max zoom bounce pinch zooming event Layer event Event Data Description fire base layer change layer control fire overlay select layer control fire overlay layer control fire new layer add map fire layer remove map Map state change event Event Data Description Event fire number map change add remove layer resize fire map resize unload Event fire map destroy remove method Event fire map need redraw content usually happen map zoom load useful create custom overlay load Event fire map initialize center zoom set time Event fire map zoom change zoom animation Event fire view map start change user start drag map zoom Event fire repeatedly change zoom level include zoom fly animation Event fire repeatedly movement map include pan fly animation Event fire map change animation Event fire center map stop change user stop drag map event Event Data Description Fired open map Fired map closed Event fire map start open event Event Data Description Fired open map Fired map closed location event Event Data Description Fired locate method fail fire locate method successfully interaction event Event Data Description click Fired user click tap map Fired user double click double tap map fire user push mouse button map fire user release mouse button map Fired mouse enter map Fired mouse leave map Fired mouse move map Fired user push right mouse button map prevent default browser context menu show listener event fire mobile user hold single touch second call long press keypress fire user press key keyboard produce character value map focus fire user press key keyboard map focus unlike keypress event event fire key produce character value key produce character value fire user release key keyboard map focus Fired mouse click map useful want happen click exist click handler start run event Event Data Description fire zoom animation continuous zoom like pinch zooming fire frame zoom method Method return Description Path layer Renderer return instance Renderer render give Path ensure renderer option map path respect renderer exist map method Layers Controls Method return Description Control control add give control map Control control remove give control map Layer layer add give layer map Layer layer remove give layer map Layer layer boolean return true give layer currently add map context iterate layer map optionally specify context iterator function open specified close previously open sure open time usability content option option create specify content option open give point map close previously open give open specify content option option create specify content option open close give parameter method modify map state Method Returns Description center zoom Zoom pan option option set view map geographical center zoom give animation option zoom Zoom pan option option set zoom map delta Zoom option option increase zoom map delta default delta Zoom option option decrease zoom map delta default zoom Zoom option option zoom map keep specify geographical point map stationary internally scroll zoom double click zoom point offset zoom Zoom option option zoom map keep specify pixel map relative leave corner stationary bound option option set map view contain give geographical bound maximum zoom level possible option option set map view contain world maximum zoom level possible panto Pan option option pan map give center point offset Pan option option pan map give number pixel animate zoom Zoom pan option option set view map geographical center zoom perform smooth pan zoom animation bound option option set view map smooth animation like take bound parameter like bound restrict map view give bound option zoom set low limit available zoom level option zoom set upper limit available zoom level option bound Pan option option pan map close view lie inside give bound control animation option specific option pan map minimum visible Use padding option fit display restricted bound like optionally padded display bound map pan Zoom pan option option check map container size change update map change map size dynamically animate pan default false pan occur true delay event happen method call time row animate check map container size change update map change map size dynamically animate pan default stop stop currently run panto animation method Method Returns Description locate locate option option try locate user fire event location datum success event failure optionally set map view user location respect detection accuracy world view fail note page use method fail modern browser Chrome new locate option detail stop watch location previously initiate true abort reset map view call true Methods Method return Description add new handler map give constructor function remove destroy map clear related event listener container create new map pane give exist return pane create child container child main map pane set pane return map pane give element identity Object return plain object contain name pane key pane value return element contain map context run give function map get initialize view center zoom layer immediately initialize optionally pass function context method get Map State Method return Description return geographical center map view Number return current zoom level map view return geographical bound visible current map view Number return minimum zoom level map set option map layer default Number return maximum zoom level map set option map layer bound inside point padding number return maximum zoom level give bound fit map view entirety inside optional set true method instead return minimum zoom level map view fit give bound entirety Point return current size map container pixel bound return bound current map view project pixel coordinates useful layer overlay implementation Point return project pixel coordinate left point map layer useful custom layer overlay implementation zoom bound return world bound pixel coordinate zoom level zoom zoom omit map current zoom level Conversion Methods Method Returns Description Number return scale factor apply map transition zoom level internally help zoom animation scale Number return zoom level map end level scale factor scale inverse project zoom Point Projects geographical coordinate accord projection map CRS scale accord zoom CRS Transformation result pixel coordinate relative CRS origin Point point zoom Inverse project Point point give pixel coordinate relative origin pixel return correspond geographical coordinate current zoom level point give geographical coordinate return correspond pixel coordinate relative origin pixel return lat wrap accord map CRS property outside CRS bound default mean longitude wrap dateline value degree bound return size give ensure center CRS bound default mean center longitude wrap dateline value degree majority bound overlap CRS bound distance number return distance geographical coordinate accord map CRS default measure distance meter Point point point give pixel coordinate relative map container return correspond pixel coordinate relative origin pixel Point point point give pixel coordinate relative origin pixel return correspond pixel coordinate relative map container Point point give pixel coordinate relative map container return correspond geographical coordinate current zoom level point give geographical coordinate return correspond pixel coordinate relative map container point give object return pixel coordinate relative map container event take place point give object return pixel coordinate relative origin pixel event take place give object return geographical coordinate event take place method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Properties Controls Property Type Description Control zoom default zoom control available option true create map Handlers Property Type Description Handler Box shift drag mouse zoom handler Handler Double click zoom handler drag Handler Map drag handler mouse touch keyboard Handler Keyboard navigation handler Handler Scroll wheel zoom handler tap Handler Mobile touch hack quick tap touch hold handler Handler Touch zoom handler Map pane Panes DOM element control ordering layer map access pane method new pane create method map follow default pane differ Pane Type index Description auto pane contain map pane Pane Pane overlay shadow Marker shadow Pane vector Path like Polygon Pane Icon Marker Pane Pane Locate option method Map option parameter plain object follow optional component option Type Default Description watch boolean false true start continuous watching location change instead detect method later stop watch method boolean false true automatically set map view user location respect detection accuracy world view fail Number Infinity maximum zoom automatic view set option timeout Number number millisecond wait response fire event number maximum age detect location millisecond pass response locate return cache location boolean false enable high accuracy description spec zoom option Map method modify zoom level option parameter plain object follow optional component option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation pan option Map method modify center map option parameter plain object follow optional component option Type Default Description animate Boolean true pan animate possible false animate pan reset map view pan screen away set new offset map pane duration Number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia Zoom pan option option inherit Zoom option Option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation option inherit Pan option Option Type Default Description duration number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia option option Type Default Description Point set padding left corner map container account set view fit bound useful control overlay map like sidebar want obscure object zoom Point right corner map padding Point equivalent set left right padding value number null maximum possible zoom use option inherit Zoom option Option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation option inherit Pan option Option Type Default Description duration number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia Marker display icon map Extends Layer usage example Creation Factory Description Marker option option instantiate Marker object give geographical point optionally option object option Option Type Default Description icon Icon Icon instance use render marker Icon documentation detail customize marker icon specify common instance Default keyboard Boolean true marker tab keyboard click press enter title String text browser appear marker hover default alt String text alt attribute icon image useful accessibility number default marker image set automatically base latitude use option want marker specify high value like high negative value respectively opacity number opacity marker boolean false true marker hover mouse number index offset feature pane String Map pane marker icon add String Map pane marker shadow add boolean false true mouse event marker trigger event map marker option Option Type Default Description boolean false marker mouse touch boolean false pan map drag marker near edge Point distance pixel left right map edge start pan map Number number pixel map pan option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description Event fire marker move drag old new coordinate include event argument drag event Event Data Description event fire user start drag marker Event fire marker start move dragging drag Event fire repeatedly user drag marker fire user stop drag marker Event fire marker stop move dragging mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer closed method addition share layer method like remove method like use follow method Method return Description return current geographical position marker change marker position give point offset change offset marker Icon return current icon marker Icon icon change marker icon opacity change opacity marker method Method Returns Description precision object precision number decimal place coordinate default value place return representation marker Point Feature method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Properties Interaction handler Interaction handler property marker instance allow control interaction behavior runtime enable disable certain feature drag Handler method example Property Type Description drag Handler Marker drag handler mouse touch valid marker map set open certain place map use open make sure open time recommend usability use open want usage example want bind marker click open easy path overlay like method complicated way open map var hello world nice Creation Factory Description option option Layer source instantiate object give optional option object describe appearance location optional source object tag reference Layer refer option Option Type Default Description Number Max width pixel number Min width pixel number null set create container give height inside content exceed boolean true set false want map pan animation fit opened Point null margin left corner map view perform Point null margin right corner map view perform Point equivalent set left right padding value Boolean false set true want prevent user pan screen open boolean true control presence close button boolean true set false want override default behavior closing open boolean true set false want override default behavior ESC key closing Boolean set want override default behavior closing user click map default map option String custom class assign option inherit Option Type Default Description offset Point offset position useful control anchor open overlay pane String Map pane add option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return geographical point set geographical point open return content set content function pass source layer pass function function return string return container update null Updates content layout position useful update inside change image load boolean return true visible map bring map pane bring map pane Map map add map close previous method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen display small text map layer usage example note offset Leaflet take option consideration compute offset offset option default specific add positive offset right positive offset negative left Icon option consider Marker adapt value use custom icon creation Factory Description option option Layer source instantiate object give optional option object describe appearance location optional source object tag reference Layer refer option Option Type Default Description pane string Map pane add offset Point optional offset position direction String auto direction open possible value right left center auto auto dynamically switch right leave accord position map permanent boolean false open permanently sticky boolean false true follow mouse instead fix feature center interactive boolean false true listen feature event opacity Number container opacity option inherit Option Type Default Description String custom class assign option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display tile layer map note tile server require attribution set Layer Extends usage example foo bar attribution Map datum copy contributor template string following form mean available sequentially help browser parallel request domain limitation value specify option default omit zoom level tile coordinate add load retina tile use custom key template evaluate option like foo bar Creation Extension method Factory Description option option instantiate tile layer object give template optionally option object option Option Type Default Description number minimum zoom level layer display inclusive number maximum zoom level layer display inclusive abc Subdomains tile service pass form string letter array string String tile image place tile fail load number zoom number tile offset value Boolean false true inverse axis numbering tile turn service boolean false set true zoom number tile reverse zoom instead zoom boolean false true user retina display request tile half specify size big zoom level place utilize high resolution false attribute add tile string provide tile attribute set string provide need want access tile pixel data refer Settings valid string value option inherit Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set Number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description update layer template redraw set true change layer redrawn parameter set false call internally override return element appropriate image give callback call tile load extension method layer extend reimplement following method Method Returns Description String call internally return tile give coordinate class extend override function provide custom tile naming scheme method inherit Method Returns Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen display service tile layer map extend usage example var bin layer format image transparent true attribution weather datum Creation Factory Description option option instantiate tile layer object give base service parameter option object option custom option document send server extra parameter request useful non standard vendor parameter option Type Default Description layer string require Comma separate list layer style String Comma separate list style format String image image format use image layer transparency transparent boolean false true service return image transparency version String Version service use crs CRS null Coordinate Reference System use request default map CRS change sure mean uppercase Boolean false true request parameter key uppercase option inherit Option Type Default Description number minimum zoom level layer display inclusive number maximum zoom level layer display inclusive abc Subdomains tile service pass form string letter array string String tile image place tile fail load number zoom number tile offset value Boolean false true inverse axis numbering tile turn service boolean false set true zoom number tile reverse zoom instead zoom boolean false true user retina display request tile half specify size big zoom level place utilize high resolution false attribute add tile string provide tile attribute set string provide need want access tile pixel data refer Settings valid string value option inherit Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set Number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description param merge object new parameter request tile current screen set true method inherit Method Returns Description update layer template redraw set true change layer redrawn parameter set false call internally override return element appropriate image give callback call tile load method inherit Method Returns Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display single image specific bound map Extends Layer usage example var Creation Factory Description bound option option instantiate image overlay object give image geographical bound tie option Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description load event fire layer load image error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover return instance overlay method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display video player specific bound map extend video overlay use element usage example var Creation Factory Description video bound option option instantiate image overlay object give video array video element geographical bound tie option Option Type Default Description boolean true video start play automatically load loop Boolean true video loop beginning play boolean true video save aspect ratio projection relevant support browser Browser mute boolean false video start mute load option inherit Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description load event fire video finish load frame event inherit Event Data Description error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return instance overlay method inherit Method Returns Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display provide DOM access file specific bound map extend overlay use element usage example var var Creation Factory Description bound option instantiate image overlay object give element geographical bound tie attribute require element zoom properly option Options inherit Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description load event fire layer load image error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return instance overlay method inherit Method Returns Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Path abstract class contain option constant share vector overlay Polygon Circle use directly Extends Layer option Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen class draw overlay map extend Path usage example create red array point var var color zoom map pass multi dimensional array represent shape create red array array point var Creation Factory Description option option instantiate object give array geographical point optionally option object create object multiple separate line pass array array geographic point option Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation Feature return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Polygon class draw polygon overlay map Extends note point pass create polygon additional point equal well filter point usage example create red polygon array point var var polygon color zoom map polygon pass array array array represent outer shape array represent hole outer shape var outer ring hole additionally pass multi dimensional array represent shape var polygon outer ring hole second polygon Creation Factory Description option option option Options inherit Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation polygon Polygon Feature method inherit Method Returns Description return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen rectangle class draw rectangle overlay map extend Polygon usage example define rectangle geographical bound var bound create orange rectangle color weight zoom map rectangle bound Creation Factory Description option option option Options inherit Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return description redraw rectangle pass bound method inherit Polygon Method Returns Description precision object precision number decimal place coordinate default value place return representation polygon Polygon Feature method inherit Method Returns Description return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Circle class draw circle overlay map Extends approximation start diverge real circle close pole projection distortion usage example radius Creation Factory Description Circle option option instantiate circle object give geographical point option object contain circle radius radius Circle option option obsolete way instantiate circle compatibility code use new application option Option Type Default Description radius Number Radius circle meter option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description Event fire marker move old new coordinate include event argument mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description radius set radius circle unit meter Number return current radius circle unit meter return path method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation circle marker Point Feature set position circle marker new location return current geographical position circle marker method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen circle fix size radius specify pixel extend Path creation Factory Description option option instantiate circle marker object give geographical point optional option object option Option Type Default Description radius Number Radius circle marker pixel option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description Event fire marker move old new coordinate include event argument mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation circle marker Point Feature set position circle marker new location return current geographical position circle marker radius set radius circle marker unit pixel Number return current radius circle method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen deprecate mean functionality exist backwards compatibility old version internet Explorer allow vector layer display Inherits Renderer technical limitation available web browser notably Android available browser support deprecate technology renderer fall case usage example Use default path map var map renderer use renderer extra padding specific vector geometry var map var padding var line coordinate renderer var circle center renderer Creation Factory Description Renderer option option create renderer give option option Options inherit Renderer Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Renderer Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen function static function call instantiate Function Returns Description create Returns instance correspond class pass example line return instance ring closed string generate path string multiple ring ring turn instruction Canvas allow vector layer display Inherits Renderer technical limitation Canvas available web browser notably overlap geometry display properly edge case usage example use Canvas default path map var map renderer use Canvas renderer extra padding specific vector geometry var map var padding var line coordinate renderer var circle center renderer Creation Factory Description Renderer option option create Canvas renderer give option option Options inherit Renderer Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Renderer Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen group layer handle add map layer add remove group add remove map Extends Layer usage example Creation Factory Description layer option create layer group optionally give initial set layer option object option Options inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Extended make easy thing member layer bind layer likewise event propagate group event handler handle event layer include mouse event custom event event Usage example world function member group Creation Factory Description layer option create feature group optionally give initial set layer option object option Options inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description fire layer add fire layer remove event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description Path option style set give path option layer group method bring layer group layer bring layer group layer return Feature Group create bound coordinate child method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen represent object array object allow parse datum display map Extends usage example style function feature return color layer return Creation Factory Description option option create layer Optionally accept object format display map alternatively add later method option object option Option Type Default Description Function Function define point spawn Leaflet layer internally call datum add pass point feature default spawn default Marker return style Function Function define Path option style line polygon call internally datum add default value override default function return Function Function call create Feature create style useful attach event feature default newly create layer function feature layer filter Function Function decide include feature default include feature function return true note dynamically change filter option effect newly add datum evaluate include feature Function Function convert coordinate default static method boolean false default Markers Point type Features inherit group option option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description fire layer add fire layer remove event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description datum add object layer layer reset give vector layer style original style useful resetting style hover event layer omit style feature current layer reset style change style vector layer give style function method inherit Method Returns Description bring layer group layer bring layer group layer return Feature Group create bound coordinate child method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen function static function call instantiate Function Returns Description option option Layer create layer give feature use custom function provide option create object array number longitude latitude number longitude latitude altitude point Array create multidimensional array coordinate array specify nesting level array point array array point etc default use custom function precision Array Reverse close Array Reverse close determine point append end array close feature false default Object Normalize geometry feature feature Generic class handle tile grid element base class tile layer replace Canvas extend create tile grid element like handle create animate DOM element usage example synchronous usage create custom layer extend implement method pass Point object zoom level coordinate draw tile var create element draw var tile leaflet tile setup tile width height accord option var size canvas context draw var return tile render screen return tile asynchronous usage Tile creation asynchronous useful party drawing library tile finish draw pass callback var var error create element draw var tile leaflet tile setup tile width height accord option var size draw asynchronously pass tile callback tile return tile Creation Factory Description option option create new instance supply option option Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set number minimum zoom level layer display inclusive number undefine maximum zoom level layer display inclusive number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method extension method layer extend shall reimplement following method Method Returns Description call internally overridden class extend return correspond give callback specify call tile finish load drawing method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen represent geographical point certain latitude longitude usage example var Leaflet method accept object accept simple array form simple object form note line equivalent lat note inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description latitude longitude altitude create object represent geographical point give latitude longitude optionally altitude expect array form number number number Number Number instead expect plain object form lat Number number lat Number Number alt Number instead method Method Returns Description equal boolean return true give point position small margin error margin error overridden set small number String return string representation point debug purpose number return distance meter give calculate Spherical Law Cosines wrap return new object longitude wrap degree return new object boundary meter apart Properties Property Type Description lat Number Latitude degree Number Longitude degree alt Number altitude meter optional represent rectangular geographical area map usage example var bound Leaflet method accept object accept simple array form note bound example pass like caution area cross confused International Date Line specify corner outside degree longitude range note inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description create object define diagonally opposite corner rectangle create object define geographical point contain useful zoom map fit particular set location method Method Returns Description extend extend bound contain give point extend extend bound contain give bound pad return bound create extend retract current bound give ratio direction example ratio extend bound direction negative value retract bound return center point bound return south west point bound return north east point bound return north west point bound return south east point bound Number return west longitude bound Number return south latitude bound Number return east longitude bound Number return north latitude bound contain boolean return true rectangle contain give contain boolean return true rectangle contain give point intersect boolean return true rectangle intersect give bound bound intersect point common overlap boolean return true rectangle overlap give bound bound overlap intersection area String return string bounding box coordinate format useful send request web service return geo data equal boolean return true rectangle equivalent small margin error give bound margin error overridden set small number boolean return true bound properly initialize Point represent point coordinate pixel usage example var point Leaflet method option accept Point object accept simple array form note line equivalent note Point inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description round create point object give coordinate optional round set true round value expect array form instead expect plain object form Number Number instead method Method Returns Description clone Point return copy current point add Point Point return result addition current give point subtract Point Point return result subtraction give point current num Point return result division current point give number num Point return result multiplication current point give number point scale Point Multiply coordinate current point coordinate scale linear algebra term multiply point scaling matrix define scale point scale Point Inverse divide coordinate current point coordinate scale round Point return copy current point rounded coordinate floor Point return copy current point floor coordinate round ceil Point return copy current point ceile coordinate round Point return copy current point truncate coordinate round zero Point Number return cartesian distance current give point equal Point boolean return true give point coordinate contain point boolean return true coordinate give point correspond current point coordinate absolute value String return string representation point debug purpose Properties Property Type Description number coordinate point number coordinate point bound represent rectangular area pixel coordinate usage example var bound Leaflet method accept Bounds object accept simple array form note bound example pass like note bound inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description Point point create Bounds object corner coordinate pair point create Bounds object give array point method Method Returns Description extend Point point extend bound contain give point round Point return center point bound Point return leave point bound Point return right point bound Point return leave point bound Point return right point bound Point return size give bound contain Bounds boolean return true rectangle contain give contain Point point boolean return true rectangle contain give point intersect Bounds boolean return true rectangle intersect give bound bound intersect point common overlap bound boolean return true rectangle overlap give bound bound overlap intersection area Properties Property Type Description min point leave corner rectangle max point right corner rectangle Icon represent icon provide create marker usage example var icon Default extend blue icon Leaflet use marker default creation Factory Description Icon option option create icon instance give option option Option Type Default Description String null require icon image absolute relative script path String null retina sized version icon image absolute relative script path Retina screen device point null Size icon image pixel Point null coordinate tip icon relative left corner icon align point marker geographical location center default size specify set negative margin Point coordinate point open relative icon anchor Point coordinate point open relative icon anchor string null icon shadow image specify shadow image create String null Point null Size shadow image pixel Point null coordinate tip shadow relative left corner specify String custom class assign icon shadow image default method Method return Description call internally icon show return element style accord option shadow beneath icon default trivial subclass Icon represent icon use Marker icon specify point blue marker image distribute Leaflet release order customize default icon change property set Icon option want completely replace default icon override icon instead option Type Default Description String Icon Default try auto detect location blue icon image place image non standard way set option point right path represent lightweight icon marker use simple element instead image inherit Icon ignore shadow option usage example var div icon set div icon style icon default leaflet div icon class style little white square shadow creation Factory Description option option create instance give option option Option Type Default Description Custom code inside div element default alternatively instance Point optional relative position background pixel option inherit Icon Option Type Default Description String null require icon image absolute relative script path String null retina sized version icon image absolute relative script path Retina screen device point null Size icon image pixel Point null coordinate tip icon relative left corner icon align point marker geographical location center default size specify set negative margin Point coordinate point open relative icon anchor Point coordinate point open relative icon anchor string null icon shadow image specify shadow image create String null Point null Size shadow image pixel Point null coordinate tip shadow relative left corner specify String custom class assign icon shadow image default method method inherit Icon Method Returns Description call internally icon show return element style accord option shadow beneath control zoom basic zoom control button zoom zoom map default set option false Extends Control creation Factory Description Control zoom option option create zoom control Options Option Type Default Description String text set zoom button String Zoom title set zoom button String text set zoom button String zoom title set zoom button option inherit Control Option Type Default Description position String position control map corner possible value Methods method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control attribution attribution control allow display attribution datum small text box map map default set option false fetch attribution text layer method automatically Extends Control creation Factory Description Control attribution option option create attribution control option Option Type Default Description prefix String Leaflet text show attribution pass false disable option inherit Control Option Type Default Description position String position control map corner possible value Methods Method Returns description prefix set text attribution text add attribution text Vector datum copy text remove attribution text method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control layer layer control give user ability switch different base layer switch overlay check detailed example Extends Control usage example var var overlay Marker marker road overlay parameter object literal layer name key Layer object value layer name contain allow add additional styling item Layer Creation Factory Description overlay Control layer option option create layer control give layer base layer switch radio button overlay switch note base layer pass base layer object add map map instantiation option Option Type Default Description collapse boolean true true control collapse icon expand mouse hover touch boolean true true control assign increase order layer order preserve switch boolean false true base layer control hide boolean false sort layer false layer order add control Function compare function sort layer true function receive instance name default sort layer alphabetically option inherit Control Option Type Default Description position String position control map corner possible value Methods Method Returns Description Layer layer add base layer radio button entry give control Layer layer add overlay entry give control Layer layer remove give layer control expand expand control container collapse collapse collapse control container expand method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control scale simple scale control show scale current center screen metric imperial system Extends Control usage example Creation Factory Description Control scale option option create scale control give option option Option Type Default Description Number maximum width control pixel width set dynamically round value metric Boolean True metric scale line imperial Boolean True imperial scale line boolean false true control update date update option inherit Control Option Type Default Description position String position control map corner possible value Methods method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active Browser static property browser feature detection Leaflet internally usage example browser dude Properties Property Type Description Boolean true Internet Explorer version Edge boolean true Internet Explorer version edge Boolean true Edge web browser Boolean true base browser like Chrome Safari include mobile version android Boolean true browser run Android platform Boolean true browser run Android Android boolean true Android stock browser Chrome opera Boolean true Opera browser chrome Boolean true Chrome browser gecko Boolean true gecko base browser like safari Boolean true Safari browser Boolean true Opera browser support transform version later win Boolean true browser run Windows platform boolean true Internet Explorer version support transform boolean true base browser support transform boolean true gecko base browser support transform boolean true browser support transform mobile Boolean true browser run mobile device boolean true base browser mobile device boolean true base browser mobile device support transform boolean true browser implement touch event model notably pointer Boolean true browser support pointer event touch Boolean true browser support touch event necessarily mean browser run computer mean browser capable understand touch event Boolean true Opera browser mobile device boolean true gecko base browser run mobile device retina Boolean true browser high resolution retina screen screen browser display zoom boolean true browser support passive event canvas Boolean true browser support Boolean true browser support Boolean true browser support util utility function Leaflet internally function Function Returns Description extend object merge property object multiple object object return shortcut create proto property object Compatibility bind Function return new function bind argument pass like shortcut stamp obj Number return unique object assign throttle time context Function return function execute function give scope context keyword refer context inside code function call time give time argument receive bind function argument pass bind function follow argument pass invoke bind function shortcut num range number return number num modulo range way lie return value small set true Function return function return false num digit number return number num round digit decimal decimal default trim str String Compatibility str String trim split string whitespace return array part obj option Object Merges give property option obj object return result option class option shortcut obj uppercase string convert object parameter string foo bar translate bar set parameter append end uppercase true parameter name uppercase bar template str datum String simple facility accept template string form hello data object like foo bar return evaluate string hello foo bar specify function instead string datum value evaluate pass datum argument obj Boolean Compatibility array Number Compatibility context immediate Number Schedules execute browser repaint bind context give immediate set call immediately browser native support delay return request cancel request undefine Cancels previous Properties Property Type Description Number unique stamp String Data URI string contain encode GIF image hack free memory unused image power mobile device set image string Transformation represent affine transformation set coefficient transform point form reverse Leaflet projection code usage example var transformation Creation Factory Description instantiate Transformation object give coefficient coefficient expect coefficient array form Number Number Number number method Method Returns Description transform Point point scale Point return transform point optionally multiply give scale accept actual instance array Point point scale Point return reverse transformation give point optionally divide give scale accept actual instance array utility function point processing Leaflet internally lightning fast function Function Returns Description simplify point tolerance Point Dramatically reduce number point retain shape return new array simplified point Douglas algorithm huge performance boost processing display Leaflet zoom level reduce visual noise tolerance affect simplification less value mean high quality slow point release separate micro library point Point Point number return distance point segment point Point Point number return close point point segment Point Point bound bound round clip segment rectangular bound Cohen algorithm modify segment point directly Leaflet point screen near increase performance boolean return true flat array false nest utility function polygon geometry function Function Returns Description point bound bound round point clip polygon geometry define give point give bound algorithm Leaflet polygon point screen near increase performance note polygon point need different algorithm clip separate method utility function work DOM event Leaflet internally function Function Returns Description type context add listener function particular dom event type element optionally specify context listener object keyword point pass space separate type click context add set type listener pair click type context remove previously add listener function note pass custom context pass context order remove listener context remove set type listener pair click stop give event propagation parent element inside listener function click function add element wheel event plus browser variant add element click event plus browser variant prevent default action DOM Event happen follow link element post request page reload submit use inside listener function stop time container Point get normalize mouse position dom event relative container border exclude page specify number get normalize wheel delta wheel dom event vertical pixel scroll negative scroll event point device precise scrolling map good guess pixel Alias Alias Utility function work dom tree Leaflet internally function expect return work element difference class refer class class function Function Returns Description return element give DOM return element pass directly String return value certain style attribute element include compute value value set create container create element set class optionally append container element remove Removes parent element Removes child element make child parent render child make child parent render child boolean return true element class attribute contain add element class attribute Removes element class attribute set element class String return element class opacity set opacity element include old support opacity number prop array style name return valid style element find return false useful vendor prefix style like transform Point offset scale reset transform translate offset pixel optionally scale scale effect browser support transform Point position set position coordinate specify position translate leave positioning depend browser Leaflet internally position layer Point return coordinate element previously position prevent user generate DOM event usually generate user drag mouse page text internally Leaflet override behaviour click drag interaction map affect drag interaction document cancel effect previous dom event usually generate user drag image cancel effect previous make outline element invisible internally Leaflet prevent focusable element display outline user perform drag interaction cancel effect previous find close parent node size width height null Object compute scale currently apply element return object member horizontal vertical scale respectively result Properties Property Type Description transform String Vendor prefix transform style transition String Vendor prefix transition style String Vendor prefix event internally pan animation utilize Transitions modern browser timer fallback usage example var new Constructor Constructor Description create object event Event Data Description start Event fire animation start step Event fire continuously animation end Event fire animation end method Method Returns Description run Point duration run animation give element new position optionally set duration second default ease linearity factor argument cubic curve default stop stop animation currently run method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen class make DOM element include touch support internally map marker dragging work element position usage example var new Constructor Constructor Description option option create object move start drag element equal default option Option Type Default Description number max number pixel user shift mouse pointer click consider valid click oppose mouse drag event Event Data Description Event fire drag start Event fire drag start Event fire continuously drag correspond update element position drag Event fire continuously drag fire drag end method Method Returns Description enable enable drag ability disable disable drag ability method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Class power facility Leaflet create Leaflet class document addition implement simple classical inheritance model introduce special property convenient code organization option include static usage example var initialize function greeter greeter class constructor greet function create instance pass Hello constructor var new greet method alert Hello World Class Factories notice Leaflet object create new keyword achieve complement class lowercase factory method new factory implement easily class function option return new option inheritance use define new class use method class inherit var new property method create class inherit method property parent class proper prototype chain add override one pass extend properly react var new true true parent method include constructor corresponding child one super call language access parent class prototype apply var initialize function greet function bro var new alert bro Jason option option special property unlike object pass extend merge parent instead override completely make manage configuration object default value convenient var option foo bar var option var new bar method conveniently merge option pass constructor default define class var option foo bar initialize function option option var new foo bar note option object allow key option define class base class mean use option object store application specific information long avoid key class question include include special class property merge specify object class object call var foo function bar var include var new include runtime include method static convenience property inject specify object property static property class useful define constant var static FOO bar FOO bar Constructor hook developer need add additional initialization code exist class edit hook Leaflet come way easily method constructor additionally add event listener set custom property etc use following shortcut need additional method function Function Returns Description extend prop Function extend current class give property include return function class constructor call new include property include current class option Merges option default class add constructor hook class set method share event power class like Map Marker generally event allow execute function happen object user click map cause map fire click event usage example Leaflet deal event listener reference want add listener remove define function function Methods Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Layer set method Layer base class Leaflet layer use inherit method option event usage example var layer Options Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description add Event fire layer add map remove event fire layer remove map event Event Data Description Fired bind layer open Fired bind layer close event Event Data Description Fired bind layer open Fired bind layer close method class extend inherit follow method Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option extension method layer extend follow method Method Returns Description Map map contain code create DOM element layer add map pane belong put listener relevant map event call Map map contain clean code remove layer element dom remove listener previously add call object optional method return object like event handler object automatically add remove map layer string optional method return string contain show Attribution control layer visible Map map optional method call layer add map event initialize wait map usable state use early initialization method layer share set method convenient bind var layer automatically open layer click close layer remove map open Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method layer share set method convenient bind var layer Method return Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen interactive layer Layer interactive user interact layer mouse event like click handle use event handle method handle event option Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Mouse event Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Control base class implement map control handle positioning control extend class option Option Type Default Description position String position control map corner possible value Methods class extend inherit follow method Method return Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active extension method control extend follow method Method Returns Description Map map return container dom element control add listener relevant map event call Map map optional method contain clean code remove listener previously add call Handler abstract class map interaction handler Methods Method Returns Description enable enable handler disable disable handler enable boolean return true handler enable Extension method class inherit Handler implement follow method Method return Description call handler enable add event hook call handler disabled remove event hook add previously function static function call instantiate Function Returns Description Map map add new handler give map give Projection object method project geographical coordinate world flat surface Map projection method Method Returns Description project Point Projects geographical coordinate point accept actual instance array Point point inverse project project point geographical location accept actual instance array note projection instance inherit Leaflet Class object instantiate new class inherit method add include function Properties Property Type Description bound bound bound specify CRS unit projection valid define projection Leaflet come set define Projections box Projection Description Plate Carree projection simple projection GIS enthusiast directly map longitude latitude suitable flat world game map Simple CRS Mercator Elliptical Mercator projection complex Spherical Mercator assume Earth ellipsoid CRS Spherical Mercator projection common projection online map free commercial tile provider assume Earth sphere CRS CRS Methods Method Returns Description zoom Point Projects geographical coordinate pixel coordinate give zoom Point point zoom inverse project pixel coordinate give zoom geographical coordinate project Point Projects geographical coordinate coordinate unit accept CRS meter pass service Point point give project coordinate return correspond inverse project scale zoom Number return scale transform project coordinate pixel coordinate particular zoom example return Mercator base CRS zoom scale Number Inverse scale return zoom level correspond scale factor scale zoom bounds return projection bound scale transform provide zoom distance number return distance geographical coordinate return lat wrap accord CRS property outside CRS bound bound return size give ensure center CRS bound accept actual instance array Properties Property Type Description code String Standard code CRS pass service Number array number define longitude horizontal coordinate axis wrap give range default geographical crs undefine longitude axis wrap number like latitude vertical axis infinite Boolean true coordinate space unbounded infinite axis define crs CRS Description rarely commercial tile provider use Elliptical Mercator projection common CRS online map free commercial tile provider use Spherical Mercator projection Set default Map crs option common crs gis enthusiast use simple projection Leaflet coordinate scheme break change behaviour CRS ensure pixel tile cover earth zoom level zero tile coordinate origin option set serve base CRS global cover earth base CRS directly code projection transformation distance return meter simple crs map longitude latitude directly map flat surface game map note axis invert distance return simple euclidean distance Object define coordinate reference system project geographical point pixel screen coordinate coordinate unit service spatial reference system Leaflet define usual crs default want use CRS define default look note CRS instance inherit Leaflet Class object instantiate new class inherit method add include function Renderer Base class vector renderer implementation Canvas handle DOM container renderer bound zoom animation Renderer work implicit layer group Path renderer add remove map path use renderer implicit map decide type renderer use automatically explicit renderer option path use class directly use Canvas instead option Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen event object class inherit fire event listener function call event argument plain object contain information event example event object case information available depend event type event base event object event object contain property Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description original DOM trigger Leaflet event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description geographical point mouse event occur Point Pixel coordinate point mouse event occur relative map layer Point Pixel coordinate point mouse event occur relative map original DOM DOM trigger Leaflet event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description detect geographical location user bound geographical bound area user locate respect accuracy location accuracy Number Accuracy location meter altitude Number Height position ellipsoid meter Number Accuracy altitude meter head number direction travel degree count clockwise true North speed number current velocity meter second timestamp number time position acquire property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description message string Error message code Number Error code applicable property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description layer Layer layer add remove property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description layer Layer layer add remove String layer add remove property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description tile tile element image Point Point object tile zoom level coordinate property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description tile tile element image Point Point object tile zoom level coordinate error error pass tile callback property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description point old size resize event point new size resize event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description layer Layer layer feature add map property object property feature String geometry type feature String feature present property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description open close property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description open close property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description distance number distance pixel element move property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description center current center map zoom number current zoom level map Boolean layer update content event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Base model Inherit custom like option Option Type Default Description offset Point offset position useful control anchor open overlay String custom class assign pane String Map pane add option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Global Switches Global switch create rare case generally Leaflet detect particular browser feature need set switch global variable true include Leaflet page like switch description Forces Leaflet use touch event detect Forces Leaflet use hardware accelerate transform positioning cause glitch rare environment support method restore global variable original value Leaflet inclusion return real Leaflet like version constant represent Leaflet version use contain version currently use Leaflet reference Map Usage example Creation Options Events Map Methods Modifying map state get map state Layers control Conversion method method Map Misc Properties Panes Layers Marker Raster Layers Vector Layers Path Polygon Rectangle Circle Canvas Layers Basic Types point bound Icon Controls Zoom Attribution Layers Scale Utility Browser Util Transformation dom Utility Base Classes Class Layer Interactive layer Control Handler Projection CRS Renderer Misc Event object global switch version Map central class create map page manipulate usage example initialize map map div give center zoom var map center zoom Creation Factory Description option instantiate map object give DOM element optionally object literal Map option option instantiate map object give instance element optionally object literal Map option option Option Type Default Description boolean false Path render Canvas renderer default Path render renderer control option Option Type Default Description boolean true attribution control add map default boolean true zoom control add map default Interaction Options Option Type Default Description Boolean true set false want close user click map number force map zoom level multiple particularly right pinch zoom default zoom level snap near integer low value allow great granularity value mean zoom level snap pinch zoom number control map zoom level change press keyboard zoom control value small allow great granularity boolean true map automatically handle browser window resize update Boolean true map zoom rectangular area specify drag mouse press shift key true map zoom double clicking zoom double clicking hold shift pass center double click zoom zoom center view regardless mouse drag Boolean true map mouse touch Map State Options Option Type Default Description CRS Coordinate Reference System use change sure mean center undefine initial geographic center map zoom Number undefine initial map zoom level number minimum zoom level map specify map low option instead number maximum zoom level map specify map high option instead layer Layer array layer add map initially null option set map restrict view give geographical bound bounce user user try pan outside view set restriction dynamically use method renderer Renderer default method draw vector layer map default depend browser support Animation Options Option Type Default Description boolean true map zoom animation enable default enable browser support Transitions Android Number will animate zoom zoom difference exceed value boolean true tile fade animation enable default enable browser support Transitions Android boolean true marker animate zoom zoom animation disabled disappear length animation default enable browser support Transitions Android number define maximum size translation transform default value change web browser position layer wrong place large pan Inertia Options Option Type Default Description inertia Boolean enable pan map inertia effect map build momentum drag continue move direction time feel especially nice touch device enable default run old Android device number rate inertial movement slow pixels Number Infinity Max speed inertial movement pixels second Number boolean false option enable map track pan copy world seamlessly jump original overlay like marker vector layer visible number set option control solid bound drag map default value allow user drag outside bound normal speed high value slow map drag outside bound make bound fully solid prevent user drag outside bound Keyboard Navigation Options Option Type Default Description keyboard Boolean true make map focusable allow user navigate map keyboard arrow key Number pixel pan press arrow key mouse wheel option Option Type Default Description true map zoom mouse wheel pass center zoom center view regardless mouse number limit rate wheel fire millisecond default user zoom wheel number scroll pixel report mean change zoom level small value wheel zooming fast vice versa touch interaction option Option Type Default Description tap boolean true Enables mobile hack support instant tap fix click delay iOS Android touch hold fire event number max number pixel user shift finger touch consider valid tap map zoom touch dragging finger pass center zoom center view regardless touch event finger enable touch capable web browser old Androids boolean true set false want map zoom min max zoom bounce pinch zooming event Layer event Event Data Description fire base layer change layer control fire overlay select layer control fire overlay layer control fire new layer add map fire layer remove map Map state change event Event Data Description Event fire number map change add remove layer resize fire map resize unload Event fire map destroy remove method Event fire map need redraw content usually happen map zoom load useful create custom overlay load Event fire map initialize center zoom set time Event fire map zoom change zoom animation Event fire view map start change user start drag map zoom Event fire repeatedly change zoom level include zoom fly animation Event fire repeatedly movement map include pan fly animation Event fire map change animation Event fire center map stop change user stop drag map event Event Data Description Fired open map Fired map closed Event fire map start open event Event Data Description Fired open map Fired map closed location event Event Data Description Fired locate method fail fire locate method successfully interaction event Event Data Description click Fired user click tap map Fired user double click double tap map fire user push mouse button map fire user release mouse button map Fired mouse enter map Fired mouse leave map Fired mouse move map Fired user push right mouse button map prevent default browser context menu show listener event fire mobile user hold single touch second call long press keypress fire user press key keyboard produce character value map focus fire user press key keyboard map focus unlike keypress event event fire key produce character value key produce character value fire user release key keyboard map focus Fired mouse click map useful want happen click exist click handler start run event Event Data Description fire zoom animation continuous zoom like pinch zooming fire frame zoom method Method return Description Path layer Renderer return instance Renderer render give Path ensure renderer option map path respect renderer exist map method Layers Controls Method return Description Control control add give control map Control control remove give control map Layer layer add give layer map Layer layer remove give layer map Layer layer boolean return true give layer currently add map context iterate layer map optionally specify context iterator function open specified close previously open sure open time usability content option option create specify content option open give point map close previously open give open specify content option option create specify content option open close give parameter method modify map state Method Returns Description center zoom Zoom pan option option set view map geographical center zoom give animation option zoom Zoom pan option option set zoom map delta Zoom option option increase zoom map delta default delta Zoom option option decrease zoom map delta default zoom Zoom option option zoom map keep specify geographical point map stationary internally scroll zoom double click zoom point offset zoom Zoom option option zoom map keep specify pixel map relative leave corner stationary bound option option set map view contain give geographical bound maximum zoom level possible option option set map view contain world maximum zoom level possible panto Pan option option pan map give center point offset Pan option option pan map give number pixel animate zoom Zoom pan option option set view map geographical center zoom perform smooth pan zoom animation bound option option set view map smooth animation like take bound parameter like bound restrict map view give bound option zoom set low limit available zoom level option zoom set upper limit available zoom level option bound Pan option option pan map close view lie inside give bound control animation option specific option pan map minimum visible Use padding option fit display restricted bound like optionally padded display bound map pan Zoom pan option option check map container size change update map change map size dynamically animate pan default false pan occur true delay event happen method call time row animate check map container size change update map change map size dynamically animate pan default stop stop currently run panto animation method Method Returns Description locate locate option option try locate user fire event location datum success event failure optionally set map view user location respect detection accuracy world view fail note page use method fail modern browser Chrome new locate option detail stop watch location previously initiate true abort reset map view call true Methods Method return Description add new handler map give constructor function remove destroy map clear related event listener container create new map pane give exist return pane create child container child main map pane set pane return map pane give element identity Object return plain object contain name pane key pane value return element contain map context run give function map get initialize view center zoom layer immediately initialize optionally pass function context method get Map State Method return Description return geographical center map view Number return current zoom level map view return geographical bound visible current map view Number return minimum zoom level map set option map layer default Number return maximum zoom level map set option map layer bound inside point padding number return maximum zoom level give bound fit map view entirety inside optional set true method instead return minimum zoom level map view fit give bound entirety Point return current size map container pixel bound return bound current map view project pixel coordinates useful layer overlay implementation Point return project pixel coordinate left point map layer useful custom layer overlay implementation zoom bound return world bound pixel coordinate zoom level zoom zoom omit map current zoom level Conversion Methods Method Returns Description Number return scale factor apply map transition zoom level internally help zoom animation scale Number return zoom level map end level scale factor scale inverse project zoom Point Projects geographical coordinate accord projection map CRS scale accord zoom CRS Transformation result pixel coordinate relative CRS origin Point point zoom Inverse project Point point give pixel coordinate relative origin pixel return correspond geographical coordinate current zoom level point give geographical coordinate return correspond pixel coordinate relative origin pixel return lat wrap accord map CRS property outside CRS bound default mean longitude wrap dateline value degree bound return size give ensure center CRS bound default mean center longitude wrap dateline value degree majority bound overlap CRS bound distance number return distance geographical coordinate accord map CRS default measure distance meter Point point point give pixel coordinate relative map container return correspond pixel coordinate relative origin pixel Point point point give pixel coordinate relative origin pixel return correspond pixel coordinate relative map container Point point give pixel coordinate relative map container return correspond geographical coordinate current zoom level point give geographical coordinate return correspond pixel coordinate relative map container point give object return pixel coordinate relative map container event take place point give object return pixel coordinate relative origin pixel event take place give object return geographical coordinate event take place method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Properties Controls Property Type Description Control zoom default zoom control available option true create map Handlers Property Type Description Handler Box shift drag mouse zoom handler Handler Double click zoom handler drag Handler Map drag handler mouse touch keyboard Handler Keyboard navigation handler Handler Scroll wheel zoom handler tap Handler Mobile touch hack quick tap touch hold handler Handler Touch zoom handler Map pane Panes DOM element control ordering layer map access pane method new pane create method map follow default pane differ Pane Type index Description auto pane contain map pane Pane Pane overlay shadow Marker shadow Pane vector Path like Polygon Pane Icon Marker Pane Pane Locate option method Map option parameter plain object follow optional component option Type Default Description watch boolean false true start continuous watching location change instead detect method later stop watch method boolean false true automatically set map view user location respect detection accuracy world view fail Number Infinity maximum zoom automatic view set option timeout Number number millisecond wait response fire event number maximum age detect location millisecond pass response locate return cache location boolean false enable high accuracy description spec zoom option Map method modify zoom level option parameter plain object follow optional component option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation pan option Map method modify center map option parameter plain object follow optional component option Type Default Description animate Boolean true pan animate possible false animate pan reset map view pan screen away set new offset map pane duration Number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia Zoom pan option option inherit Zoom option Option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation option inherit Pan option Option Type Default Description duration number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia option option Type Default Description Point set padding left corner map container account set view fit bound useful control overlay map like sidebar want obscure object zoom Point right corner map padding Point equivalent set left right padding value number null maximum possible zoom use option inherit Zoom option Option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation option inherit Pan option Option Type Default Description duration number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia Marker display icon map Extends Layer usage example Creation Factory Description Marker option option instantiate Marker object give geographical point optionally option object option Option Type Default Description icon Icon Icon instance use render marker Icon documentation detail customize marker icon specify common instance Default keyboard Boolean true marker tab keyboard click press enter title String text browser appear marker hover default alt String text alt attribute icon image useful accessibility number default marker image set automatically base latitude use option want marker specify high value like high negative value respectively opacity number opacity marker boolean false true marker hover mouse number index offset feature pane String Map pane marker icon add String Map pane marker shadow add boolean false true mouse event marker trigger event map marker option Option Type Default Description boolean false marker mouse touch boolean false pan map drag marker near edge Point distance pixel left right map edge start pan map Number number pixel map pan option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description Event fire marker move drag old new coordinate include event argument drag event Event Data Description event fire user start drag marker Event fire marker start move dragging drag Event fire repeatedly user drag marker fire user stop drag marker Event fire marker stop move dragging mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer closed method addition share layer method like remove method like use follow method Method return Description return current geographical position marker change marker position give point offset change offset marker Icon return current icon marker Icon icon change marker icon opacity change opacity marker method Method Returns Description precision object precision number decimal place coordinate default value place return representation marker Point Feature method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Properties Interaction handler Interaction handler property marker instance allow control interaction behavior runtime enable disable certain feature drag Handler method example Property Type Description drag Handler Marker drag handler mouse touch valid marker map set open certain place map use open make sure open time recommend usability use open want usage example want bind marker click open easy path overlay like method complicated way open map var hello world nice Creation Factory Description option option Layer source instantiate object give optional option object describe appearance location optional source object tag reference Layer refer option Option Type Default Description Number Max width pixel number Min width pixel number null set create container give height inside content exceed boolean true set false want map pan animation fit opened Point null margin left corner map view perform Point null margin right corner map view perform Point equivalent set left right padding value Boolean false set true want prevent user pan screen open boolean true control presence close button boolean true set false want override default behavior closing open boolean true set false want override default behavior ESC key closing Boolean set want override default behavior closing user click map default map option String custom class assign option inherit Option Type Default Description offset Point offset position useful control anchor open overlay pane String Map pane add option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return geographical point set geographical point open return content set content function pass source layer pass function function return string return container update null Updates content layout position useful update inside change image load boolean return true visible map bring map pane bring map pane Map map add map close previous method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen display small text map layer usage example note offset Leaflet take option consideration compute offset offset option default specific add positive offset right positive offset negative left Icon option consider Marker adapt value use custom icon creation Factory Description option option Layer source instantiate object give optional option object describe appearance location optional source object tag reference Layer refer option Option Type Default Description pane string Map pane add offset Point optional offset position direction String auto direction open possible value right left center auto auto dynamically switch right leave accord position map permanent boolean false open permanently sticky boolean false true follow mouse instead fix feature center interactive boolean false true listen feature event opacity Number container opacity option inherit Option Type Default Description String custom class assign option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display tile layer map note tile server require attribution set Layer Extends usage example foo bar attribution Map datum copy contributor template string following form mean available sequentially help browser parallel request domain limitation value specify option default omit zoom level tile coordinate add load retina tile use custom key template evaluate option like foo bar Creation Extension method Factory Description option option instantiate tile layer object give template optionally option object option Option Type Default Description number minimum zoom level layer display inclusive number maximum zoom level layer display inclusive abc Subdomains tile service pass form string letter array string String tile image place tile fail load number zoom number tile offset value Boolean false true inverse axis numbering tile turn service boolean false set true zoom number tile reverse zoom instead zoom boolean false true user retina display request tile half specify size big zoom level place utilize high resolution false attribute add tile string provide tile attribute set string provide need want access tile pixel data refer Settings valid string value option inherit Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set Number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description update layer template redraw set true change layer redrawn parameter set false call internally override return element appropriate image give callback call tile load extension method layer extend reimplement following method Method Returns Description String call internally return tile give coordinate class extend override function provide custom tile naming scheme method inherit Method Returns Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen display service tile layer map extend usage example var bin layer format image transparent true attribution weather datum Creation Factory Description option option instantiate tile layer object give base service parameter option object option custom option document send server extra parameter request useful non standard vendor parameter option Type Default Description layer string require Comma separate list layer style String Comma separate list style format String image image format use image layer transparency transparent boolean false true service return image transparency version String Version service use crs CRS null Coordinate Reference System use request default map CRS change sure mean uppercase Boolean false true request parameter key uppercase option inherit Option Type Default Description number minimum zoom level layer display inclusive number maximum zoom level layer display inclusive abc Subdomains tile service pass form string letter array string String tile image place tile fail load number zoom number tile offset value Boolean false true inverse axis numbering tile turn service boolean false set true zoom number tile reverse zoom instead zoom boolean false true user retina display request tile half specify size big zoom level place utilize high resolution false attribute add tile string provide tile attribute set string provide need want access tile pixel data refer Settings valid string value option inherit Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set Number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description param merge object new parameter request tile current screen set true method inherit Method Returns Description update layer template redraw set true change layer redrawn parameter set false call internally override return element appropriate image give callback call tile load method inherit Method Returns Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display single image specific bound map Extends Layer usage example var Creation Factory Description bound option option instantiate image overlay object give image geographical bound tie option Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description load event fire layer load image error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover return instance overlay method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display video player specific bound map extend video overlay use element usage example var Creation Factory Description video bound option option instantiate image overlay object give video array video element geographical bound tie option Option Type Default Description boolean true video start play automatically load loop Boolean true video loop beginning play boolean true video save aspect ratio projection relevant support browser Browser mute boolean false video start mute load option inherit Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description load event fire video finish load frame event inherit Event Data Description error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return instance overlay method inherit Method Returns Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display provide DOM access file specific bound map extend overlay use element usage example var var Creation Factory Description bound option instantiate image overlay object give element geographical bound tie attribute require element zoom properly option Options inherit Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description load event fire layer load image error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return instance overlay method inherit Method Returns Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Path abstract class contain option constant share vector overlay Polygon Circle use directly Extends Layer option Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen class draw overlay map extend Path usage example create red array point var var color zoom map pass multi dimensional array represent shape create red array array point var Creation Factory Description option option instantiate object give array geographical point optionally option object create object multiple separate line pass array array geographic point option Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation Feature return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Polygon class draw polygon overlay map Extends note point pass create polygon additional point equal well filter point usage example create red polygon array point var var polygon color zoom map polygon pass array array array represent outer shape array represent hole outer shape var outer ring hole additionally pass multi dimensional array represent shape var polygon outer ring hole second polygon Creation Factory Description option option option Options inherit Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation polygon Polygon Feature method inherit Method Returns Description return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen rectangle class draw rectangle overlay map extend Polygon usage example define rectangle geographical bound var bound create orange rectangle color weight zoom map rectangle bound Creation Factory Description option option option Options inherit Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return description redraw rectangle pass bound method inherit Polygon Method Returns Description precision object precision number decimal place coordinate default value place return representation polygon Polygon Feature method inherit Method Returns Description return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Circle class draw circle overlay map Extends approximation start diverge real circle close pole projection distortion usage example radius Creation Factory Description Circle option option instantiate circle object give geographical point option object contain circle radius radius Circle option option obsolete way instantiate circle compatibility code use new application option Option Type Default Description radius Number Radius circle meter option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description Event fire marker move old new coordinate include event argument mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description radius set radius circle unit meter Number return current radius circle unit meter return path method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation circle marker Point Feature set position circle marker new location return current geographical position circle marker method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen circle fix size radius specify pixel extend Path creation Factory Description option option instantiate circle marker object give geographical point optional option object option Option Type Default Description radius Number Radius circle marker pixel option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description Event fire marker move old new coordinate include event argument mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation circle marker Point Feature set position circle marker new location return current geographical position circle marker radius set radius circle marker unit pixel Number return current radius circle method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen deprecate mean functionality exist backwards compatibility old version internet Explorer allow vector layer display Inherits Renderer technical limitation available web browser notably Android available browser support deprecate technology renderer fall case usage example Use default path map var map renderer use renderer extra padding specific vector geometry var map var padding var line coordinate renderer var circle center renderer Creation Factory Description Renderer option option create renderer give option option Options inherit Renderer Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Renderer Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen function static function call instantiate Function Returns Description create Returns instance correspond class pass example line return instance ring closed string generate path string multiple ring ring turn instruction Canvas allow vector layer display Inherits Renderer technical limitation Canvas available web browser notably overlap geometry display properly edge case usage example use Canvas default path map var map renderer use Canvas renderer extra padding specific vector geometry var map var padding var line coordinate renderer var circle center renderer Creation Factory Description Renderer option option create Canvas renderer give option option Options inherit Renderer Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Renderer Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen group layer handle add map layer add remove group add remove map Extends Layer usage example Creation Factory Description layer option create layer group optionally give initial set layer option object option Options inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Extended make easy thing member layer bind layer likewise event propagate group event handler handle event layer include mouse event custom event event Usage example world function member group Creation Factory Description layer option create feature group optionally give initial set layer option object option Options inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description fire layer add fire layer remove event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description Path option style set give path option layer group method bring layer group layer bring layer group layer return Feature Group create bound coordinate child method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen represent object array object allow parse datum display map Extends usage example style function feature return color layer return Creation Factory Description option option create layer Optionally accept object format display map alternatively add later method option object option Option Type Default Description Function Function define point spawn Leaflet layer internally call datum add pass point feature default spawn default Marker return style Function Function define Path option style line polygon call internally datum add default value override default function return Function Function call create Feature create style useful attach event feature default newly create layer function feature layer filter Function Function decide include feature default include feature function return true note dynamically change filter option effect newly add datum evaluate include feature Function Function convert coordinate default static method boolean false default Markers Point type Features inherit group option option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description fire layer add fire layer remove event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description datum add object layer layer reset give vector layer style original style useful resetting style hover event layer omit style feature current layer reset style change style vector layer give style function method inherit Method Returns Description bring layer group layer bring layer group layer return Feature Group create bound coordinate child method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen function static function call instantiate Function Returns Description option option Layer create layer give feature use custom function provide option create object array number longitude latitude number longitude latitude altitude point Array create multidimensional array coordinate array specify nesting level array point array array point etc default use custom function precision Array Reverse close Array Reverse close determine point append end array close feature false default Object Normalize geometry feature feature Generic class handle tile grid element base class tile layer replace Canvas extend create tile grid element like handle create animate DOM element usage example synchronous usage create custom layer extend implement method pass Point object zoom level coordinate draw tile var create element draw var tile leaflet tile setup tile width height accord option var size canvas context draw var return tile render screen return tile asynchronous usage Tile creation asynchronous useful party drawing library tile finish draw pass callback var var error create element draw var tile leaflet tile setup tile width height accord option var size draw asynchronously pass tile callback tile return tile Creation Factory Description option option create new instance supply option option Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set number minimum zoom level layer display inclusive number undefine maximum zoom level layer display inclusive number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method extension method layer extend shall reimplement following method Method Returns Description call internally overridden class extend return correspond give callback specify call tile finish load drawing method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen represent geographical point certain latitude longitude usage example var Leaflet method accept object accept simple array form simple object form note line equivalent lat note inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description latitude longitude altitude create object represent geographical point give latitude longitude optionally altitude expect array form number number number Number Number instead expect plain object form lat Number number lat Number Number alt Number instead method Method Returns Description equal boolean return true give point position small margin error margin error overridden set small number String return string representation point debug purpose number return distance meter give calculate Spherical Law Cosines wrap return new object longitude wrap degree return new object boundary meter apart Properties Property Type Description lat Number Latitude degree Number Longitude degree alt Number altitude meter optional represent rectangular geographical area map usage example var bound Leaflet method accept object accept simple array form note bound example pass like caution area cross confused International Date Line specify corner outside degree longitude range note inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description create object define diagonally opposite corner rectangle create object define geographical point contain useful zoom map fit particular set location method Method Returns Description extend extend bound contain give point extend extend bound contain give bound pad return bound create extend retract current bound give ratio direction example ratio extend bound direction negative value retract bound return center point bound return south west point bound return north east point bound return north west point bound return south east point bound Number return west longitude bound Number return south latitude bound Number return east longitude bound Number return north latitude bound contain boolean return true rectangle contain give contain boolean return true rectangle contain give point intersect boolean return true rectangle intersect give bound bound intersect point common overlap boolean return true rectangle overlap give bound bound overlap intersection area String return string bounding box coordinate format useful send request web service return geo data equal boolean return true rectangle equivalent small margin error give bound margin error overridden set small number boolean return true bound properly initialize Point represent point coordinate pixel usage example var point Leaflet method option accept Point object accept simple array form note line equivalent note Point inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description round create point object give coordinate optional round set true round value expect array form instead expect plain object form Number Number instead method Method Returns Description clone Point return copy current point add Point Point return result addition current give point subtract Point Point return result subtraction give point current num Point return result division current point give number num Point return result multiplication current point give number point scale Point Multiply coordinate current point coordinate scale linear algebra term multiply point scaling matrix define scale point scale Point Inverse divide coordinate current point coordinate scale round Point return copy current point rounded coordinate floor Point return copy current point floor coordinate round ceil Point return copy current point ceile coordinate round Point return copy current point truncate coordinate round zero Point Number return cartesian distance current give point equal Point boolean return true give point coordinate contain point boolean return true coordinate give point correspond current point coordinate absolute value String return string representation point debug purpose Properties Property Type Description number coordinate point number coordinate point bound represent rectangular area pixel coordinate usage example var bound Leaflet method accept Bounds object accept simple array form note bound example pass like note bound inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description Point point create Bounds object corner coordinate pair point create Bounds object give array point method Method Returns Description extend Point point extend bound contain give point round Point return center point bound Point return leave point bound Point return right point bound Point return leave point bound Point return right point bound Point return size give bound contain Bounds boolean return true rectangle contain give contain Point point boolean return true rectangle contain give point intersect Bounds boolean return true rectangle intersect give bound bound intersect point common overlap bound boolean return true rectangle overlap give bound bound overlap intersection area Properties Property Type Description min point leave corner rectangle max point right corner rectangle Icon represent icon provide create marker usage example var icon Default extend blue icon Leaflet use marker default creation Factory Description Icon option option create icon instance give option option Option Type Default Description String null require icon image absolute relative script path String null retina sized version icon image absolute relative script path Retina screen device point null Size icon image pixel Point null coordinate tip icon relative left corner icon align point marker geographical location center default size specify set negative margin Point coordinate point open relative icon anchor Point coordinate point open relative icon anchor string null icon shadow image specify shadow image create String null Point null Size shadow image pixel Point null coordinate tip shadow relative left corner specify String custom class assign icon shadow image default method Method return Description call internally icon show return element style accord option shadow beneath icon default trivial subclass Icon represent icon use Marker icon specify point blue marker image distribute Leaflet release order customize default icon change property set Icon option want completely replace default icon override icon instead option Type Default Description String Icon Default try auto detect location blue icon image place image non standard way set option point right path represent lightweight icon marker use simple element instead image inherit Icon ignore shadow option usage example var div icon set div icon style icon default leaflet div icon class style little white square shadow creation Factory Description option option create instance give option option Option Type Default Description Custom code inside div element default alternatively instance Point optional relative position background pixel option inherit Icon Option Type Default Description String null require icon image absolute relative script path String null retina sized version icon image absolute relative script path Retina screen device point null Size icon image pixel Point null coordinate tip icon relative left corner icon align point marker geographical location center default size specify set negative margin Point coordinate point open relative icon anchor Point coordinate point open relative icon anchor string null icon shadow image specify shadow image create String null Point null Size shadow image pixel Point null coordinate tip shadow relative left corner specify String custom class assign icon shadow image default method method inherit Icon Method Returns Description call internally icon show return element style accord option shadow beneath control zoom basic zoom control button zoom zoom map default set option false Extends Control creation Factory Description Control zoom option option create zoom control Options Option Type Default Description String text set zoom button String Zoom title set zoom button String text set zoom button String zoom title set zoom button option inherit Control Option Type Default Description position String position control map corner possible value Methods method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control attribution attribution control allow display attribution datum small text box map map default set option false fetch attribution text layer method automatically Extends Control creation Factory Description Control attribution option option create attribution control option Option Type Default Description prefix String Leaflet text show attribution pass false disable option inherit Control Option Type Default Description position String position control map corner possible value Methods Method Returns description prefix set text attribution text add attribution text Vector datum copy text remove attribution text method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control layer layer control give user ability switch different base layer switch overlay check detailed example Extends Control usage example var var overlay Marker marker road overlay parameter object literal layer name key Layer object value layer name contain allow add additional styling item Layer Creation Factory Description overlay Control layer option option create layer control give layer base layer switch radio button overlay switch note base layer pass base layer object add map map instantiation option Option Type Default Description collapse boolean true true control collapse icon expand mouse hover touch boolean true true control assign increase order layer order preserve switch boolean false true base layer control hide boolean false sort layer false layer order add control Function compare function sort layer true function receive instance name default sort layer alphabetically option inherit Control Option Type Default Description position String position control map corner possible value Methods Method Returns Description Layer layer add base layer radio button entry give control Layer layer add overlay entry give control Layer layer remove give layer control expand expand control container collapse collapse collapse control container expand method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control scale simple scale control show scale current center screen metric imperial system Extends Control usage example Creation Factory Description Control scale option option create scale control give option option Option Type Default Description Number maximum width control pixel width set dynamically round value metric Boolean True metric scale line imperial Boolean True imperial scale line boolean false true control update date update option inherit Control Option Type Default Description position String position control map corner possible value Methods method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active Browser static property browser feature detection Leaflet internally usage example browser dude Properties Property Type Description Boolean true Internet Explorer version Edge boolean true Internet Explorer version edge Boolean true Edge web browser Boolean true base browser like Chrome Safari include mobile version android Boolean true browser run Android platform Boolean true browser run Android Android boolean true Android stock browser Chrome opera Boolean true Opera browser chrome Boolean true Chrome browser gecko Boolean true gecko base browser like safari Boolean true Safari browser Boolean true Opera browser support transform version later win Boolean true browser run Windows platform boolean true Internet Explorer version support transform boolean true base browser support transform boolean true gecko base browser support transform boolean true browser support transform mobile Boolean true browser run mobile device boolean true base browser mobile device boolean true base browser mobile device support transform boolean true browser implement touch event model notably pointer Boolean true browser support pointer event touch Boolean true browser support touch event necessarily mean browser run computer mean browser capable understand touch event Boolean true Opera browser mobile device boolean true gecko base browser run mobile device retina Boolean true browser high resolution retina screen screen browser display zoom boolean true browser support passive event canvas Boolean true browser support Boolean true browser support Boolean true browser support util utility function Leaflet internally function Function Returns Description extend object merge property object multiple object object return shortcut create proto property object Compatibility bind Function return new function bind argument pass like shortcut stamp obj Number return unique object assign throttle time context Function return function execute function give scope context keyword refer context inside code function call time give time argument receive bind function argument pass bind function follow argument pass invoke bind function shortcut num range number return number num modulo range way lie return value small set true Function return function return false num digit number return number num round digit decimal decimal default trim str String Compatibility str String trim split string whitespace return array part obj option Object Merges give property option obj object return result option class option shortcut obj uppercase string convert object parameter string foo bar translate bar set parameter append end uppercase true parameter name uppercase bar template str datum String simple facility accept template string form hello data object like foo bar return evaluate string hello foo bar specify function instead string datum value evaluate pass datum argument obj Boolean Compatibility array Number Compatibility context immediate Number Schedules execute browser repaint bind context give immediate set call immediately browser native support delay return request cancel request undefine Cancels previous Properties Property Type Description Number unique stamp String Data URI string contain encode GIF image hack free memory unused image power mobile device set image string Transformation represent affine transformation set coefficient transform point form reverse Leaflet projection code usage example var transformation Creation Factory Description instantiate Transformation object give coefficient coefficient expect coefficient array form Number Number Number number method Method Returns Description transform Point point scale Point return transform point optionally multiply give scale accept actual instance array Point point scale Point return reverse transformation give point optionally divide give scale accept actual instance array utility function point processing Leaflet internally lightning fast function Function Returns Description simplify point tolerance Point Dramatically reduce number point retain shape return new array simplified point Douglas algorithm huge performance boost processing display Leaflet zoom level reduce visual noise tolerance affect simplification less value mean high quality slow point release separate micro library point Point Point number return distance point segment point Point Point number return close point point segment Point Point bound bound round clip segment rectangular bound Cohen algorithm modify segment point directly Leaflet point screen near increase performance boolean return true flat array false nest utility function polygon geometry function Function Returns Description point bound bound round point clip polygon geometry define give point give bound algorithm Leaflet polygon point screen near increase performance note polygon point need different algorithm clip separate method utility function work DOM event Leaflet internally function Function Returns Description type context add listener function particular dom event type element optionally specify context listener object keyword point pass space separate type click context add set type listener pair click type context remove previously add listener function note pass custom context pass context order remove listener context remove set type listener pair click stop give event propagation parent element inside listener function click function add element wheel event plus browser variant add element click event plus browser variant prevent default action DOM Event happen follow link element post request page reload submit use inside listener function stop time container Point get normalize mouse position dom event relative container border exclude page specify number get normalize wheel delta wheel dom event vertical pixel scroll negative scroll event point device precise scrolling map good guess pixel Alias Alias Utility function work dom tree Leaflet internally function expect return work element difference class refer class class function Function Returns Description return element give DOM return element pass directly String return value certain style attribute element include compute value value set create container create element set class optionally append container element remove Removes parent element Removes child element make child parent render child make child parent render child boolean return true element class attribute contain add element class attribute Removes element class attribute set element class String return element class opacity set opacity element include old support opacity number prop array style name return valid style element find return false useful vendor prefix style like transform Point offset scale reset transform translate offset pixel optionally scale scale effect browser support transform Point position set position coordinate specify position translate leave positioning depend browser Leaflet internally position layer Point return coordinate element previously position prevent user generate DOM event usually generate user drag mouse page text internally Leaflet override behaviour click drag interaction map affect drag interaction document cancel effect previous dom event usually generate user drag image cancel effect previous make outline element invisible internally Leaflet prevent focusable element display outline user perform drag interaction cancel effect previous find close parent node size width height null Object compute scale currently apply element return object member horizontal vertical scale respectively result Properties Property Type Description transform String Vendor prefix transform style transition String Vendor prefix transition style String Vendor prefix event internally pan animation utilize Transitions modern browser timer fallback usage example var new Constructor Constructor Description create object event Event Data Description start Event fire animation start step Event fire continuously animation end Event fire animation end method Method Returns Description run Point duration run animation give element new position optionally set duration second default ease linearity factor argument cubic curve default stop stop animation currently run method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen class make DOM element include touch support internally map marker dragging work element position usage example var new Constructor Constructor Description option option create object move start drag element equal default option Option Type Default Description number max number pixel user shift mouse pointer click consider valid click oppose mouse drag event Event Data Description Event fire drag start Event fire drag start Event fire continuously drag correspond update element position drag Event fire continuously drag fire drag end method Method Returns Description enable enable drag ability disable disable drag ability method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Class power facility Leaflet create Leaflet class document addition implement simple classical inheritance model introduce special property convenient code organization option include static usage example var initialize function greeter greeter class constructor greet function create instance pass Hello constructor var new greet method alert Hello World Class Factories notice Leaflet object create new keyword achieve complement class lowercase factory method new factory implement easily class function option return new option inheritance use define new class use method class inherit var new property method create class inherit method property parent class proper prototype chain add override one pass extend properly react var new true true parent method include constructor corresponding child one super call language access parent class prototype apply var initialize function greet function bro var new alert bro Jason option option special property unlike object pass extend merge parent instead override completely make manage configuration object default value convenient var option foo bar var option var new bar method conveniently merge option pass constructor default define class var option foo bar initialize function option option var new foo bar note option object allow key option define class base class mean use option object store application specific information long avoid key class question include include special class property merge specify object class object call var foo function bar var include var new include runtime include method static convenience property inject specify object property static property class useful define constant var static FOO bar FOO bar Constructor hook developer need add additional initialization code exist class edit hook Leaflet come way easily method constructor additionally add event listener set custom property etc use following shortcut need additional method function Function Returns Description extend prop Function extend current class give property include return function class constructor call new include property include current class option Merges option default class add constructor hook class set method share event power class like Map Marker generally event allow execute function happen object user click map cause map fire click event usage example Leaflet deal event listener reference want add listener remove define function function Methods Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Layer set method Layer base class Leaflet layer use inherit method option event usage example var layer Options Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description add Event fire layer add map remove event fire layer remove map event Event Data Description Fired bind layer open Fired bind layer close event Event Data Description Fired bind layer open Fired bind layer close method class extend inherit follow method Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option extension method layer extend follow method Method Returns Description Map map contain code create DOM element layer add map pane belong put listener relevant map event call Map map contain clean code remove layer element dom remove listener previously add call object optional method return object like event handler object automatically add remove map layer string optional method return string contain show Attribution control layer visible Map map optional method call layer add map event initialize wait map usable state use early initialization method layer share set method convenient bind var layer automatically open layer click close layer remove map open Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method layer share set method convenient bind var layer Method return Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen interactive layer Layer interactive user interact layer mouse event like click handle use event handle method handle event option Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Mouse event Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Control base class implement map control handle positioning control extend class option Option Type Default Description position String position control map corner possible value Methods class extend inherit follow method Method return Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active extension method control extend follow method Method Returns Description Map map return container dom element control add listener relevant map event call Map map optional method contain clean code remove listener previously add call Handler abstract class map interaction handler Methods Method Returns Description enable enable handler disable disable handler enable boolean return true handler enable Extension method class inherit Handler implement follow method Method return Description call handler enable add event hook call handler disabled remove event hook add previously function static function call instantiate Function Returns Description Map map add new handler give map give Projection object method project geographical coordinate world flat surface Map projection method Method Returns Description project Point Projects geographical coordinate point accept actual instance array Point point inverse project project point geographical location accept actual instance array note projection instance inherit Leaflet Class object instantiate new class inherit method add include function Properties Property Type Description bound bound bound specify CRS unit projection valid define projection Leaflet come set define Projections box Projection Description Plate Carree projection simple projection GIS enthusiast directly map longitude latitude suitable flat world game map Simple CRS Mercator Elliptical Mercator projection complex Spherical Mercator assume Earth ellipsoid CRS Spherical Mercator projection common projection online map free commercial tile provider assume Earth sphere CRS CRS Methods Method Returns Description zoom Point Projects geographical coordinate pixel coordinate give zoom Point point zoom inverse project pixel coordinate give zoom geographical coordinate project Point Projects geographical coordinate coordinate unit accept CRS meter pass service Point point give project coordinate return correspond inverse project scale zoom Number return scale transform project coordinate pixel coordinate particular zoom example return Mercator base CRS zoom scale Number Inverse scale return zoom level correspond scale factor scale zoom bounds return projection bound scale transform provide zoom distance number return distance geographical coordinate return lat wrap accord CRS property outside CRS bound bound return size give ensure center CRS bound accept actual instance array Properties Property Type Description code String Standard code CRS pass service Number array number define longitude horizontal coordinate axis wrap give range default geographical crs undefine longitude axis wrap number like latitude vertical axis infinite Boolean true coordinate space unbounded infinite axis define crs CRS Description rarely commercial tile provider use Elliptical Mercator projection common CRS online map free commercial tile provider use Spherical Mercator projection Set default Map crs option common crs gis enthusiast use simple projection Leaflet coordinate scheme break change behaviour CRS ensure pixel tile cover earth zoom level zero tile coordinate origin option set serve base CRS global cover earth base CRS directly code projection transformation distance return meter simple crs map longitude latitude directly map flat surface game map note axis invert distance return simple euclidean distance Object define coordinate reference system project geographical point pixel screen coordinate coordinate unit service spatial reference system Leaflet define usual crs default want use CRS define default look note CRS instance inherit Leaflet Class object instantiate new class inherit method add include function Renderer Base class vector renderer implementation Canvas handle DOM container renderer bound zoom animation Renderer work implicit layer group Path renderer add remove map path use renderer implicit map decide type renderer use automatically explicit renderer option path use class directly use Canvas instead option Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen event object class inherit fire event listener function call event argument plain object contain information event example event object case information available depend event type event base event object event object contain property Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description original DOM trigger Leaflet event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description geographical point mouse event occur Point Pixel coordinate point mouse event occur relative map layer Point Pixel coordinate point mouse event occur relative map original DOM DOM trigger Leaflet event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description detect geographical location user bound geographical bound area user locate respect accuracy location accuracy Number Accuracy location meter altitude Number Height position ellipsoid meter Number Accuracy altitude meter head number direction travel degree count clockwise true North speed number current velocity meter second timestamp number time position acquire property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description message string Error message code Number Error code applicable property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description layer Layer layer add remove property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description layer Layer layer add remove String layer add remove property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description tile tile element image Point Point object tile zoom level coordinate property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description tile tile element image Point Point object tile zoom level coordinate error error pass tile callback property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description point old size resize event point new size resize event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description layer Layer layer feature add map property object property feature String geometry type feature String feature present property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description open close property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description open close property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description distance number distance pixel element move property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description center current center map zoom number current zoom level map Boolean layer update content event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Base model Inherit custom like option Option Type Default Description offset Point offset position useful control anchor open overlay String custom class assign pane String Map pane add option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Global Switches Global switch create rare case generally Leaflet detect particular browser feature need set switch global variable true include Leaflet page like switch description Forces Leaflet use touch event detect Forces Leaflet use hardware accelerate transform positioning cause glitch rare environment support method restore global variable original value Leaflet inclusion return real Leaflet like version constant represent Leaflet version use contain version currently use Leaflet reference Map Usage example Creation Options Events Map Methods Modifying map state get map state Layers control Conversion method method Map Misc Properties Panes Layers Marker Raster Layers Vector Layers Path Polygon Rectangle Circle Canvas Layers Basic Types point bound Icon Controls Zoom Attribution Layers Scale Utility Browser Util Transformation dom Utility Base Classes Class Layer Interactive layer Control Handler Projection CRS Renderer Misc Event object global switch version Map central class create map page manipulate usage example initialize map map div give center zoom var map center zoom Creation Factory Description option instantiate map object give DOM element optionally object literal Map option option instantiate map object give instance element optionally object literal Map option option Option Type Default Description boolean false Path render Canvas renderer default Path render renderer control option Option Type Default Description boolean true attribution control add map default boolean true zoom control add map default Interaction Options Option Type Default Description Boolean true set false want close user click map number force map zoom level multiple particularly right pinch zoom default zoom level snap near integer low value allow great granularity value mean zoom level snap pinch zoom number control map zoom level change press keyboard zoom control value small allow great granularity boolean true map automatically handle browser window resize update Boolean true map zoom rectangular area specify drag mouse press shift key true map zoom double clicking zoom double clicking hold shift pass center double click zoom zoom center view regardless mouse drag Boolean true map mouse touch Map State Options Option Type Default Description CRS Coordinate Reference System use change sure mean center undefine initial geographic center map zoom Number undefine initial map zoom level number minimum zoom level map specify map low option instead number maximum zoom level map specify map high option instead layer Layer array layer add map initially null option set map restrict view give geographical bound bounce user user try pan outside view set restriction dynamically use method renderer Renderer default method draw vector layer map default depend browser support Animation Options Option Type Default Description boolean true map zoom animation enable default enable browser support Transitions Android Number will animate zoom zoom difference exceed value boolean true tile fade animation enable default enable browser support Transitions Android boolean true marker animate zoom zoom animation disabled disappear length animation default enable browser support Transitions Android number define maximum size translation transform default value change web browser position layer wrong place large pan Inertia Options Option Type Default Description inertia Boolean enable pan map inertia effect map build momentum drag continue move direction time feel especially nice touch device enable default run old Android device number rate inertial movement slow pixels Number Infinity Max speed inertial movement pixels second Number boolean false option enable map track pan copy world seamlessly jump original overlay like marker vector layer visible number set option control solid bound drag map default value allow user drag outside bound normal speed high value slow map drag outside bound make bound fully solid prevent user drag outside bound Keyboard Navigation Options Option Type Default Description keyboard Boolean true make map focusable allow user navigate map keyboard arrow key Number pixel pan press arrow key mouse wheel option Option Type Default Description true map zoom mouse wheel pass center zoom center view regardless mouse number limit rate wheel fire millisecond default user zoom wheel number scroll pixel report mean change zoom level small value wheel zooming fast vice versa touch interaction option Option Type Default Description tap boolean true Enables mobile hack support instant tap fix click delay iOS Android touch hold fire event number max number pixel user shift finger touch consider valid tap map zoom touch dragging finger pass center zoom center view regardless touch event finger enable touch capable web browser old Androids boolean true set false want map zoom min max zoom bounce pinch zooming event Layer event Event Data Description fire base layer change layer control fire overlay select layer control fire overlay layer control fire new layer add map fire layer remove map Map state change event Event Data Description Event fire number map change add remove layer resize fire map resize unload Event fire map destroy remove method Event fire map need redraw content usually happen map zoom load useful create custom overlay load Event fire map initialize center zoom set time Event fire map zoom change zoom animation Event fire view map start change user start drag map zoom Event fire repeatedly change zoom level include zoom fly animation Event fire repeatedly movement map include pan fly animation Event fire map change animation Event fire center map stop change user stop drag map event Event Data Description Fired open map Fired map closed Event fire map start open event Event Data Description Fired open map Fired map closed location event Event Data Description Fired locate method fail fire locate method successfully interaction event Event Data Description click Fired user click tap map Fired user double click double tap map fire user push mouse button map fire user release mouse button map Fired mouse enter map Fired mouse leave map Fired mouse move map Fired user push right mouse button map prevent default browser context menu show listener event fire mobile user hold single touch second call long press keypress fire user press key keyboard produce character value map focus fire user press key keyboard map focus unlike keypress event event fire key produce character value key produce character value fire user release key keyboard map focus Fired mouse click map useful want happen click exist click handler start run event Event Data Description fire zoom animation continuous zoom like pinch zooming fire frame zoom method Method return Description Path layer Renderer return instance Renderer render give Path ensure renderer option map path respect renderer exist map method Layers Controls Method return Description Control control add give control map Control control remove give control map Layer layer add give layer map Layer layer remove give layer map Layer layer boolean return true give layer currently add map context iterate layer map optionally specify context iterator function open specified close previously open sure open time usability content option option create specify content option open give point map close previously open give open specify content option option create specify content option open close give parameter method modify map state Method Returns Description center zoom Zoom pan option option set view map geographical center zoom give animation option zoom Zoom pan option option set zoom map delta Zoom option option increase zoom map delta default delta Zoom option option decrease zoom map delta default zoom Zoom option option zoom map keep specify geographical point map stationary internally scroll zoom double click zoom point offset zoom Zoom option option zoom map keep specify pixel map relative leave corner stationary bound option option set map view contain give geographical bound maximum zoom level possible option option set map view contain world maximum zoom level possible panto Pan option option pan map give center point offset Pan option option pan map give number pixel animate zoom Zoom pan option option set view map geographical center zoom perform smooth pan zoom animation bound option option set view map smooth animation like take bound parameter like bound restrict map view give bound option zoom set low limit available zoom level option zoom set upper limit available zoom level option bound Pan option option pan map close view lie inside give bound control animation option specific option pan map minimum visible Use padding option fit display restricted bound like optionally padded display bound map pan Zoom pan option option check map container size change update map change map size dynamically animate pan default false pan occur true delay event happen method call time row animate check map container size change update map change map size dynamically animate pan default stop stop currently run panto animation method Method Returns Description locate locate option option try locate user fire event location datum success event failure optionally set map view user location respect detection accuracy world view fail note page use method fail modern browser Chrome new locate option detail stop watch location previously initiate true abort reset map view call true Methods Method return Description add new handler map give constructor function remove destroy map clear related event listener container create new map pane give exist return pane create child container child main map pane set pane return map pane give element identity Object return plain object contain name pane key pane value return element contain map context run give function map get initialize view center zoom layer immediately initialize optionally pass function context method get Map State Method return Description return geographical center map view Number return current zoom level map view return geographical bound visible current map view Number return minimum zoom level map set option map layer default Number return maximum zoom level map set option map layer bound inside point padding number return maximum zoom level give bound fit map view entirety inside optional set true method instead return minimum zoom level map view fit give bound entirety Point return current size map container pixel bound return bound current map view project pixel coordinates useful layer overlay implementation Point return project pixel coordinate left point map layer useful custom layer overlay implementation zoom bound return world bound pixel coordinate zoom level zoom zoom omit map current zoom level Conversion Methods Method Returns Description Number return scale factor apply map transition zoom level internally help zoom animation scale Number return zoom level map end level scale factor scale inverse project zoom Point Projects geographical coordinate accord projection map CRS scale accord zoom CRS Transformation result pixel coordinate relative CRS origin Point point zoom Inverse project Point point give pixel coordinate relative origin pixel return correspond geographical coordinate current zoom level point give geographical coordinate return correspond pixel coordinate relative origin pixel return lat wrap accord map CRS property outside CRS bound default mean longitude wrap dateline value degree bound return size give ensure center CRS bound default mean center longitude wrap dateline value degree majority bound overlap CRS bound distance number return distance geographical coordinate accord map CRS default measure distance meter Point point point give pixel coordinate relative map container return correspond pixel coordinate relative origin pixel Point point point give pixel coordinate relative origin pixel return correspond pixel coordinate relative map container Point point give pixel coordinate relative map container return correspond geographical coordinate current zoom level point give geographical coordinate return correspond pixel coordinate relative map container point give object return pixel coordinate relative map container event take place point give object return pixel coordinate relative origin pixel event take place give object return geographical coordinate event take place method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Properties Controls Property Type Description Control zoom default zoom control available option true create map Handlers Property Type Description Handler Box shift drag mouse zoom handler Handler Double click zoom handler drag Handler Map drag handler mouse touch keyboard Handler Keyboard navigation handler Handler Scroll wheel zoom handler tap Handler Mobile touch hack quick tap touch hold handler Handler Touch zoom handler Map pane Panes DOM element control ordering layer map access pane method new pane create method map follow default pane differ Pane Type index Description auto pane contain map pane Pane Pane overlay shadow Marker shadow Pane vector Path like Polygon Pane Icon Marker Pane Pane Locate option method Map option parameter plain object follow optional component option Type Default Description watch boolean false true start continuous watching location change instead detect method later stop watch method boolean false true automatically set map view user location respect detection accuracy world view fail Number Infinity maximum zoom automatic view set option timeout Number number millisecond wait response fire event number maximum age detect location millisecond pass response locate return cache location boolean false enable high accuracy description spec zoom option Map method modify zoom level option parameter plain object follow optional component option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation pan option Map method modify center map option parameter plain object follow optional component option Type Default Description animate Boolean true pan animate possible false animate pan reset map view pan screen away set new offset map pane duration Number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia Zoom pan option option inherit Zoom option Option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation option inherit Pan option Option Type Default Description duration number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia option option Type Default Description Point set padding left corner map container account set view fit bound useful control overlay map like sidebar want obscure object zoom Point right corner map padding Point equivalent set left right padding value number null maximum possible zoom use option inherit Zoom option Option Type Default Description animate Boolean specify zoom animation happen zoom origin inside current view true map attempt animate zoom disregard zoom origin set false reset view completely animation option inherit Pan option Option Type Default Description duration number Duration animate panning second number curvature factor pan animation ease parameter Cubic curve mean linear animation small number bow curve boolean false true pan will fire event start internally pan inertia Marker display icon map Extends Layer usage example Creation Factory Description Marker option option instantiate Marker object give geographical point optionally option object option Option Type Default Description icon Icon Icon instance use render marker Icon documentation detail customize marker icon specify common instance Default keyboard Boolean true marker tab keyboard click press enter title String text browser appear marker hover default alt String text alt attribute icon image useful accessibility number default marker image set automatically base latitude use option want marker specify high value like high negative value respectively opacity number opacity marker boolean false true marker hover mouse number index offset feature pane String Map pane marker icon add String Map pane marker shadow add boolean false true mouse event marker trigger event map marker option Option Type Default Description boolean false marker mouse touch boolean false pan map drag marker near edge Point distance pixel left right map edge start pan map Number number pixel map pan option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description Event fire marker move drag old new coordinate include event argument drag event Event Data Description event fire user start drag marker Event fire marker start move dragging drag Event fire repeatedly user drag marker fire user stop drag marker Event fire marker stop move dragging mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer closed method addition share layer method like remove method like use follow method Method return Description return current geographical position marker change marker position give point offset change offset marker Icon return current icon marker Icon icon change marker icon opacity change opacity marker method Method Returns Description precision object precision number decimal place coordinate default value place return representation marker Point Feature method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Properties Interaction handler Interaction handler property marker instance allow control interaction behavior runtime enable disable certain feature drag Handler method example Property Type Description drag Handler Marker drag handler mouse touch valid marker map set open certain place map use open make sure open time recommend usability use open want usage example want bind marker click open easy path overlay like method complicated way open map var hello world nice Creation Factory Description option option Layer source instantiate object give optional option object describe appearance location optional source object tag reference Layer refer option Option Type Default Description Number Max width pixel number Min width pixel number null set create container give height inside content exceed boolean true set false want map pan animation fit opened Point null margin left corner map view perform Point null margin right corner map view perform Point equivalent set left right padding value Boolean false set true want prevent user pan screen open boolean true control presence close button boolean true set false want override default behavior closing open boolean true set false want override default behavior ESC key closing Boolean set want override default behavior closing user click map default map option String custom class assign option inherit Option Type Default Description offset Point offset position useful control anchor open overlay pane String Map pane add option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return geographical point set geographical point open return content set content function pass source layer pass function function return string return container update null Updates content layout position useful update inside change image load boolean return true visible map bring map pane bring map pane Map map add map close previous method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen display small text map layer usage example note offset Leaflet take option consideration compute offset offset option default specific add positive offset right positive offset negative left Icon option consider Marker adapt value use custom icon creation Factory Description option option Layer source instantiate object give optional option object describe appearance location optional source object tag reference Layer refer option Option Type Default Description pane string Map pane add offset Point optional offset position direction String auto direction open possible value right left center auto auto dynamically switch right leave accord position map permanent boolean false open permanently sticky boolean false true follow mouse instead fix feature center interactive boolean false true listen feature event opacity Number container opacity option inherit Option Type Default Description String custom class assign option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display tile layer map note tile server require attribution set Layer Extends usage example foo bar attribution Map datum copy contributor template string following form mean available sequentially help browser parallel request domain limitation value specify option default omit zoom level tile coordinate add load retina tile use custom key template evaluate option like foo bar Creation Extension method Factory Description option option instantiate tile layer object give template optionally option object option Option Type Default Description number minimum zoom level layer display inclusive number maximum zoom level layer display inclusive abc Subdomains tile service pass form string letter array string String tile image place tile fail load number zoom number tile offset value Boolean false true inverse axis numbering tile turn service boolean false set true zoom number tile reverse zoom instead zoom boolean false true user retina display request tile half specify size big zoom level place utilize high resolution false attribute add tile string provide tile attribute set string provide need want access tile pixel data refer Settings valid string value option inherit Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set Number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description update layer template redraw set true change layer redrawn parameter set false call internally override return element appropriate image give callback call tile load extension method layer extend reimplement following method Method Returns Description String call internally return tile give coordinate class extend override function provide custom tile naming scheme method inherit Method Returns Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen display service tile layer map extend usage example var bin layer format image transparent true attribution weather datum Creation Factory Description option option instantiate tile layer object give base service parameter option object option custom option document send server extra parameter request useful non standard vendor parameter option Type Default Description layer string require Comma separate list layer style String Comma separate list style format String image image format use image layer transparency transparent boolean false true service return image transparency version String Version service use crs CRS null Coordinate Reference System use request default map CRS change sure mean uppercase Boolean false true request parameter key uppercase option inherit Option Type Default Description number minimum zoom level layer display inclusive number maximum zoom level layer display inclusive abc Subdomains tile service pass form string letter array string String tile image place tile fail load number zoom number tile offset value Boolean false true inverse axis numbering tile turn service boolean false set true zoom number tile reverse zoom instead zoom boolean false true user retina display request tile half specify size big zoom level place utilize high resolution false attribute add tile string provide tile attribute set string provide need want access tile pixel data refer Settings valid string value option inherit Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set Number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description param merge object new parameter request tile current screen set true method inherit Method Returns Description update layer template redraw set true change layer redrawn parameter set false call internally override return element appropriate image give callback call tile load method inherit Method Returns Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display single image specific bound map Extends Layer usage example var Creation Factory Description bound option option instantiate image overlay object give image geographical bound tie option Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description load event fire layer load image error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover return instance overlay method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display video player specific bound map extend video overlay use element usage example var Creation Factory Description video bound option option instantiate image overlay object give video array video element geographical bound tie option Option Type Default Description boolean true video start play automatically load loop Boolean true video loop beginning play boolean true video save aspect ratio projection relevant support browser Browser mute boolean false video start mute load option inherit Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description load event fire video finish load frame event inherit Event Data Description error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return instance overlay method inherit Method Returns Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen load display provide DOM access file specific bound map extend overlay use element usage example var var Creation Factory Description bound option instantiate image overlay object give element geographical bound tie attribute require element zoom properly option Options inherit Option Type Default Description opacity number opacity image overlay alt String text alt attribute image useful accessibility interactive boolean false true image overlay emit mouse event click hover false attribute add image string provide image attribute set string provide need want access image pixel data refer Settings valid string value String overlay image place overlay fail load number explicit overlay layer String custom class assign image default option inherit interactive layer Option Type Default Description boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description load event fire layer load image error event fire layer fail load image mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description return instance overlay method inherit Method Returns Description opacity set opacity overlay bring layer overlay bring layer overlay change image bound update bound cover value change image overlay bound cover method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Path abstract class contain option constant share vector overlay Polygon Circle use directly Extends Layer option Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen class draw overlay map extend Path usage example create red array point var var color zoom map pass multi dimensional array represent shape create red array array point var Creation Factory Description option option instantiate object give array geographical point optionally option object create object multiple separate line pass array array geographic point option Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation Feature return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Polygon class draw polygon overlay map Extends note point pass create polygon additional point equal well filter point usage example create red polygon array point var var polygon color zoom map polygon pass array array array represent outer shape array represent hole outer shape var outer ring hole additionally pass multi dimensional array represent shape var polygon outer ring hole second polygon Creation Factory Description option option option Options inherit Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation polygon Polygon Feature method inherit Method Returns Description return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen rectangle class draw rectangle overlay map extend Polygon usage example define rectangle geographical bound var bound create orange rectangle color weight zoom map rectangle bound Creation Factory Description option option option Options inherit Option Type Default Description number simplify zoom level mean well performance smoother look mean accurate representation boolean false Disable clip option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return description redraw rectangle pass bound method inherit Polygon Method Returns Description precision object precision number decimal place coordinate default value place return representation polygon Polygon Feature method inherit Method Returns Description return array point path nest array point case multi replace point give array geographical point boolean return true point Point return point close return center centroid return path add give point default add ring case multi overridden pass specific ring array early access method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Circle class draw circle overlay map Extends approximation start diverge real circle close pole projection distortion usage example radius Creation Factory Description Circle option option instantiate circle object give geographical point option object contain circle radius radius Circle option option obsolete way instantiate circle compatibility code use new application option Option Type Default Description radius Number Radius circle meter option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description Event fire marker move old new coordinate include event argument mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description radius set radius circle unit meter Number return current radius circle unit meter return path method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation circle marker Point Feature set position circle marker new location return current geographical position circle marker method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen circle fix size radius specify pixel extend Path creation Factory Description option option instantiate circle marker object give geographical point optional option object option Option Type Default Description radius Number Radius circle marker pixel option inherit Path Option Type Default Description stroke boolean true draw stroke path set false disable border polygon circle color String Stroke color weight Number Stroke width pixel opacity Number Stroke opacity String round string define shape end stroke String round string define shape corner stroke string null string define stroke dash pattern work Canvas layer old browser String null string define distance dash pattern start dash work Canvas layer old browser fill Boolean depend fill path color set false disable filling polygon circle String fill color default value color option Number fill opacity String string define inside shape determine boolean true true mouse event path trigger event map renderer Renderer Use specific instance Renderer path take precedence map default renderer String null Custom class set element renderer option inherit interactive layer Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description Event fire marker move old new coordinate include event argument mouse event inherit interactive layer Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation circle marker Point Feature set position circle marker new location return current geographical position circle marker radius set radius circle marker unit pixel Number return current radius circle method inherit Path Method Returns Description redraw redraw layer useful change coordinate path use Path option style change appearance Path base option Path option object bring layer path layer bring layer path layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen deprecate mean functionality exist backwards compatibility old version internet Explorer allow vector layer display Inherits Renderer technical limitation available web browser notably Android available browser support deprecate technology renderer fall case usage example Use default path map var map renderer use renderer extra padding specific vector geometry var map var padding var line coordinate renderer var circle center renderer Creation Factory Description Renderer option option create renderer give option option Options inherit Renderer Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Renderer Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen function static function call instantiate Function Returns Description create Returns instance correspond class pass example line return instance ring closed string generate path string multiple ring ring turn instruction Canvas allow vector layer display Inherits Renderer technical limitation Canvas available web browser notably overlap geometry display properly edge case usage example use Canvas default path map var map renderer use Canvas renderer extra padding specific vector geometry var map var padding var line coordinate renderer var circle center renderer Creation Factory Description Renderer option option create Canvas renderer give option option Options inherit Renderer Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Renderer Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen group layer handle add map layer add remove group add remove map Extends Layer usage example Creation Factory Description layer option create layer group optionally give initial set layer option object option Options inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Extended make easy thing member layer bind layer likewise event propagate group event handler handle event layer include mouse event custom event event Usage example world function member group Creation Factory Description layer option create feature group optionally give initial set layer option object option Options inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description fire layer add fire layer remove event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description Path option style set give path option layer group method bring layer group layer bring layer group layer return Feature Group create bound coordinate child method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen represent object array object allow parse datum display map Extends usage example style function feature return color layer return Creation Factory Description option option create layer Optionally accept object format display map alternatively add later method option object option Option Type Default Description Function Function define point spawn Leaflet layer internally call datum add pass point feature default spawn default Marker return style Function Function define Path option style line polygon call internally datum add default value override default function return Function Function call create Feature create style useful attach event feature default newly create layer function feature layer filter Function Function decide include feature default include feature function return true note dynamically change filter option effect newly add datum evaluate include feature Function Function convert coordinate default static method boolean false default Markers Point type Features inherit group option option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Event Data Description fire layer add fire layer remove event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method Returns Description datum add object layer layer reset give vector layer style original style useful resetting style hover event layer omit style feature current layer reset style change style vector layer give style function method inherit Method Returns Description bring layer group layer bring layer group layer return Feature Group create bound coordinate child method inherit Method Returns Description precision object precision number decimal place coordinate default value place return representation layer group Layer layer add give layer group Layer layer remove give layer group remove layer give internal group Layer layer boolean return true give layer currently add group boolean return true give internal currently add group remove layer group invoke call layer contain group pass additional parameter effect layer contain implement context iterate layer group optionally specify context iterator function layer Layer return layer give internal Layer return array layer add group call layer contain group pass index Layer layer Number return internal layer method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen function static function call instantiate Function Returns Description option option Layer create layer give feature use custom function provide option create object array number longitude latitude number longitude latitude altitude point Array create multidimensional array coordinate array specify nesting level array point array array point etc default use custom function precision Array Reverse close Array Reverse close determine point append end array close feature false default Object Normalize geometry feature feature Generic class handle tile grid element base class tile layer replace Canvas extend create tile grid element like handle create animate DOM element usage example synchronous usage create custom layer extend implement method pass Point object zoom level coordinate draw tile var create element draw var tile leaflet tile setup tile width height accord option var size canvas context draw var return tile render screen return tile asynchronous usage Tile creation asynchronous useful party drawing library tile finish draw pass callback var var error create element draw var tile leaflet tile setup tile width height accord option var size draw asynchronously pass tile callback tile return tile Creation Factory Description option option create new instance supply option option Option Type Default Description Width height tile grid use number width height equal height opacity Number Opacity tile function Boolean depend load new tile pan end true default mobile browser order avoid request smooth navigation false order display new tile panning easy pan outside option desktop browser boolean true default smooth zoom animation touch zoom update grid layer integer zoom level set option false update grid layer smooth animation end number tile update millisecond pan number explicit tile layer bound undefined set tile load inside set number minimum zoom level layer display inclusive number undefine maximum zoom level layer display inclusive number undefine Maximum zoom number tile source available specify tile zoom level high load level auto scale number undefine Minimum zoom number tile source available specify tile zoom level low load level auto scale boolean false layer wrap true display low zoom level effect map CRS wrap combination bound bound prevent request tile outside CRS limit pane String Map pane grid layer add String custom class assign tile layer default number pan map row column tile unload option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description loading Event fire grid layer start loading tile fire tile remove tile screen Fired tile request start loading fire error load tile Fired tile load load Event fire grid layer load visible tile event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method Method return Description bring tile layer tile layer bring tile layer tile layer return element contain tile layer opacity change opacity grid layer change grid layer boolean return true tile grid layer finish load redraw cause layer clear tile request point normalize option point method extension method layer extend shall reimplement following method Method Returns Description call internally overridden class extend return correspond give callback specify call tile finish load drawing method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen represent geographical point certain latitude longitude usage example var Leaflet method accept object accept simple array form simple object form note line equivalent lat note inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description latitude longitude altitude create object represent geographical point give latitude longitude optionally altitude expect array form number number number Number Number instead expect plain object form lat Number number lat Number Number alt Number instead method Method Returns Description equal boolean return true give point position small margin error margin error overridden set small number String return string representation point debug purpose number return distance meter give calculate Spherical Law Cosines wrap return new object longitude wrap degree return new object boundary meter apart Properties Property Type Description lat Number Latitude degree Number Longitude degree alt Number altitude meter optional represent rectangular geographical area map usage example var bound Leaflet method accept object accept simple array form note bound example pass like caution area cross confused International Date Line specify corner outside degree longitude range note inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description create object define diagonally opposite corner rectangle create object define geographical point contain useful zoom map fit particular set location method Method Returns Description extend extend bound contain give point extend extend bound contain give bound pad return bound create extend retract current bound give ratio direction example ratio extend bound direction negative value retract bound return center point bound return south west point bound return north east point bound return north west point bound return south east point bound Number return west longitude bound Number return south latitude bound Number return east longitude bound Number return north latitude bound contain boolean return true rectangle contain give contain boolean return true rectangle contain give point intersect boolean return true rectangle intersect give bound bound intersect point common overlap boolean return true rectangle overlap give bound bound overlap intersection area String return string bounding box coordinate format useful send request web service return geo data equal boolean return true rectangle equivalent small margin error give bound margin error overridden set small number boolean return true bound properly initialize Point represent point coordinate pixel usage example var point Leaflet method option accept Point object accept simple array form note line equivalent note Point inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description round create point object give coordinate optional round set true round value expect array form instead expect plain object form Number Number instead method Method Returns Description clone Point return copy current point add Point Point return result addition current give point subtract Point Point return result subtraction give point current num Point return result division current point give number num Point return result multiplication current point give number point scale Point Multiply coordinate current point coordinate scale linear algebra term multiply point scaling matrix define scale point scale Point Inverse divide coordinate current point coordinate scale round Point return copy current point rounded coordinate floor Point return copy current point floor coordinate round ceil Point return copy current point ceile coordinate round Point return copy current point truncate coordinate round zero Point Number return cartesian distance current give point equal Point boolean return true give point coordinate contain point boolean return true coordinate give point correspond current point coordinate absolute value String return string representation point debug purpose Properties Property Type Description number coordinate point number coordinate point bound represent rectangular area pixel coordinate usage example var bound Leaflet method accept Bounds object accept simple array form note bound example pass like note bound inherit Leaflet Class object mean new class inherit new method add include function creation Factory Description Point point create Bounds object corner coordinate pair point create Bounds object give array point method Method Returns Description extend Point point extend bound contain give point round Point return center point bound Point return leave point bound Point return right point bound Point return leave point bound Point return right point bound Point return size give bound contain Bounds boolean return true rectangle contain give contain Point point boolean return true rectangle contain give point intersect Bounds boolean return true rectangle intersect give bound bound intersect point common overlap bound boolean return true rectangle overlap give bound bound overlap intersection area Properties Property Type Description min point leave corner rectangle max point right corner rectangle Icon represent icon provide create marker usage example var icon Default extend blue icon Leaflet use marker default creation Factory Description Icon option option create icon instance give option option Option Type Default Description String null require icon image absolute relative script path String null retina sized version icon image absolute relative script path Retina screen device point null Size icon image pixel Point null coordinate tip icon relative left corner icon align point marker geographical location center default size specify set negative margin Point coordinate point open relative icon anchor Point coordinate point open relative icon anchor string null icon shadow image specify shadow image create String null Point null Size shadow image pixel Point null coordinate tip shadow relative left corner specify String custom class assign icon shadow image default method Method return Description call internally icon show return element style accord option shadow beneath icon default trivial subclass Icon represent icon use Marker icon specify point blue marker image distribute Leaflet release order customize default icon change property set Icon option want completely replace default icon override icon instead option Type Default Description String Icon Default try auto detect location blue icon image place image non standard way set option point right path represent lightweight icon marker use simple element instead image inherit Icon ignore shadow option usage example var div icon set div icon style icon default leaflet div icon class style little white square shadow creation Factory Description option option create instance give option option Option Type Default Description Custom code inside div element default alternatively instance Point optional relative position background pixel option inherit Icon Option Type Default Description String null require icon image absolute relative script path String null retina sized version icon image absolute relative script path Retina screen device point null Size icon image pixel Point null coordinate tip icon relative left corner icon align point marker geographical location center default size specify set negative margin Point coordinate point open relative icon anchor Point coordinate point open relative icon anchor string null icon shadow image specify shadow image create String null Point null Size shadow image pixel Point null coordinate tip shadow relative left corner specify String custom class assign icon shadow image default method method inherit Icon Method Returns Description call internally icon show return element style accord option shadow beneath control zoom basic zoom control button zoom zoom map default set option false Extends Control creation Factory Description Control zoom option option create zoom control Options Option Type Default Description String text set zoom button String Zoom title set zoom button String text set zoom button String zoom title set zoom button option inherit Control Option Type Default Description position String position control map corner possible value Methods method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control attribution attribution control allow display attribution datum small text box map map default set option false fetch attribution text layer method automatically Extends Control creation Factory Description Control attribution option option create attribution control option Option Type Default Description prefix String Leaflet text show attribution pass false disable option inherit Control Option Type Default Description position String position control map corner possible value Methods Method Returns description prefix set text attribution text add attribution text Vector datum copy text remove attribution text method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control layer layer control give user ability switch different base layer switch overlay check detailed example Extends Control usage example var var overlay Marker marker road overlay parameter object literal layer name key Layer object value layer name contain allow add additional styling item Layer Creation Factory Description overlay Control layer option option create layer control give layer base layer switch radio button overlay switch note base layer pass base layer object add map map instantiation option Option Type Default Description collapse boolean true true control collapse icon expand mouse hover touch boolean true true control assign increase order layer order preserve switch boolean false true base layer control hide boolean false sort layer false layer order add control Function compare function sort layer true function receive instance name default sort layer alphabetically option inherit Control Option Type Default Description position String position control map corner possible value Methods Method Returns Description Layer layer add base layer radio button entry give control Layer layer add overlay entry give control Layer layer remove give layer control expand expand control container collapse collapse collapse control container expand method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active control scale simple scale control show scale current center screen metric imperial system Extends Control usage example Creation Factory Description Control scale option option create scale control give option option Option Type Default Description Number maximum width control pixel width set dynamically round value metric Boolean True metric scale line imperial Boolean True imperial scale line boolean false true control update date update option inherit Control Option Type Default Description position String position control map corner possible value Methods method inherit Control Method Returns Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active Browser static property browser feature detection Leaflet internally usage example browser dude Properties Property Type Description Boolean true Internet Explorer version Edge boolean true Internet Explorer version edge Boolean true Edge web browser Boolean true base browser like Chrome Safari include mobile version android Boolean true browser run Android platform Boolean true browser run Android Android boolean true Android stock browser Chrome opera Boolean true Opera browser chrome Boolean true Chrome browser gecko Boolean true gecko base browser like safari Boolean true Safari browser Boolean true Opera browser support transform version later win Boolean true browser run Windows platform boolean true Internet Explorer version support transform boolean true base browser support transform boolean true gecko base browser support transform boolean true browser support transform mobile Boolean true browser run mobile device boolean true base browser mobile device boolean true base browser mobile device support transform boolean true browser implement touch event model notably pointer Boolean true browser support pointer event touch Boolean true browser support touch event necessarily mean browser run computer mean browser capable understand touch event Boolean true Opera browser mobile device boolean true gecko base browser run mobile device retina Boolean true browser high resolution retina screen screen browser display zoom boolean true browser support passive event canvas Boolean true browser support Boolean true browser support Boolean true browser support util utility function Leaflet internally function Function Returns Description extend object merge property object multiple object object return shortcut create proto property object Compatibility bind Function return new function bind argument pass like shortcut stamp obj Number return unique object assign throttle time context Function return function execute function give scope context keyword refer context inside code function call time give time argument receive bind function argument pass bind function follow argument pass invoke bind function shortcut num range number return number num modulo range way lie return value small set true Function return function return false num digit number return number num round digit decimal decimal default trim str String Compatibility str String trim split string whitespace return array part obj option Object Merges give property option obj object return result option class option shortcut obj uppercase string convert object parameter string foo bar translate bar set parameter append end uppercase true parameter name uppercase bar template str datum String simple facility accept template string form hello data object like foo bar return evaluate string hello foo bar specify function instead string datum value evaluate pass datum argument obj Boolean Compatibility array Number Compatibility context immediate Number Schedules execute browser repaint bind context give immediate set call immediately browser native support delay return request cancel request undefine Cancels previous Properties Property Type Description Number unique stamp String Data URI string contain encode GIF image hack free memory unused image power mobile device set image string Transformation represent affine transformation set coefficient transform point form reverse Leaflet projection code usage example var transformation Creation Factory Description instantiate Transformation object give coefficient coefficient expect coefficient array form Number Number Number number method Method Returns Description transform Point point scale Point return transform point optionally multiply give scale accept actual instance array Point point scale Point return reverse transformation give point optionally divide give scale accept actual instance array utility function point processing Leaflet internally lightning fast function Function Returns Description simplify point tolerance Point Dramatically reduce number point retain shape return new array simplified point Douglas algorithm huge performance boost processing display Leaflet zoom level reduce visual noise tolerance affect simplification less value mean high quality slow point release separate micro library point Point Point number return distance point segment point Point Point number return close point point segment Point Point bound bound round clip segment rectangular bound Cohen algorithm modify segment point directly Leaflet point screen near increase performance boolean return true flat array false nest utility function polygon geometry function Function Returns Description point bound bound round point clip polygon geometry define give point give bound algorithm Leaflet polygon point screen near increase performance note polygon point need different algorithm clip separate method utility function work DOM event Leaflet internally function Function Returns Description type context add listener function particular dom event type element optionally specify context listener object keyword point pass space separate type click context add set type listener pair click type context remove previously add listener function note pass custom context pass context order remove listener context remove set type listener pair click stop give event propagation parent element inside listener function click function add element wheel event plus browser variant add element click event plus browser variant prevent default action DOM Event happen follow link element post request page reload submit use inside listener function stop time container Point get normalize mouse position dom event relative container border exclude page specify number get normalize wheel delta wheel dom event vertical pixel scroll negative scroll event point device precise scrolling map good guess pixel Alias Alias Utility function work dom tree Leaflet internally function expect return work element difference class refer class class function Function Returns Description return element give DOM return element pass directly String return value certain style attribute element include compute value value set create container create element set class optionally append container element remove Removes parent element Removes child element make child parent render child make child parent render child boolean return true element class attribute contain add element class attribute Removes element class attribute set element class String return element class opacity set opacity element include old support opacity number prop array style name return valid style element find return false useful vendor prefix style like transform Point offset scale reset transform translate offset pixel optionally scale scale effect browser support transform Point position set position coordinate specify position translate leave positioning depend browser Leaflet internally position layer Point return coordinate element previously position prevent user generate DOM event usually generate user drag mouse page text internally Leaflet override behaviour click drag interaction map affect drag interaction document cancel effect previous dom event usually generate user drag image cancel effect previous make outline element invisible internally Leaflet prevent focusable element display outline user perform drag interaction cancel effect previous find close parent node size width height null Object compute scale currently apply element return object member horizontal vertical scale respectively result Properties Property Type Description transform String Vendor prefix transform style transition String Vendor prefix transition style String Vendor prefix event internally pan animation utilize Transitions modern browser timer fallback usage example var new Constructor Constructor Description create object event Event Data Description start Event fire animation start step Event fire continuously animation end Event fire animation end method Method Returns Description run Point duration run animation give element new position optionally set duration second default ease linearity factor argument cubic curve default stop stop animation currently run method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen class make DOM element include touch support internally map marker dragging work element position usage example var new Constructor Constructor Description option option create object move start drag element equal default option Option Type Default Description number max number pixel user shift mouse pointer click consider valid click oppose mouse drag event Event Data Description Event fire drag start Event fire drag start Event fire continuously drag correspond update element position drag Event fire continuously drag fire drag end method Method Returns Description enable enable drag ability disable disable drag ability method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Class power facility Leaflet create Leaflet class document addition implement simple classical inheritance model introduce special property convenient code organization option include static usage example var initialize function greeter greeter class constructor greet function create instance pass Hello constructor var new greet method alert Hello World Class Factories notice Leaflet object create new keyword achieve complement class lowercase factory method new factory implement easily class function option return new option inheritance use define new class use method class inherit var new property method create class inherit method property parent class proper prototype chain add override one pass extend properly react var new true true parent method include constructor corresponding child one super call language access parent class prototype apply var initialize function greet function bro var new alert bro Jason option option special property unlike object pass extend merge parent instead override completely make manage configuration object default value convenient var option foo bar var option var new bar method conveniently merge option pass constructor default define class var option foo bar initialize function option option var new foo bar note option object allow key option define class base class mean use option object store application specific information long avoid key class question include include special class property merge specify object class object call var foo function bar var include var new include runtime include method static convenience property inject specify object property static property class useful define constant var static FOO bar FOO bar Constructor hook developer need add additional initialization code exist class edit hook Leaflet come way easily method constructor additionally add event listener set custom property etc use following shortcut need additional method function Function Returns Description extend prop Function extend current class give property include return function class constructor call new include property include current class option Merges option default class add constructor hook class set method share event power class like Map Marker generally event allow execute function happen object user click map cause map fire click event usage example Leaflet deal event listener reference want add listener remove define function function Methods Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Layer set method Layer base class Leaflet layer use inherit method option event usage example var layer Options Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description add Event fire layer add map remove event fire layer remove map event Event Data Description Fired bind layer open Fired bind layer close event Event Data Description Fired bind layer open Fired bind layer close method class extend inherit follow method Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option extension method layer extend follow method Method Returns Description Map map contain code create DOM element layer add map pane belong put listener relevant map event call Map map contain clean code remove layer element dom remove listener previously add call object optional method return object like event handler object automatically add remove map layer string optional method return string contain show Attribution control layer visible Map map optional method call layer add map event initialize wait map usable state use early initialization method layer share set method convenient bind var layer automatically open layer click close layer remove map open Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method layer share set method convenient bind var layer Method return Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen interactive layer Layer interactive user interact layer mouse event like click handle use event handle method handle event option Option Type Default Description interactive Boolean true false layer emit mouse event act underlying map boolean true true mouse event layer trigger event map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Mouse event Event Data Description click Fired user click tap layer Fired user double click double tap layer fire user push mouse button layer fire user release mouse button push layer Fired mouse enter layer Fired mouse leave layer Fired user right click layer prevent default browser context menu show listener event fire mobile user hold single touch second call long press event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Control base class implement map control handle positioning control extend class option Option Type Default Description position String position control map corner possible value Methods class extend inherit follow method Method return Description string return position control position set position control return contain control Map map add control give map remove remove control map currently active extension method control extend follow method Method Returns Description Map map return container dom element control add listener relevant map event call Map map optional method contain clean code remove listener previously add call Handler abstract class map interaction handler Methods Method Returns Description enable enable handler disable disable handler enable boolean return true handler enable Extension method class inherit Handler implement follow method Method return Description call handler enable add event hook call handler disabled remove event hook add previously function static function call instantiate Function Returns Description Map map add new handler give map give Projection object method project geographical coordinate world flat surface Map projection method Method Returns Description project Point Projects geographical coordinate point accept actual instance array Point point inverse project project point geographical location accept actual instance array note projection instance inherit Leaflet Class object instantiate new class inherit method add include function Properties Property Type Description bound bound bound specify CRS unit projection valid define projection Leaflet come set define Projections box Projection Description Plate Carree projection simple projection GIS enthusiast directly map longitude latitude suitable flat world game map Simple CRS Mercator Elliptical Mercator projection complex Spherical Mercator assume Earth ellipsoid CRS Spherical Mercator projection common projection online map free commercial tile provider assume Earth sphere CRS CRS Methods Method Returns Description zoom Point Projects geographical coordinate pixel coordinate give zoom Point point zoom inverse project pixel coordinate give zoom geographical coordinate project Point Projects geographical coordinate coordinate unit accept CRS meter pass service Point point give project coordinate return correspond inverse project scale zoom Number return scale transform project coordinate pixel coordinate particular zoom example return Mercator base CRS zoom scale Number Inverse scale return zoom level correspond scale factor scale zoom bounds return projection bound scale transform provide zoom distance number return distance geographical coordinate return lat wrap accord CRS property outside CRS bound bound return size give ensure center CRS bound accept actual instance array Properties Property Type Description code String Standard code CRS pass service Number array number define longitude horizontal coordinate axis wrap give range default geographical crs undefine longitude axis wrap number like latitude vertical axis infinite Boolean true coordinate space unbounded infinite axis define crs CRS Description rarely commercial tile provider use Elliptical Mercator projection common CRS online map free commercial tile provider use Spherical Mercator projection Set default Map crs option common crs gis enthusiast use simple projection Leaflet coordinate scheme break change behaviour CRS ensure pixel tile cover earth zoom level zero tile coordinate origin option set serve base CRS global cover earth base CRS directly code projection transformation distance return meter simple crs map longitude latitude directly map flat surface game map note axis invert distance return simple euclidean distance Object define coordinate reference system project geographical point pixel screen coordinate coordinate unit service spatial reference system Leaflet define usual crs default want use CRS define default look note CRS instance inherit Leaflet Class object instantiate new class inherit method add include function Renderer Base class vector renderer implementation Canvas handle DOM container renderer bound zoom animation Renderer work implicit layer group Path renderer add remove map path use renderer implicit map decide type renderer use automatically explicit renderer path renderer option path use class directly use Canvas instead option Option Type Default Description padding number extend clip area map view relative size map view direction tolerance Number extend click tolerance round path object map option inherit Layer Option Type Default Description pane string default layer add map overlay pane override option cause layer place pane default attribution String null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event Event Data Description update Event fire renderer update bound center zoom example map move event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen event object class inherit fire event listener function call event argument plain object contain information event example event object case information available depend event type event base event object event object contain property Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description original DOM trigger Leaflet event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description geographical point mouse event occur Point Pixel coordinate point mouse event occur relative map layer Point Pixel coordinate point mouse event occur relative map original DOM DOM trigger Leaflet event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description detect geographical location user bound geographical bound area user locate respect accuracy location accuracy Number Accuracy location meter altitude Number Height position ellipsoid meter Number Accuracy altitude meter head number direction travel degree count clockwise true North speed number current velocity meter second timestamp number time position acquire property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description message string Error message code Number Error code applicable property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description layer Layer layer add remove property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description layer Layer layer add remove String layer add remove property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description tile tile element image Point Point object tile zoom level coordinate property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description tile tile element image Point Point object tile zoom level coordinate error error pass tile callback property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description point old size resize event point new size resize event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description layer Layer layer feature add map property object property feature String geometry type feature String feature present property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent Property Type Description open close property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description open close property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description distance number distance pixel element move property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Property Type Description center current center map zoom number current zoom level map Boolean layer update content event property inherit Event Property Type Description type string event type click target Object object fire event propagate event object propagation chain fire event object object originally fire event non propagated event target Object propagate event object propagate event event parent layer Object Deprecated Base model Inherit custom like option Option Type Default Description offset Point offset position useful control anchor open overlay String custom class assign pane String Map pane add option inherit Layer Option Type Default Description attribution string null String show attribution control contributor describe layer datum legal obligation copyright holder tile provider event event inherit Layer Event Data Description add Event fire layer add map remove event fire layer remove map event inherit Layer Event Data Description Fired bind layer open Fired bind layer close event inherit Layer Event Data Description Fired bind layer open Fired bind layer close method method inherit Layer Method Returns Description map add layer give map layer group remove remove layer map currently active Map map remove layer give map group remove layer give return represent name pane map omit return pane layer string attribution control return attribution option method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bound specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Layer Method Returns Description content option option bind layer pass content set necessary event listener Function pass receive layer argument return string remove previously bind open bind specify default anchor pass close bind layer open open close bind layer depend current state boolean return true bind layer currently open content set content bind layer return bind layer method inherit Method return Description type context add listener function particular event type object optionally specify context listener object keyword point pass space separate type click add set type listener pair click type context remove previously add listener function function specify remove listener particular event object note pass custom context pass context order remove listener remove set type listener pair remove listener event object include implicitly attach event fire type datum propagate fire event specified type optionally provide data object argument listener function contain property event optionally propagate event parent listen type boolean return true particular event type listener attach behave listener fire remove obj add event parent receive propagate event obj remove event parent stop receive propagated event Alias Alias Alias Alias Alias fire Boolean Alias listen Global Switches Global switch create rare case generally Leaflet detect particular browser feature need set switch global variable true include Leaflet page like Switch Description Forces Leaflet use touch event detect Forces Leaflet use hardware accelerate transform positioning cause glitch rare environment support method restore global variable original value Leaflet inclusion return real Leaflet like version constant represent Leaflet version use contain version currently use