MapMatchingOptions

class MapMatchingOptions

Represents options for Mapbox Map Matching API

Parameters

coordinates

A semicolon-separated list of {longitude},{latitude} coordinate pairs to visit in order.

profile

A Mapbox Directions routing profile ID, see DirectionsCriteria.ProfileCriteria

waypoints

A semicolon-separated list indicating which input coordinates should be treated as waypoints.

baseUrl

Base url for the request

radiuses

defines radius in meters to snap to the road network.

timestamps

A list of timestamps corresponding to each coordinate.

annotations

list of MapMatchingAnnotations to request.

language

defines language for turn-by-turn text instructions.

bannerInstructions

defines whether to return banner instructions associated with the route steps.

roundaboutExits

defines whether to emit instructions at roundabout exits.

voiceInstructions

defines whether to return SSML marked-up text for voice guidance along the route.

tidy

defines whether to remove clusters and re-samples traces for improved map matching results.

waypointNames

will be used for the arrival instruction in banners and voice instructions.

ignore

defines defines certain routing restrictions to ignore when map matching.

openlrSpec

defines the logical format for OpenLR encoded coordinates.

openlrFormat

defines binary format for OpenLR encoded coordinates.

Types

Link copied to clipboard
class Builder

Builds a new MapMatchingOptions

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Compares if options are the same

Link copied to clipboard
open override fun hashCode(): Int

Returns a hash code value for the object.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of the object.

Properties

Link copied to clipboard
val annotations: List<String>?
Link copied to clipboard
val bannerInstructions: Boolean?
Link copied to clipboard
val baseUrl: String
Link copied to clipboard
val coordinates: String
Link copied to clipboard
val ignore: List<String>?
Link copied to clipboard
val language: String?
Link copied to clipboard
val openlrFormat: String?
Link copied to clipboard
val openlrSpec: String?
Link copied to clipboard
val profile: String
Link copied to clipboard
val radiuses: List<Double?>?
Link copied to clipboard
val roundaboutExits: Boolean?
Link copied to clipboard
val tidy: Boolean?
Link copied to clipboard
val timestamps: List<Int>?
Link copied to clipboard
val voiceInstructions: Boolean?
Link copied to clipboard
val waypointNames: List<String?>?
Link copied to clipboard
val waypoints: List<Int>?