Package com.mapbox.navigation.ui.maneuver.model

Types

Link copied to clipboard
data 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
class DelimiterComponentNode : ComponentNode

ComponentNode of the type BannerComponents.DELIMITER

Link copied to clipboard
class ExitComponentNode : ComponentNode

ComponentNode of the type BannerComponents.EXIT

Link copied to clipboard
class ExitNumberComponentNode : ComponentNode

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
object LaneFactory

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
class LaneIconError

Represents an error value for an lane icon request.

Link copied to clipboard
class LaneIconResources

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

Link copied to clipboard
class LaneIndicator

"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
class ManeuverError

Represents an error value for maneuver updates.

Link copied to clipboard
object ManeuverErrorFactory

A factory exposed to build a ManeuverError object.

Link copied to clipboard
class ManeuverExitOptions

Specifies options for styling MapboxExitText.

Link copied to clipboard
object ManeuverFactory

A factory exposed to build a Maneuver object.

Link copied to clipboard
class ManeuverOptions

Specifies options for parsing Maneuver data in the MapboxManeuverApi.

Link copied to clipboard
class ManeuverPrimaryOptions

Specifies options for styling MapboxPrimaryManeuver.

Link copied to clipboard
class ManeuverSecondaryOptions

Specifies options for styling MapboxSecondaryManeuver.

Link copied to clipboard
class ManeuverSubOptions

Specifies options for styling MapboxSubManeuver.

Link copied to clipboard
class ManeuverViewOptions

Specifies options for rendering different components in a Maneuver.

Link copied to clipboard
sealed class MapboxExitProperties

A class that allows you to define various properties you wish to use to render for ExitComponentNode of a given PrimaryManeuver, SecondaryManeuver or SubManeuver. The priority of fallback is in the order:

Link copied to clipboard
class PrimaryManeuver

"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
object PrimaryManeuverFactory

A factory exposed to build a PrimaryManeuver object.

Link copied to clipboard
data class RoadShield(val shieldUrl: String, var shieldIcon: ByteArray)

Data structure that holds information about road shield.

Link copied to clipboard
class RoadShieldComponentNode : ComponentNode

ComponentNode of the type BannerComponents.ICON

Link copied to clipboard
data class RoadShieldError

Data structure that holds information about any error fetching a road shield.

Link copied to clipboard
class SecondaryManeuver

"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
object SecondaryManeuverFactory

A factory exposed to build a SecondaryManeuver object.

Link copied to clipboard
class StepDistance

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
class SubManeuver

"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
object SubManeuverFactory

A factory exposed to build SubManeuver object.

Link copied to clipboard
class TextComponentNode : ComponentNode

ComponentNode of the type BannerComponents.TEXT

Link copied to clipboard
class TurnIconError

Represents an error case when obtaining turn icon data

Link copied to clipboard
class TurnIconResources : BaseTurnIconResources

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

Functions

Link copied to clipboard
fun RoadShield.toRouteShield(): RouteShield

Extension function to convert RoadShield to RouteShield