maplibre-navigation-core/org.maplibre.navigation.core.models/BannerText

BannerText

@Serializable

data class BannerText(val text: String, val components: List<BannerComponents>? = null, val type: StepManeuver.Type? = null, val modifier: ManeuverModifier.Type? = null, val degrees: Double? = null, val drivingSide: String? = null)

Includes both plain text information that can be visualized inside your navigation application along with the text string broken down into BannerComponents which may or may not include a image url. To receive this information, your request must have MapboxDirections.Builder#bannerInstructions() set to true.

Since

3.0.0

Constructors

BannerText

constructor(text: String, components: List<BannerComponents>? = null, type: StepManeuver.Type? = null, modifier: ManeuverModifier.Type? = null, degrees: Double? = null, drivingSide: String? = null)

Types

Builder

class Builder(text: String)

Builder class for creating BannerText instances.

Properties

components

val components: List<BannerComponents>? = null

A part or element of the BannerInstructions.

degrees

val degrees: Double? = null

The degrees at which you will be exiting a roundabout, assuming 180 indicates going straight through the roundabout.

drivingSide

@SerialName(value = "driving_side")

val drivingSide: String? = null

A string representing which side the of the street people drive on in that location. Can be 'left' or 'right'.

modifier

val modifier: ManeuverModifier.Type? = null

This indicates the mode of the maneuver. If type is of turn, the modifier indicates the change in direction accomplished through the turn. If the type is of depart/arrive, the modifier indicates the position of waypoint from the current direction of travel.

text

val text: String

Plain text with all the BannerComponents text combined.

type

val type: StepManeuver.Type? = null

This indicates the type of maneuver.

Functions

toBuilder

fun toBuilder(): BannerText.Builder

Creates a builder initialized with the current values of the BannerText instance.