L.Class powers the OOP facilities of Leaflet and is used to create
almost all of the Leaflet classes documented.
Methods
public addEventListener( type: string , fn: (e: L.LeafletEvent) => void , context?: any ) : Path
Parameters
type: string
fn: (e: L.LeafletEvent) => void
context?: any optional
Returns
Path
public addEventListener( eventMap: any , context?: any ) : Path
Parameters
eventMap: any
context?: any optional
Returns
Path
public addOneTimeEventListener( type: string , fn: (e: L.LeafletEvent) => void , context?: any ) : Path
Parameters
type: string
fn: (e: L.LeafletEvent) => void
context?: any optional
Returns
Path
public addTo( map: Map ) : Path
Adds the layer to the map.
Parameters
Returns
Path
public bindPopup( html: string , options?: PopupOptions ) : Path
Binds a popup with a particular HTML content to a click on this path.
Parameters
Returns
Path
public bindPopup( el: HTMLElement , options?: PopupOptions ) : Path
Binds a popup with a particular HTML content to a click on this path.
Parameters
Returns
Path
Binds a popup with a particular HTML content to a click on this path.
Parameters
Returns
Path
public bringToBack( ) : Path
Brings the layer to the bottom of all path layers.
Returns
Path
public bringToFront( ) : Path
Brings the layer to the top of all path layers.
Returns
Path
public clearAllEventListeners( ) : Path
Returns
Path
public closePopup( ) : Path
Closes the path's bound popup if it is opened.
Returns
Path
public fire( type: string , data?: any ) : Path
Inherited from
Path .fire
Defined in leaflet.d.ts:3011
Parameters
type: string
data?: any optional
Returns
Path
public fireEvent( type: string , data?: any ) : Path
Parameters
type: string
data?: any optional
Returns
Path
public getLatLng( ) : LatLng
Returns the current geographical position of the circle.
Returns
LatLng
public getRadius( ) : number
Returns the current radius of a circle. Units are in meters.
Returns
number
public hasEventListeners( type: string ) : boolean
Parameters
Returns
boolean
public off( type: string , fn?: (e: L.LeafletEvent) => void , context?: any ) : Path
Inherited from
Path .off
Defined in leaflet.d.ts:3010
Parameters
type: string
fn?: (e: L.LeafletEvent) => void optional
context?: any optional
Returns
Path
public off( eventMap?: any , context?: any ) : Path
Inherited from
Path .off
Defined in leaflet.d.ts:3016
Parameters
eventMap?: any optional
context?: any optional
Returns
Path
public on( type: string , fn: (e: L.LeafletEvent) => void , context?: any ) : Path
Inherited from
Path .on
Defined in leaflet.d.ts:3008
Parameters
type: string
fn: (e: L.LeafletEvent) => void
context?: any optional
Returns
Path
public on( eventMap: any , context?: any ) : Path
Inherited from
Path .on
Defined in leaflet.d.ts:3015
Parameters
eventMap: any
context?: any optional
Returns
Path
public onAdd( map: Map )
Should contain code that creates DOM elements for the overlay, adds them
to map panes where they should belong and puts listeners on relevant map events.
Called on map.addLayer(layer).
Parameters
public onRemove( map: Map )
Should contain all clean up code that removes the overlay's elements from
the DOM and removes listeners previously added in onAdd. Called on map.removeLayer(layer).
Parameters
public once( type: string , fn: (e: L.LeafletEvent) => void , context?: any ) : Path
Inherited from
Path .once
Defined in leaflet.d.ts:3009
Parameters
type: string
fn: (e: L.LeafletEvent) => void
context?: any optional
Returns
Path
public openPopup( latlng?: LatLng ) : Path
Opens the popup previously bound by the bindPopup method in the given point,
or in one of the path's points if not specified.
Parameters
Returns
Path
public redraw( ) : Path
Redraws the layer. Sometimes useful after you changed the coordinates that
the path uses.
Returns
Path
public removeEventListener( type: string , fn?: (e: L.LeafletEvent) => void , context?: any ) : Path
Parameters
type: string
fn?: (e: L.LeafletEvent) => void optional
context?: any optional
Returns
Path
public removeEventListener( eventMap?: any , context?: any ) : Path
Parameters
eventMap?: any optional
context?: any optional
Returns
Path
Sets the position of a circle marker to a new location.
Parameters
Returns
CircleMarker
public setRadius( radius: number ) : CircleMarker
Sets the radius of a circle marker. Units are in pixels.
Parameters
Returns
CircleMarker
Changes the appearance of a Path based on the options in the Path options object.
Parameters
Returns
Path
public toGeoJSON( ) : any
Returns a GeoJSON representation of the circle marker (GeoJSON Point Feature).
Returns
any
public unbindPopup( ) : Path
Unbinds the popup previously bound to the path with bindPopup.
Returns
Path