Class: RouteInstruction

new RouteInstruction()

routeInstruction class

Source: gemapi.js, line 2863

Extends

Em_Object

Methods

delete()

calls emscripten object destructor

Inherited From: Em_Object#delete
Source: gemapi.js, line 186

getAbstractGeometryImage(bitmapContainer, backgroundColor, foregroundColor)

Parameters:

Name	Type	Description
`bitmapContainer`	*	output bitmap
`backgroundColor`	*	background color
`foregroundColor`	*	foreground color

Source: gemapi.js, line 2958

getCoordinates() → {gem.core.Coordinates}

Get Coordinates

Source: gemapi.js, line 2894

Returns:

Type:: gem.core.Coordinates

getCountryCodeISO() → {string}

Get Country Code ISO

Source: gemapi.js, line 2901

Returns:

Type:: string

getFollowRoadInstruction() → {string}

Get textual description for the follow road information.

Source: gemapi.js, line 2886

Returns:

Type:: string

getRawPointer() → {object}

Returns emscripten object

Inherited From: Em_Object#getRawPointer
Source: gemapi.js, line 198

Returns:

Type:: object

getRealisticNextTurnImage(bitmapContainer)

Get image for the realistic turn information.

Parameters:

Name	Type	Description
`bitmapContainer`	gem.core.BitmapContainer	output bitmap. This object will be modified by this method.

Source: gemapi.js, line 2928

getRemainingTravelTimeDistance() → {gem.core.TimeAndDistance}

Get remaining travel distance in meters and remaining traveling time in seconds.

Source: gemapi.js, line 2907

Returns:

Type:: gem.core.TimeAndDistance

getTimeDistanceToNextTurn() → {gem.core.TimeAndDistance}

Gets distance to the next turn in meters, time in seconds.

Source: gemapi.js, line 2914

Returns:

Type:: gem.core.TimeAndDistance

getTraveledTimeDistance() → {gem.core.TimeAndDistance}

Get the traveled distance in meters and the traveled time in seconds.

Source: gemapi.js, line 2921

Returns:

Type:: gem.core.TimeAndDistance

getTurnImageInBitmap(bitmapContainer)

Get the turn image in a bitmap

Parameters:

Name	Type	Description
`bitmapContainer`	gem.core.BitmapContainer	output bitmap

Source: gemapi.js, line 2879

getTurnInstructionString() → {string}

Get turn instruction as text

Source: gemapi.js, line 2872

Returns:

Type:: string

hasFollowRoadInfo() → {boolean}

Check if follow road information is available.

Source: gemapi.js, line 2935

Returns:

Type:: boolean

hasSignpostInfo() → {boolean}

Check if signpost information is available.

Source: gemapi.js, line 2949

Returns:

Type:: boolean

hasTurnInfo() → {boolean}

Checks if turn information is available.

Source: gemapi.js, line 2942

Returns:

Type:: boolean

isDeleted() → {boolean}

Check if emscripten object has been deleted

Inherited From: Em_Object#isDeleted
Source: gemapi.js, line 192

Returns:

Type:: boolean

toEVRouteInstruction() → {gem.routesAndNavigation.EVRouteInstruction}

Converts the current route instruction to an Electric Vehicle route instruction.

Source: gemapi.js, line 2972

Returns:

The converted Electric Vehicle route instruction.

Type:: gem.routesAndNavigation.EVRouteInstruction

toPTRouteInstruction() → {object}

Converts the current route instruction to a Public Transit route instruction.

Source: gemapi.js, line 2965

Returns:

The converted Public Transit route instruction.

Type:: object