Class Route

Hierarchy

RouteBase
- Route

Constructors

constructor

new Route(id: number, mapId: number): Route
Parameters
- id: number
- mapId: number
Returns Route
Overrides RouteBase.constructor
- Defined in core/route.ts:1266

Properties

`Protected`_mapId

_mapId: number

`Protected`_pointerId

_pointerId: any

Accessors

dominantRoads

get dominantRoads(): string[]
Returns string[]
Inherited from RouteBase.dominantRoads
- Defined in core/route.ts:988

geographicArea

get geographicArea(): RectangleGeographicArea
Returns RectangleGeographicArea
Inherited from RouteBase.geographicArea
- Defined in core/route.ts:998

hasFerryConnections

get hasFerryConnections(): boolean
Returns boolean
Inherited from RouteBase.hasFerryConnections
- Defined in core/route.ts:1192

hasTollRoads

get hasTollRoads(): boolean
Returns boolean
Inherited from RouteBase.hasTollRoads
- Defined in core/route.ts:1202

incursCosts

get incursCosts(): boolean
Returns boolean
Inherited from RouteBase.incursCosts
- Defined in core/route.ts:1008

isEVRoute

get isEVRoute(): boolean
Check if route is an Electric Vehicle Route.

Returns boolean
True if the route is an EV route, false otherwise.
- Defined in core/route.ts:1286

isPTRoute

get isPTRoute(): boolean
Check if route is a Public Transport Route.

Returns boolean
True if the route is a PT route, false otherwise.
- Defined in core/route.ts:1299

pointerId

get pointerId(): any
Returns any
Inherited from RouteBase.pointerId
- Defined in core/route.ts:928

polygonGeographicArea

get polygonGeographicArea(): PolygonGeographicArea
Returns PolygonGeographicArea
Inherited from RouteBase.polygonGeographicArea
- Defined in core/route.ts:1033

preferences

get preferences(): RoutePreferences
Returns RoutePreferences
Inherited from RouteBase.preferences
- Defined in core/route.ts:1046

routeListener

get routeListener(): RouteListener | null
Returns RouteListener | null
Inherited from RouteBase.routeListener
- Defined in core/route.ts:1242
set routeListener(routeListener: RouteListener | null): void
Parameters
- routeListener: RouteListener | null
Returns void
Inherited from RouteBase.routeListener
- Defined in core/route.ts:1222

segments

get segments(): RouteSegment[]
Returns RouteSegment[]
Inherited from RouteBase.segments
- Defined in core/route.ts:1056

status

get status(): RouteStatus
Returns RouteStatus
Inherited from RouteBase.status
- Defined in core/route.ts:1066

summary

get summary(): string
Returns string
Inherited from RouteBase.summary
- Defined in core/route.ts:1076

terrainProfile

get terrainProfile(): RouteTerrainProfile | null
Returns RouteTerrainProfile | null
Inherited from RouteBase.terrainProfile
- Defined in core/route.ts:1086

tilesGeographicArea

get tilesGeographicArea(): TilesCollectionGeographicArea
Returns TilesCollectionGeographicArea
Inherited from RouteBase.tilesGeographicArea
- Defined in core/route.ts:1212

trafficEvents

get trafficEvents(): RouteTrafficEvent[]
Returns RouteTrafficEvent[]
Inherited from RouteBase.trafficEvents
- Defined in core/route.ts:1155

Methods

clearRouteListener

clearRouteListener(): void
Returns void
Inherited from RouteBase.clearRouteListener
- Defined in core/route.ts:1238

dispose

dispose(): void
Returns void
- Defined in core/route.ts:1326

equals

equals(route: Route): boolean
Parameters
- route: Route
Returns boolean
- Defined in core/route.ts:1270

exportAs

exportAs(format: PathFileFormat): string
Parameters
- format: PathFileFormat
Returns string
Inherited from RouteBase.exportAs
- Defined in core/route.ts:940

getClosestSegment

getClosestSegment(coord: Coordinates): number
Parameters
- coord: Coordinates
Returns number
Inherited from RouteBase.getClosestSegment
- Defined in core/route.ts:955

getCoordinateOnRoute

getCoordinateOnRoute(distance: number): Coordinates
Parameters
- distance: number
Returns Coordinates
Inherited from RouteBase.getCoordinateOnRoute
- Defined in core/route.ts:966

getDistanceOnRoute

getDistanceOnRoute(coords: Coordinates, activePart: boolean): number
Parameters
- coords: Coordinates
- activePart: boolean
Returns number
Inherited from RouteBase.getDistanceOnRoute
- Defined in core/route.ts:977

getPath

getPath(start: number, end: number): Path | null
Parameters
- start: number
- end: number
Returns Path | null
Inherited from RouteBase.getPath
- Defined in core/route.ts:1018

getTimeDistance

getTimeDistance(activePart?: boolean): TimeDistance
Parameters
- activePart: boolean = true
Returns TimeDistance
Inherited from RouteBase.getTimeDistance
- Defined in core/route.ts:1100

getTimeDistanceCoordinateOnRoute

getTimeDistanceCoordinateOnRoute(
coordinates: Coordinates,
): TimeDistanceCoordinate
Parameters
- coordinates: Coordinates
Returns TimeDistanceCoordinate
Inherited from RouteBase.getTimeDistanceCoordinateOnRoute
- Defined in core/route.ts:1140

getTimeDistanceCoordinates

getTimeDistanceCoordinates(
    __namedParameters: {
        end: number;
        start: number;
        step: number;
        stepType: StepType;
    },
): TimeDistanceCoordinate[]
Parameters
- __namedParameters: { end: number; start: number; step: number; stepType: StepType }
Returns TimeDistanceCoordinate[]
Inherited from RouteBase.getTimeDistanceCoordinates
- Defined in core/route.ts:1111

getWaypoints

getWaypoints(waypointsOptions?: GetWaypointsOptions): Landmark[]
Parameters
- waypointsOptions: GetWaypointsOptions = GetWaypointsOptions.remainingInitial
Returns Landmark[]
Inherited from RouteBase.getWaypoints
- Defined in core/route.ts:1168

getWaypointsVia

getWaypointsVia(landmark: Landmark): Landmark[]
Parameters
- landmark: Landmark
Returns Landmark[]
Inherited from RouteBase.getWaypointsVia
- Defined in core/route.ts:1181

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from RouteBase.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:14

toPTRoute

toPTRoute(): PTRoute | null
Convert this Route to a PTRoute if it is a public transport route.

Returns PTRoute | null
PTRoute object if the route is a public transport route, null otherwise.
- Defined in core/route.ts:1313