Class Plan

User interface to edit the plan for a route (an ordered list of waypoints). Implements Layer.

Hierarchy

Layer
- Plan

Index

Constructors

Properties

Methods

createGeocoder createGeocoders dragNewWaypoint fireChanged focusGeocoder getWaypoints hookWaypointEvents isReady onAdd onRemove removeMarkers setWaypoints spliceWaypoints updateGeocoders updateMarkers

Constructors

constructor

new Plan(waypoints: (Waypoint | LatLng)[], options?: PlanOptions): Plan
Parameters
- waypoints: (Waypoint | LatLng)[]
- Optional options: PlanOptions
Returns Plan
Overrides L.Layer.constructor
- Defined in plan.ts:96

Properties

options

options: PlanOptions

Methods

createGeocoder

createGeocoder(waypointIndex: number): GeocoderElement
Parameters
- waypointIndex: number
Returns GeocoderElement
- Defined in plan.ts:193

createGeocoders

createGeocoders(): HTMLDivElement
Creates and returns an HTML widget with geocoder input fields for editing waypoints by address

Returns HTMLDivElement
- Defined in plan.ts:164

dragNewWaypoint

dragNewWaypoint(e: LineTouchedEvent): void
Parameters
- e: LineTouchedEvent
Returns void
- Defined in plan.ts:328

fireChanged

fireChanged(startIndex?: number, deleteCount?: number, ...newWaypoints: Waypoint[]): void
Parameters
- Optional startIndex: number
- Optional deleteCount: number
- Rest ...newWaypoints: Waypoint[]
Returns void
- Defined in plan.ts:269

focusGeocoder

focusGeocoder(index: number): void
Parameters
- index: number
Returns void
- Defined in plan.ts:393

getWaypoints

getWaypoints(): Waypoint[]
Returns the plan’s waypoints

Returns Waypoint[]
- Defined in plan.ts:121

hookWaypointEvents

hookWaypointEvents(marker: Marker<any>, waypointIndex: number, trackMouseMove?: boolean): void
Parameters
- marker: Marker<any>
- waypointIndex: number
- trackMouseMove: boolean = false
Returns void
- Defined in plan.ts:281

isReady

isReady(): boolean
Returns true if the plan is ready to be routed, meaning it has at least a start and end waypoint, and both have coordinates

Returns boolean
- Defined in plan.ts:111

onAdd

onAdd(map: Map): Plan
Parameters
- map: Map
Returns Plan
Overrides L.Layer.onAdd
- Defined in plan.ts:148

onRemove

onRemove(): Plan
Returns Plan
Overrides L.Layer.onRemove
- Defined in plan.ts:155

removeMarkers

removeMarkers(): void
Returns void
- Defined in plan.ts:235

setWaypoints

setWaypoints(waypoints: Waypoint[]): Plan
Sets the plan’s waypoints
Parameters
- waypoints: Waypoint[]
Returns Plan
- Defined in plan.ts:128

spliceWaypoints

spliceWaypoints(startIndex: number, deleteCount?: number, ...newWaypoints: Waypoint[]): void
Allows adding, removing or replacing the plan’s waypoints. Syntax is the same as in Array#splice
Parameters
- startIndex: number
- deleteCount: number = 0
- Rest ...newWaypoints: Waypoint[]
Returns void
- Defined in plan.ts:136

updateGeocoders

updateGeocoders(): void
Returns void
- Defined in plan.ts:220

updateMarkers

updateMarkers(): void
Returns void
- Defined in plan.ts:245

Generated using TypeDoc