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

Types

Component
Link copied to clipboard
data class Component(type: String, node: ComponentNode)
A simplified data structure representing an individual component inside BannerComponents
ComponentNode
Link copied to clipboard
interface ComponentNode
A generic type of BannerComponents
DelimiterComponentNode
Link copied to clipboard
class DelimiterComponentNode : ComponentNode
ComponentNode of the type BannerComponents.DELIMITER
ExitComponentNode
Link copied to clipboard
class ExitComponentNode : ComponentNode
ComponentNode of the type BannerComponents.EXIT
ExitNumberComponentNode
Link copied to clipboard
class ExitNumberComponentNode : ComponentNode
ComponentNode of the type BannerComponents.EXIT_NUMBER
Lane
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.
LaneFactory
Link copied to clipboard
object LaneFactory
A factory exposed to build a Lane object.
LaneIcon
Link copied to clipboard
class LaneIcon
Data structure that holds a styleable drawable resource.
LaneIconError
Link copied to clipboard
class LaneIconError
Represents an error value for an lane icon request.
LaneIconResources
Link copied to clipboard
class LaneIconResources
A class that allows you to define your own turn lane icons to be rendered.
LaneIndicator
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": "" }A simplified data structure containing BannerComponents.active and list of BannerComponents.directions.
Maneuver
Link copied to clipboard
class Maneuver
Data structure that holds information about a maneuver.
ManeuverError
Link copied to clipboard
class ManeuverError
Represents an error value for maneuver updates.
ManeuverErrorFactory
Link copied to clipboard
object ManeuverErrorFactory
A factory exposed to build a ManeuverError object.
ManeuverExitOptions
Link copied to clipboard
class ManeuverExitOptions
Specifies options for styling MapboxExitText.
ManeuverFactory
Link copied to clipboard
object ManeuverFactory
A factory exposed to build a Maneuver object.
ManeuverOptions
Link copied to clipboard
class ManeuverOptions
Specifies options for parsing Maneuver data in the MapboxManeuverApi.
ManeuverPrimaryOptions
Link copied to clipboard
class ManeuverPrimaryOptions
Specifies options for styling MapboxPrimaryManeuver.
ManeuverSecondaryOptions
Link copied to clipboard
class ManeuverSecondaryOptions
Specifies options for styling MapboxSecondaryManeuver.
ManeuverSubOptions
Link copied to clipboard
class ManeuverSubOptions
Specifies options for styling MapboxSubManeuver.
ManeuverViewOptions
Link copied to clipboard
class ManeuverViewOptions
Specifies options for rendering different components in a Maneuver.
MapboxExitProperties
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.
PrimaryManeuver
Link copied to clipboard
class PrimaryManeuver
"primary": { "components": { "imageBaseURL": "https://mapbox-navigation-shields...
PrimaryManeuverFactory
Link copied to clipboard
object PrimaryManeuverFactory
A factory exposed to build a PrimaryManeuver object.
RoadShield
Link copied to clipboard
data class RoadShield(shieldUrl: String, shieldIcon: ByteArray)
Data structure that holds information about road shield.
RoadShieldComponentNode
Link copied to clipboard
class RoadShieldComponentNode : ComponentNode
ComponentNode of the type BannerComponents.ICON
RoadShieldError
Link copied to clipboard
data class RoadShieldError
Data structure that holds information about any error fetching a road shield.
SecondaryManeuver
Link copied to clipboard
class SecondaryManeuver
"secondary": { "components": { "imageBaseURL": "https://mapbox-navigation-shields...
SecondaryManeuverFactory
Link copied to clipboard
object SecondaryManeuverFactory
A factory exposed to build a SecondaryManeuver object.
StepDistance
Link copied to clipboard
class StepDistance
Data structure representing distance associated with the step.
SubManeuver
Link copied to clipboard
class SubManeuver
"sub": { "components": { "imageBaseURL": "https://mapbox-navigation-shields...
SubManeuverFactory
Link copied to clipboard
object SubManeuverFactory
A factory exposed to build SubManeuver object.
TextComponentNode
Link copied to clipboard
class TextComponentNode : ComponentNode
ComponentNode of the type BannerComponents.TEXT
TurnIconError
Link copied to clipboard
class TurnIconError
Represents an error case when obtaining turn icon data
TurnIconResources
Link copied to clipboard
class TurnIconResources
A class that allows you to define your own maneuver icons to be rendered.

Functions

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