mapbox-maps-android/com.mapbox.maps/MapboxMap/setFeatureState

setFeatureState

@JvmOverloads
fun setFeatureState(sourceId: String, sourceLayerId: String? = null, featureId: String, state: Value, callback: FeatureStateOperationCallback): Cancelable

Updates the state object of a feature within a style source.

Update entries in the state object of a given feature within a style source. Only properties of the state object will be updated. A property in the feature state object that is not listed in state will retain its previous value. The properties must be paint properties, layout properties are not supported.

Note that updates to feature state are asynchronous, so changes made by this method might not be immediately visible using getStateFeature. And the corresponding source needs to be in use to ensure the feature data it contains can be successfully updated.

Return

A cancelable object that could be used to cancel the pending operation.

Parameters

sourceId

The style source identifier.

sourceLayerId

The style source layer identifier (for multi-layer sources such as vector sources).

featureId

The feature identifier of the feature whose state should be updated.

state

The state object with properties to update with their respective new values.

callback

The feature state operation callback called when the operation completes or ends.

@MapboxExperimental
@JvmOverloads
fun <IF : InteractiveFeature<FS>, FS : FeatureState> setFeatureState(interactiveFeature: IF, state: FS, callback: FeatureStateOperationCallback = FeatureStateOperationCallback { }): Cancelable

Sets the state map for given interactiveFeature coming from an interaction callback asynchronously.

Return

A Cancelable object that could be used to cancel the pending query.

Parameters

interactiveFeature

the interactive feature coming from an interaction callback.

state

describes the new state of the map for given interactiveFeature.

callback

The optional QueryFeatureStateCallback called when the query completes.

@MapboxExperimental
@JvmOverloads
fun <FS : FeatureState> setFeatureState(featuresetHolder: FeaturesetHolder<FS>, featureId: String, featureNamespace: String? = null, state: FS, callback: FeatureStateOperationCallback = FeatureStateOperationCallback { }): Cancelable

Sets the state map of a feature within a style source asynchronously.

Return

A Cancelable object that could be used to cancel the pending query.

Parameters

featuresetHolder

FeaturesetHolder object representing either a featureset or a single layer.

featureId

The feature identifier of the feature whose state should be queried.

featureNamespace

Optional feature namespace. Defaults to NULL. Namespace represents the feature namespace defined by the Selector within a featureset to which this feature belongs. If the underlying source is the same for multiple selectors within a featureset, the same featureNamespace should be used across those selectors. Defining a featureNamespace value for the Selector is recommended, especially when multiple selectors exist in a featureset, as it can enhance the efficiency of feature operations.

state

describes the new state of the map for given feature.

callback

The optional QueryFeatureStateCallback called when the query completes.