Class default

The main class responsible for all the user interaction and for the routing itself.

Hierarchy

MapLibreGlDirectionsEvented
- default

Index

Constructors

constructor

Accessors

hoverable interactive snaplines snappointsCoordinates waypoints waypointsBearings waypointsCoordinates

Constructors

constructor

new default(
map: Map$1,
configuration?: Partial<MapLibreGlDirectionsConfiguration>,
): default
Parameters
- map: Map$1
- Optionalconfiguration: Partial<MapLibreGlDirectionsConfiguration>
Returns default
Overrides MapLibreGlDirectionsEvented.constructor
- Defined in src/directions/main.ts:24

Properties

`Protected`_hoverable

_hoverable: boolean = false

`Protected`_interactive

_interactive: boolean = false

`Protected`_waypoints

_waypoints: Feature<Point, GeoJsonProperties>[] = []

abortController

abortController: AbortController | undefined

A publicly-available abort-controller that allows to manually abort an ongoing routing-request.

Only exists (!== undefined) when there's an ongoing routing-request.

Example

direсtions.abortController.abort();

allowRouteSwitch

allowRouteSwitch: boolean = false

Allows user to switch to alternative routes while in non-interactive mode. Only takes effect when hoverable is true.

`Protected`buildPoint

buildPoint: (
    coordinate: [number, number],
    type: string,
    properties?: Record<string, unknown>,
) => Feature<Point> = buildPoint

Type Declaration

- (
      coordinate: [number, number],
      type: string,
      properties?: Record<string, unknown>,
  ): Feature<Point>
- Protected
  Creates a |GeoJSON Point Feature of one of the $known types with a given coordinate.
  Parameters
  - coordinate: [number, number]
  - type: string
  - Optionalproperties: Record<string, unknown>
  Returns Feature<Point>

`Protected`buildRequest

buildRequest: (
    configuration: MapLibreGlDirectionsConfiguration,
    waypointsCoordinates: [number, number][],
    waypointsBearings?: ([number, number] | undefined)[],
) => RequestData = buildRequest

Type Declaration

- (
      configuration: MapLibreGlDirectionsConfiguration,
      waypointsCoordinates: [number, number][],
      waypointsBearings?: ([number, number] | undefined)[],
  ): RequestData
- Protected
  Builds the routing-request method, URL and payload based on the provided configuration and the waypoints' coordinates.
  Parameters
  - configuration: MapLibreGlDirectionsConfiguration
  - waypointsCoordinates: [number, number][]
  - OptionalwaypointsBearings: ([number, number] | undefined)[]
  Returns RequestData

`Protected`buildRoutelines

buildRoutelines: (
    requestOptions: Partial<Record<string, string>>,
    routes: Route[],
    selectedRouteIndex: number,
    snappoints: Feature<Point, GeoJsonProperties>[],
) => Feature<LineString, GeoJsonProperties>[][] = buildRoutelines

Type Declaration

- (
      requestOptions: Partial<Record<string, string>>,
      routes: Route[],
      selectedRouteIndex: number,
      snappoints: Feature<Point, GeoJsonProperties>[],
  ): Feature<LineString, GeoJsonProperties>[][]
- Protected
  Creates route lines from the server response.
  
  Each route line is an array of legs, where each leg is an array of segments. A segment is a |GeoJSON LineString Feature. Route legs are divided into segments by their congestion levels. If there's no congestions, each route leg consists of a single segment.
  Parameters
  - requestOptions: Partial<Record<string, string>>
  - routes: Route[]
  - selectedRouteIndex: number
  - snappoints: Feature<Point, GeoJsonProperties>[]
  Returns Feature<LineString, GeoJsonProperties>[][]

`Protected`buildSnaplines

buildSnaplines: (
    waypointsCoordinates: [number, number][],
    snappointsCoordinates: [number, number][],
    hoverpointCoordinates: [number, number] | undefined,
    departSnappointIndex: number,
    showHoverpointSnaplines?: boolean,
) => Feature<LineString, GeoJsonProperties>[] = buildSnaplines

Type Declaration

- (
      waypointsCoordinates: [number, number][],
      snappointsCoordinates: [number, number][],
      hoverpointCoordinates: [number, number] | undefined,
      departSnappointIndex: number,
      showHoverpointSnaplines?: boolean,
  ): Feature<LineString, GeoJsonProperties>[]
- Protected
  Creates a $|GeoJSON LineString Features array where each feature represents a line connecting a waypoint with its respective snappoint and the hoverpoint with its respective snappoints.
  Parameters
  - waypointsCoordinates: [number, number][]
  - snappointsCoordinates: [number, number][]
  - hoverpointCoordinates: [number, number] | undefined
  - departSnappointIndex: number
  - showHoverpointSnaplines: boolean = false
  Returns Feature<LineString, GeoJsonProperties>[]

`Protected` `Readonly`configuration

configuration: MapLibreGlDirectionsConfiguration

`Protected`currentMousePosition

currentMousePosition: { x: number; y: number } = ...

`Protected`departSnappointIndex

departSnappointIndex: number = -1

`Protected`dragDownPosition

dragDownPosition: { x: number; y: number } = ...

`Protected`highlightedSnappoints

highlightedSnappoints: Feature<Point, GeoJsonProperties>[] = []

`Protected`highlightedWaypoints

highlightedWaypoints: Feature<Point, GeoJsonProperties>[] = []

`Protected`hoverpoint

hoverpoint: Feature<Point, GeoJsonProperties> | undefined = undefined

`Protected`lastRequestMousePosition

lastRequestMousePosition: { x: number; y: number } = ...

`Protected`liveRefreshHandler

liveRefreshHandler: (e: MapMouseEvent | MapTouchEvent) => void

`Protected` `Readonly`map

map: Map$1

`Protected` `Optional`noMouseMovementTimer

noMouseMovementTimer?: number

`Protected`onClickHandler

onClickHandler: (e: MapMouseEvent | MapTouchEvent) => void

`Protected`onDragDownHandler

onDragDownHandler: (e: MapMouseEvent | MapTouchEvent) => void

`Protected`onDragMoveHandler

onDragMoveHandler: (e: MapMouseEvent | MapTouchEvent) => void

`Protected`onDragUpHandler

onDragUpHandler: (e: MapMouseEvent | MapTouchEvent) => void

`Protected`onMoveHandler

onMoveHandler: (e: MapMouseEvent | MapTouchEvent) => void

`Protected`profiles

profiles: string[] = []

`Protected`refreshOnMoveIsRefreshing

refreshOnMoveIsRefreshing: boolean = false

`Protected`routelines

routelines: Feature<LineString, GeoJsonProperties>[][] = []

`Protected`selectedRouteIndex

selectedRouteIndex: number = 0

`Protected`snappoints

snappoints: Feature<Point, GeoJsonProperties>[] = []

`Protected` `Optional`waypointBeingDragged

waypointBeingDragged?: Feature<Point, GeoJsonProperties>

`Protected` `Optional`waypointBeingDraggedInitialCoordinates

waypointBeingDraggedInitialCoordinates?: [number, number]

Accessors

hoverable

get hoverable(): boolean
Allows hover effects in non-interactive mode. Can be set to true while interactive is false for the features to be highlighted when hovered over by the user. Does nothing when interactive is true.

Returns boolean
- Defined in src/directions/main.ts:1017
set hoverable(hoverable: boolean): void
Parameters
- hoverable: boolean
Returns void
- Defined in src/directions/main.ts:1021

interactive

get interactive(): boolean
The interactivity state of the instance. When true, the user is allowed to interact with the features drawn on the map and to add waypoints by clicking the map. Automatically set to false whenever there's an ongoing routing request.

Returns boolean
- Defined in src/directions/main.ts:978
set interactive(interactive: boolean): void
Parameters
- interactive: boolean
Returns void
- Defined in src/directions/main.ts:982

`Protected`snaplines

get snaplines(): Feature<LineString, GeoJsonProperties>[]
Returns Feature<LineString, GeoJsonProperties>[]
- Defined in src/directions/main.ts:87

`Protected`snappointsCoordinates

get snappointsCoordinates(): [number, number][]
Returns [number, number][]
- Defined in src/directions/main.ts:81

waypoints

get waypoints(): [number, number][]
Returns all the waypoints' coordinates in the order they appear.

Returns [number, number][]
- Defined in src/directions/main.ts:1042
set waypoints(waypoints: [number, number][]): void
Parameters
- waypoints: [number, number][]
Returns void

Alias
Synchronous analogue of setWaypoints.
- Defined in src/directions/main.ts:1049

waypointsBearings

get waypointsBearings(): ([number, number] | undefined)[]
Returns all the waypoints' bearings values or an empty array if the bearings configuration option is not enabled.

Returns ([number, number] | undefined)[]
- Defined in src/directions/main.ts:1057
set waypointsBearings(bearings: ([number, number] | undefined)[]): void
Sets the waypoints' bearings values. Does not produce any effect in case the bearings configuration option is disabled.
Parameters
- bearings: ([number, number] | undefined)[]
Returns void
- Defined in src/directions/main.ts:1072

`Protected`waypointsCoordinates

get waypointsCoordinates(): [number, number][]
Returns [number, number][]

Alias
waypoints

Aliased for the sakes of naming-consistency.
- Defined in src/directions/main.ts:77

Methods

`Protected`_addWaypoint

_addWaypoint(
    waypoint: [number, number],
    index?: number,
    originalEvent?: MapMouseEvent | MapTouchEvent,
): Promise<void>
Parameters
- waypoint: [number, number]
- Optionalindex: number
- OptionaloriginalEvent: MapMouseEvent | MapTouchEvent
Returns Promise<void>
- Defined in src/directions/main.ts:894

`Protected`_removeWaypoint

_removeWaypoint(
index: number,
originalEvent?: MapMouseEvent | MapTouchEvent,
): Promise<void>
Parameters
- index: number
- OptionaloriginalEvent: MapMouseEvent | MapTouchEvent
Returns Promise<void>
- Defined in src/directions/main.ts:940

addWaypoint

addWaypoint(waypoint: [number, number], index?: number): Promise<void>
Adds a waypoint at the specified coordinates to the map and re-fetches the routes.
Parameters
- waypoint: [number, number]
  The coordinates at which the waypoint should be added
- Optionalindex: number
  The index the waypoint should be inserted at. If omitted, the waypoint is inserted at the end
Returns Promise<void>
Resolved after the routing request has finished
- Defined in src/directions/main.ts:1155

`Protected`assignWaypointsCategories

assignWaypointsCategories(): void
Returns void
- Defined in src/directions/main.ts:883

clear

clear(): void
Clears the map from all the instance's traces: waypoints, snappoints, routes, etc.

Returns void
- Defined in src/directions/main.ts:1184

`Protected`deHighlight

deHighlight(): void
Returns void
- Defined in src/directions/main.ts:299

destroy

destroy(): void
Removes all the added MapLibreGlDirections-specific layers and sources. Must be called manually before de-initializing the instance.

Returns void
- Defined in src/directions/main.ts:1193

`Protected`draw

draw(skipSelectedRouteRedraw?: boolean): void
Parameters
- skipSelectedRouteRedraw: boolean = true
Returns void
- Defined in src/directions/main.ts:256

`Protected`fetch

fetch(__namedParameters: RequestData): Promise<Directions>
Parameters
- __namedParameters: RequestData
Returns Promise<Directions>
- Defined in src/directions/main.ts:111

`Protected`fetchDirections

fetchDirections(originalEvent: AnyMapLibreGlDirectionsEvent): Promise<void>
Parameters
- originalEvent: AnyMapLibreGlDirectionsEvent
Returns Promise<void>
- Defined in src/directions/main.ts:130

`Protected`fire

fire<T extends keyof MapLibreGlDirectionsEventType>(
event: MapLibreGlDirectionsEventType[T],
): boolean
Fires an event and notifies all listeners.
Type Parameters
- T extends keyof MapLibreGlDirectionsEventType
Parameters
- event: MapLibreGlDirectionsEventType[T]
  The event object to fire.
Returns boolean
false if the event's preventDefault() method was called, true otherwise.
Inherited from MapLibreGlDirectionsEvented.fire
- Defined in src/directions/events.ts:23

`Protected`init

init(): void
Returns void
- Defined in src/directions/main.ts:97

`Protected`liveRefresh

liveRefresh(e: MapMouseEvent | MapTouchEvent): Promise<void>
Parameters
- e: MapMouseEvent | MapTouchEvent
Returns Promise<void>
- Defined in src/directions/main.ts:783

off

off<T extends keyof MapLibreGlDirectionsEventType>(
type: T,
listener: MapLibreGlDirectionsEventListener<T>,
): default
Un-registers an event listener.
Type Parameters
- T extends keyof MapLibreGlDirectionsEventType
Parameters
- type: T
  The event type.
- listener: MapLibreGlDirectionsEventListener<T>
  The listener function to remove.
Returns default
this for method chaining.
Inherited from MapLibreGlDirectionsEvented.off
- Defined in src/directions/events.ts:75

on

on<T extends keyof MapLibreGlDirectionsEventType>(
type: T,
listener: MapLibreGlDirectionsEventListener<T>,
): default
Registers an event listener.
Type Parameters
- T extends keyof MapLibreGlDirectionsEventType
Parameters
- type: T
  The event type to listen for.
- listener: MapLibreGlDirectionsEventListener<T>
  The listener function.
Returns default
this for method chaining.
Inherited from MapLibreGlDirectionsEvented.on
- Defined in src/directions/events.ts:61

once

once<T extends keyof MapLibreGlDirectionsEventType>(
type: T,
listener: MapLibreGlDirectionsEventListener<T>,
): default
Registers an event listener to be invoked only once.
Type Parameters
- T extends keyof MapLibreGlDirectionsEventType
Parameters
- type: T
  The event type to listen for.
- listener: MapLibreGlDirectionsEventListener<T>
  The listener function.
Returns default
this for method chaining.
Inherited from MapLibreGlDirectionsEvented.once
- Defined in src/directions/events.ts:91

removeWaypoint

removeWaypoint(index: number): Promise<void>
Removes a waypoint and its related snappoint by the waypoint's index from the map and re-fetches the routes.
Parameters
- index: number
  The index of the waypoint to remove
Returns Promise<void>
Resolved after the routing request has finished
- Defined in src/directions/main.ts:1165

setWaypoints

setWaypoints(waypoints: [number, number][], profiles?: string[]): Promise<void>
Replaces all the waypoints with the specified ones and re-fetches the routes.
Parameters
- waypoints: [number, number][]
  The coordinates at which the waypoints should be added
- profiles: string[] = []
  Profiles for fetching directions between waypoints.
Returns Promise<void>
Resolved after the routing request has finished
- Defined in src/directions/main.ts:1103

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

Protected_hoverable

Protected_interactive

Protected_waypoints

abortController

Example

allowRouteSwitch

ProtectedbuildPoint

Type Declaration

Parameters

Returns Feature<Point>

ProtectedbuildRequest

Type Declaration

Parameters

Returns RequestData

ProtectedbuildRoutelines

Type Declaration

Parameters

Returns Feature<LineString, GeoJsonProperties>[][]

ProtectedbuildSnaplines

Type Declaration

Parameters

Returns Feature<LineString, GeoJsonProperties>[]

Protected Readonlyconfiguration

ProtectedcurrentMousePosition

ProtecteddepartSnappointIndex

ProtecteddragDownPosition

ProtectedhighlightedSnappoints

ProtectedhighlightedWaypoints

Protectedhoverpoint

ProtectedlastRequestMousePosition

ProtectedliveRefreshHandler

Protected Readonlymap

Protected OptionalnoMouseMovementTimer

ProtectedonClickHandler

ProtectedonDragDownHandler

ProtectedonDragMoveHandler

ProtectedonDragUpHandler

ProtectedonMoveHandler

Protectedprofiles

ProtectedrefreshOnMoveIsRefreshing

Protectedroutelines

ProtectedselectedRouteIndex

Protectedsnappoints

Protected OptionalwaypointBeingDragged

Protected OptionalwaypointBeingDraggedInitialCoordinates

Accessors

hoverable

Returns boolean

Parameters

Returns void

interactive

Returns boolean

Parameters

Returns void

Protectedsnaplines

Returns Feature<LineString, GeoJsonProperties>[]

ProtectedsnappointsCoordinates

Returns [number, number][]

waypoints

Returns [number, number][]

Parameters

Returns void

Alias

waypointsBearings

Returns ([number, number] | undefined)[]

Parameters

Returns void

ProtectedwaypointsCoordinates

`Protected`_hoverable

`Protected`_interactive

`Protected`_waypoints

`Protected`buildPoint

`Protected`buildRequest

`Protected`buildRoutelines

`Protected`buildSnaplines

`Protected` `Readonly`configuration

`Protected`currentMousePosition

`Protected`departSnappointIndex

`Protected`dragDownPosition

`Protected`highlightedSnappoints

`Protected`highlightedWaypoints

`Protected`hoverpoint

`Protected`lastRequestMousePosition

`Protected`liveRefreshHandler

`Protected` `Readonly`map

`Protected` `Optional`noMouseMovementTimer

`Protected`onClickHandler

`Protected`onDragDownHandler

`Protected`onDragMoveHandler

`Protected`onDragUpHandler

`Protected`onMoveHandler

`Protected`profiles

`Protected`refreshOnMoveIsRefreshing

`Protected`routelines

`Protected`selectedRouteIndex

`Protected`snappoints

`Protected` `Optional`waypointBeingDragged

`Protected` `Optional`waypointBeingDraggedInitialCoordinates

`Protected`snaplines

`Protected`snappointsCoordinates

`Protected`waypointsCoordinates

`Protected`_addWaypoint

`Protected`_removeWaypoint

`Protected`assignWaypointsCategories

`Protected`deHighlight

`Protected`draw

`Protected`fetch

`Protected`fetchDirections

`Protected`fire

`Protected`init

`Protected`liveRefresh

`Protected`onClick

`Protected`onDragDown

`Protected`onDragMove

`Protected`onDragUp

`Protected`onMove