mapbox-maps-android/com.mapbox.maps.interactions.standard.generated/StandardPlaceLabelsState

StandardPlaceLabelsState

class StandardPlaceLabelsState : FeatureState

Typed feature state class needed for generic MapboxMap.setFeatureState and MapboxMap.getFeatureState when working with StandardPlaceLabels in Mapbox Standard Style.

Types

Builder

class Builder : FeatureState.Builder

Builder class to build StandardPlaceLabelsState.

Functions

asJsonString

fun asJsonString(): String

Return state as a JSON string.

equals

open operator override fun equals(other: Any?): Boolean

Override equals method.

getBooleanState

fun getBooleanState(stateName: String): Boolean?

Returns the state value for stateName if it exists and is a Boolean or can be coerced to a Boolean, or NULL otherwise.

getDoubleState

fun getDoubleState(stateName: String): Double?

Returns the state value for stateName if it exists and is a Double or can be coerced to a Double, or NULL otherwise.

getLongState

fun getLongState(stateName: String): Long?

Returns the state value for stateName if it exists and is a Long or can be coerced to a Long, or NULL otherwise.

getStringState

fun getStringState(stateName: String): String?

Returns the state value for stateName if it exists and is a String or can be coerced to a String, or NULL otherwise.

hashCode

open override fun hashCode(): Int

Override hashCode method.

toString

open override fun toString(): String

Override toString method.

Properties

hide

val hide: Boolean?

When true, hides the label. Use this state when displaying a custom annotation on top.

highlight

val highlight: Boolean?

When true, the feature is highlighted. Use this state to create a temporary effect (e.g. hover).

select

val select: Boolean?

When true, the feature is selected. Use this state to create a permanent effect. Note: the select state has a higher priority than highlight.