Class Plan

Hierarchy

Class
- Plan

Implements

Methods

addEventListener

addEventListener(type: string, fn: function, context?: any): Plan
addEventListener(eventMap: any, context?: any): Plan

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:102
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Plan
Implementation of IEventPowered.addEventListener
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:111
Parameters
- eventMap: any
- Optional context: any
Returns Plan

addOneTimeEventListener

addOneTimeEventListener(type: string, fn: function, context?: any): Plan

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:103
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Plan

clearAllEventListeners

clearAllEventListeners(): Plan

Implementation of IEventPowered.clearAllEventListeners
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:113
Returns Plan

createGeocoders

createGeocoders(): HTMLElement

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:100
Returns HTMLElement

dragNewWaypoint

dragNewWaypoint(e: LineTouchedEvent): void

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:99
Parameters
- e: LineTouchedEvent
Returns void

fire

fire(type: string, data?: any): Plan

Implementation of IEventPowered.fire
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:110
Parameters
- type: string
- Optional data: any
Returns Plan

fireEvent

fireEvent(type: string, data?: any): Plan

Implementation of IEventPowered.fireEvent
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:106
Parameters
- type: string
- Optional data: any
Returns Plan

getWaypoints

getWaypoints(): Waypoint[]

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:96
Returns Waypoint[]

hasEventListeners

hasEventListeners(type: string): boolean

Implementation of IEventPowered.hasEventListeners
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:105
Parameters
- type: string
Returns boolean

isReady

isReady(): boolean

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:95
Returns boolean

off

off(type: string, fn?: function, context?: any): Plan
off(eventMap?: any, context?: any): Plan

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:109
Parameters
- type: string
- Optional fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Plan
Implementation of IEventPowered.off
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:115
Parameters
- Optional eventMap: any
- Optional context: any
Returns Plan

on

on(type: string, fn: function, context?: any): Plan
on(eventMap: any, context?: any): Plan

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:107
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Plan
Implementation of IEventPowered.on
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:114
Parameters
- eventMap: any
- Optional context: any
Returns Plan

onAdd

onAdd(map: Map): void

Implementation of ILayer.onAdd
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:92
Parameters
- map: Map
Returns void

onRemove

onRemove(): void

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:93
Returns void

once

once(type: string, fn: function, context?: any): Plan

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:108
Parameters
- type: string
- fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Plan

removeEventListener

removeEventListener(type: string, fn?: function, context?: any): Plan
removeEventListener(eventMap?: any, context?: any): Plan

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:104
Parameters
- type: string
- Optional fn: function
  - - (e: LeafletEvent): void
    - Parameters
      - e: LeafletEvent
      Returns void
- Optional context: any
Returns Plan
Implementation of IEventPowered.removeEventListener
- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:112
Parameters
- Optional eventMap: any
- Optional context: any
Returns Plan

setWaypoints

setWaypoints(waypoints: Waypoint[] | LatLng[]): Plan

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:97
Parameters
- waypoints: Waypoint[] | LatLng[]
Returns Plan

spliceWaypoints

spliceWaypoints(index: number, waypointsToRemove: number, ...newWaypoints: Waypoint[]): Waypoint[]

- Defined in src/typings/leaflet/leaflet-routing-machine.d.ts:98
Parameters
- index: number
- waypointsToRemove: number
- Rest ...newWaypoints: Waypoint[]
Returns Waypoint[]

Static addInitHook

addInitHook(methodName: string, ...args: any[]): void

Inherited from Class.addInitHook
- Defined in src/typings/leaflet/leaflet.d.ts:297
You can also use the following shortcut when you just need to make one additional method call.

Parameters
- methodName: string
- Rest ...args: any[]
Returns void

Static extend

extend(options: ClassExtendOptions): any

Inherited from Class.extend
- Defined in src/typings/leaflet/leaflet.d.ts:291
You use L.Class.extend to define new classes, but you can use the same method on any class to inherit from it.

Parameters
- options: ClassExtendOptions
Returns any