NavigationInstruction - @magiclane/maps-sdk API Reference

NavigationInstruction class

Signature:

export declare class NavigationInstruction extends GemAutoreleaseObject

Extends: GemAutoreleaseObject

Property	Modifiers	Type
currentCountryCodeISO	`readonly`	string
currentPosition	`readonly`	GemPosition \| null
currentRoadInformation	`readonly`	RoadInfo[]
currentStreetName	`readonly`	string
currentStreetSpeedLimit	`readonly`	number
driveSide	`readonly`	DriveSide
hasNextNextTurnInfo	`readonly`	boolean
hasNextTurnInfo	`readonly`	boolean
hasSignpostInfo	`readonly`	boolean
instructionIndex	`readonly`	number
laneImg	`readonly`	LaneImg
mapId	`readonly`	number
navigationRoute	`readonly`	Route
navigationStatus	`readonly`	NavigationStatus
nextCountryCodeISO	`readonly`	string
nextInstruction	`readonly`	RouteInstruction \| null
nextNextInstruction	`readonly`	RouteInstruction \| null
nextNextRoadInformation	`readonly`	RoadInfo[]
nextNextStreetName	`readonly`	string
nextNextTurnDetails	`readonly`	TurnDetails
nextNextTurnImg	`readonly`	Img
nextNextTurnInstruction	`readonly`	string
nextRoadInformation	`readonly`	RoadInfo[]
nextStreetName	`readonly`	string
nextTurnDetails	`readonly`	TurnDetails
nextTurnImg	`readonly`	Img
nextTurnInstruction	`readonly`	string
pointerId	`readonly`	number \| bigint
previousInstruction	`readonly`	RouteInstruction \| null
remainingTravelTimeDistance	`readonly`	TimeDistance
remainingTravelTimeDistanceToNextWaypoint	`readonly`	TimeDistance
returnToRoutePosition	`readonly`	Coordinates \| null
segmentIndex	`readonly`	number
signpostDetails	`readonly`	SignpostDetails
signpostInstruction	`readonly`	string
timeDistanceToNextNextTurn	`readonly`	TimeDistance
timeDistanceToNextTurn	`readonly`	TimeDistance
traveledTimeDistance	`readonly`	TimeDistance

Method	Modifiers	Description
dispose()
exportAs(fileFormat)
getImage(options)
getLaneImage(options)
getNextNextTurnImage(options)
getNextSpeedLimitVariation(checkDistance)
getNextTurnImage(options)
getRoadInfoImg(info)
init(id, mapId)	`static`