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

MarkerOptions

constructor()

Types

Image

abstract class Image

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

ImageAnchor

object ImageAnchor

Part of the image placed closest to the anchor.

TextAnchor

object TextAnchor

Part of the text placed closest to the anchor.

Functions

toPointAnnotationOptions

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

fun MarkerOptions.toPointAnnotationOptions(): PointAnnotationOptions

withImage

fun withImage(image: MarkerOptions.Image): MarkerOptions

Set image to be used for the marker.

withImageAnchor

fun withImageAnchor(imageAnchor: String): MarkerOptions

Set image anchor to be used for the image.

withImageOffset

fun withImageOffset(imageOffset: List<Double>): MarkerOptions

Set image-offset to initialise the markerOptions with.

withImageScaleFactorSize

fun withImageScaleFactorSize(imageScaleFactorSize: Double): MarkerOptions

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

withSymbolSortKey

fun withSymbolSortKey(symbolSortKey: Double): MarkerOptions

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

withTextAnchor

fun withTextAnchor(textAnchor: String): MarkerOptions

Set text anchor to be used for the text.

withTextColor

fun withTextColor(@ColorInt textColor: Int): MarkerOptions

fun withTextColor(textColor: String): MarkerOptions

Set text-color to initialise the markerOptions with.

withTextField

fun withTextField(textField: String): MarkerOptions

Set text field to be used for the marker.

withTextHaloColor

fun withTextHaloColor(@ColorInt textHaloColor: Int): MarkerOptions

fun withTextHaloColor(textHaloColor: String): MarkerOptions

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

withTextHaloWidth

fun withTextHaloWidth(textHaloWidth: Double): MarkerOptions

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

withTextOffset

fun withTextOffset(textOffset: List<Double>): MarkerOptions

Set text-offset to initialise the markerOptions with.

withTextSize

fun withTextSize(textSize: Double): MarkerOptions

Set text-size to initialise the markerOptions with.