Class Line

Displays a route on the map, and allows adding new waypoints by dragging the line. Extends LayerGroup.

Hierarchy

LayerGroup
- Line

Index

Constructors

Properties

Methods

addSegment extendToWaypoints findClosestRoutePoint findNearestWaypointBefore findWaypointIndices getBounds getWaypointIndices onLineTouched

Constructors

constructor

new Line(route: IRoute, options?: LineOptions): Line
Parameters
- route: IRoute
- Optional options: LineOptions
Returns Line
Overrides L.LayerGroup.constructor
- Defined in line.ts:66

Properties

options

options: LineOptions

Methods

addSegment

addSegment(coords: LatLng[], styles: PathOptions[], mouselistener?: boolean): void
Parameters
- coords: LatLng[]
- styles: PathOptions[]
- Optional mouselistener: boolean
Returns void
- Defined in line.ts:136

extendToWaypoints

extendToWaypoints(): void
Returns void
- Defined in line.ts:116

findClosestRoutePoint

findClosestRoutePoint(latlng: LatLng): number
Parameters
- latlng: LatLng
Returns number
- Defined in line.ts:99

findNearestWaypointBefore

findNearestWaypointBefore(index: number): number
Parameters
- index: number
Returns number
- Defined in line.ts:146

findWaypointIndices

findWaypointIndices(): number[]
Returns number[]
- Defined in line.ts:93

getBounds

getBounds(): LatLngBounds
Returns the bounds of the line

Returns LatLngBounds
- Defined in line.ts:89

getWaypointIndices

getWaypointIndices(): number[]
Returns number[]
- Defined in line.ts:165

onLineTouched

onLineTouched(e: LeafletMouseEvent): void
Parameters
- e: LeafletMouseEvent
Returns void
- Defined in line.ts:156

Generated using TypeDoc