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

BannerInstructions

@Serializable

data class BannerInstructions(val distanceAlongGeometry: Double, val primary: BannerText, val secondary: BannerText? = null, val sub: BannerText? = null, val view: BannerView? = null)

Visual instruction information related to a particular LegStep useful for making UI elements inside your application such as banners. To receive this information, your request must MapboxDirections.Builder#bannerInstructions() have set to true.

Since

3.0.0

Constructors

BannerInstructions

constructor(distanceAlongGeometry: Double, primary: BannerText, secondary: BannerText? = null, sub: BannerText? = null, view: BannerView? = null)

Types

Builder

class Builder(distanceAlongGeometry: Double, primary: BannerText)

Builder class for creating BannerInstructions instances.

Properties

distanceAlongGeometry

val distanceAlongGeometry: Double

Distance in meters from the beginning of the step at which the visual instruction should be visible.

primary

val primary: BannerText

A plain text representation stored inside a BannerText object.

secondary

val secondary: BannerText? = null

Ancillary visual information about the LegStep.

sub

val sub: BannerText? = null

Additional information that is included if we feel the driver needs a heads up about something. Can include information about the next maneuver (the one after the upcoming one), if the step is short - can be null, or can be lane information. If we have lane information, that trumps information about the next maneuver.

view

val view: BannerView? = null

Optional image to display for an upcoming maneuver. Used to provide a visual for complex junctions and maneuver. If the step is short the image should be displayed for the duration of the step, otherwise it is shown as you approach the maneuver.

Functions

toBuilder

fun toBuilder(): BannerInstructions.Builder

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