navigation-ux-dash-config/com.mapbox.dash.sdk.config.api/MarkerOptions

MarkerOptions

class MarkerOptions

MarkerOptions is a class that contains all the options for a marker.

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
abstract class Image

Abstract class for the image to be used for the marker.

Link copied to clipboard
object ImageAnchor

Part of the image placed closest to the anchor.

Link copied to clipboard
object TextAnchor

Part of the text placed closest to the anchor.

Functions

Link copied to clipboard
fun withImage(image: MarkerOptions.Image): MarkerOptions

Set image to be used for the marker.

Link copied to clipboard
fun withImageAnchor(imageAnchor: String): MarkerOptions

Set image anchor to be used for the image.

Link copied to clipboard
fun withImageOffset(imageOffset: List<Double>): MarkerOptions

Set image-offset to initialise the markerOptions with.

Link copied to clipboard
fun withImageScaleFactorSize(imageScaleFactorSize: Double): MarkerOptions

Set image scale factor size to be used for the image.

Link copied to clipboard
fun withSymbolSortKey(symbolSortKey: Double): MarkerOptions

Set symbol-sort-key to initialise the markerOptions with.

Link copied to clipboard
fun withTextAnchor(textAnchor: String): MarkerOptions

Set text anchor to be used for the text.

Link copied to clipboard
fun withTextColor(@ColorInt textColor: Int): MarkerOptions
fun withTextColor(textColor: String): MarkerOptions

Set text-color to initialise the markerOptions with.

Link copied to clipboard
fun withTextField(textField: String): MarkerOptions

Set text field to be used for the marker.

Link copied to clipboard
fun withTextHaloColor(@ColorInt textHaloColor: Int): MarkerOptions
fun withTextHaloColor(textHaloColor: String): MarkerOptions

Set text-halo-color to initialise the markerOptions with.

Link copied to clipboard
fun withTextHaloWidth(textHaloWidth: Double): MarkerOptions

Set text-halo-width to initialise the markerOptions with.

Link copied to clipboard
fun withTextOffset(textOffset: List<Double>): MarkerOptions

Set text-offset to initialise the markerOptions with.

Link copied to clipboard
fun withTextSize(textSize: Double): MarkerOptions

Set text-size to initialise the markerOptions with.