Package-level declarations

Types

Link copied to clipboard
class Component(val type: String, val node: ComponentNode)

A simplified data structure representing an individual component inside BannerComponents

Link copied to clipboard
interface ComponentNode

A generic type of BannerComponents

Link copied to clipboard

ComponentNode of the type BannerComponents.DELIMITER

Link copied to clipboard

ComponentNode of the type BannerComponents.EXIT

Link copied to clipboard

ComponentNode of the type BannerComponents.EXIT_NUMBER

Link copied to clipboard
class Lane

A simplified data structure that holds all the possible lanes for upcoming lane guidance and the active direction pointing to which lane to take.

Link copied to clipboard

A factory exposed to build a Lane object.

Link copied to clipboard
class LaneIcon

Data structure that holds a styleable drawable resource.

Link copied to clipboard

A class that allows you to define your own turn lane icons to be rendered.

Link copied to clipboard

"sub": { "components": [ { "active_direction": "left", "active": true, "directions": "left" , "type": "lane", "text": "" }, { "active": false, "directions": "left" , "type": "lane", "text": "" } ], "text": "" }

Link copied to clipboard
class Maneuver

Data structure that holds information about a maneuver.

Link copied to clipboard

Represents an error value for maneuver updates.

Link copied to clipboard

A factory exposed to build a ManeuverError object.

Link copied to clipboard

A factory exposed to build a Maneuver object.

Link copied to clipboard

Specifies options for parsing Maneuver data in the MapboxManeuverApi.

Link copied to clipboard

"primary": { "components": { "imageBaseURL": "https://mapbox-navigation-shields...", "type": "icon", "text": "CA 262" }, { "type": "delimiter", "text": "/" }, { "type": "text", "text": "Mission Boulevard" } , "type": "turn", "modifier": "uturn", "text": "CA 262 / Mission Boulevard" }

Link copied to clipboard

A factory exposed to build a PrimaryManeuver object.

Link copied to clipboard

ComponentNode of the type BannerComponents.ICON

Link copied to clipboard

"secondary": { "components": { "imageBaseURL": "https://mapbox-navigation-shields...", "type": "icon", "text": "CA 262" }, { "type": "delimiter", "text": "/" }, { "type": "text", "text": "Mission Boulevard" } , "type": "turn", "modifier": "uturn", "text": "CA 262 / Mission Boulevard" }

Link copied to clipboard

A factory exposed to build a SecondaryManeuver object.

Link copied to clipboard

Data structure representing distance associated with the step. Can be either distance remaining to finish the step or total step distance.

Link copied to clipboard

A factory exposed to build StepDistance object.

Link copied to clipboard

"sub": { "components": { "imageBaseURL": "https://mapbox-navigation-shields...", "type": "icon", "text": "CA 262" }, { "type": "delimiter", "text": "/" }, { "type": "text", "text": "Mission Boulevard" } , "type": "turn", "modifier": "uturn", "text": "CA 262 / Mission Boulevard" }

Link copied to clipboard

A factory exposed to build SubManeuver object.

Link copied to clipboard

ComponentNode of the type BannerComponents.TEXT

Link copied to clipboard

Represents an error case when obtaining turn icon data

Link copied to clipboard

A class that allows you to define your own maneuver icons to be rendered.