RouteInstructionBase - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > RouteInstructionBase

RouteInstructionBase class

Signature:

export declare class RouteInstructionBase extends GemAutoreleaseObject

Extends: GemAutoreleaseObject

Constructors

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

Properties

Property	Modifiers	Type	Description
_pointerId	`protected`	number \| bigint
coordinates	`readonly`	Coordinates
countryCodeISO	`readonly`	string
exitDetails	`readonly`	string	Get the exit route instruction text.
followRoadInstruction	`readonly`	string	Get textual description for the follow road information.
hasFollowRoadInfo	`readonly`	boolean	Check if follow road information is available.
hasRoadInfo	`readonly`	boolean	Check if road information is available.
hasSignpostInfo	`readonly`	boolean	Check if signpost information is available.
hasTurnInfo	`readonly`	boolean	Check if turn information is available.
isCommon	`readonly`	boolean	Check if this instruction is of common type.
isExit	`readonly`	boolean	Check if the route instruction is a main road exit instruction.
isFerry	`readonly`	boolean	Check if the route instruction is a ferry.
isTollRoad	`readonly`	boolean	Check if the route instruction is a toll road.
mapId	`protected`	number
pointerId	`readonly`	number \| bigint
realisticNextTurnImg	`readonly`	AbstractGeometryImg	Get the image of the realistic next turn image
remainingTravelTimeDistance	`readonly`	TimeDistance	Get remaining travel distance in meters and remaining travel time in seconds.
remainingTravelTimeDistanceToNextWaypoint	`readonly`	TimeDistance	Get remaining travel time and distance to the next waypoint.
roadInfo	`readonly`	RoadInfo[]	Get road information.
roadInfoImg	`readonly`	RoadInfoImg	Get the image of the road info
signpostDetails	`readonly`	SignpostDetails	Get extended signpost details.
signpostInstruction	`readonly`	string	Get textual description for the signpost information.
timeDistanceToNextTurn	`readonly`	TimeDistance	Get distance to the next turn in meters, time in seconds.
traveledTimeDistance	`readonly`	TimeDistance	Get the traveled distance and time.
turnDetails	`readonly`	TurnDetails	Get full details for the turn.
turnImg	`readonly`	Img	Get the turn image
turnInstruction	`readonly`	string	Get textual description for the turn.

Methods

Method	Modifiers	Description
getRealisticNextTurnImage({ size, format, renderSettings, allowResize, }, input)		Get image for the realistic turn information.
getRoadInfoImage({ size, format, backgroundColor, allowResize, }, input)		Get road image.
getTurnImage({ size, format, allowResize }, input)		Get turn image.