Route - @magiclane/maps-sdk API Reference

Route class

Signature:

export declare class Route extends RouteBase

Extends: RouteBase

Constructor	Modifiers	Description
(constructor)(id, mapId)		Constructs a new instance of the `Route` class

Property	Modifiers	Type	Description
extraInfo		SearchableParameterList	Get extra metadata attached to the route.
isEVRoute	`readonly`	boolean	Check if route is an Electric Vehicle Route.
isOTRoute	`readonly`	boolean	Check if route is an Over-Track Route.
isPTRoute	`readonly`	boolean	Check if route is a Public Transport Route.
tollSections	`readonly`	any[]	Get toll sections of the route.

Method	Modifiers	Description
dispose()
equals(route)		Checks whether this route is equal to another route. Compares this route's internal representation with another Route instance.
toOTRoute()		Convert this Route to an OTRoute if it is an over-track route.
toPTRoute()		Convert this Route to a PTRoute if it is a public transport route.