removeFeatureState

fun removeFeatureState(sourceId: String, sourceLayerId: String? = null, featureId: String, stateKey: String? = null, callback: FeatureStateOperationCallback): Cancelable

Removes entries from a feature state object.

Remove a specified property or all property from a feature's state object, depending on the value of stateKey.

Note that updates to feature state are asynchronous, so changes made by this method might not be immediately visible using getStateFeature.

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 removed.

stateKey

The key of the property to remove. If null, all feature's state object properties are removed.

callback

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


fun removeFeatureState(interactiveFeature: InteractiveFeature<*>, stateKey: String? = null, callback: FeatureStateOperationCallback = FeatureStateOperationCallback { }): Cancelable

Removes entries from a feature state based on interactiveFeature coming from an interaction callback.

Removes a specified property or all property from a feature's state object, depending on the value of stateKey.

Note that updates to feature state are asynchronous, so changes made by this method might not be immediately visible using getFeatureState.

Return

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

Parameters

interactiveFeature

The interactive feature coming from an interaction callback.

stateKey

The key of the property to remove. If null, all feature's state object properties are removed.

callback

The FeatureStateOperationCallback called when the operation completes or ends.


fun removeFeatureState(featuresetHolder: FeaturesetHolder<*>, featureId: String, featureNamespace: String? = null, stateKey: String?, callback: FeatureStateOperationCallback = FeatureStateOperationCallback { }): Cancelable

Removes entries from a feature state object.

Removes a specified property or all property from a feature's state object, depending on the value of stateKey.

Note that updates to feature state are asynchronous, so changes made by this method might not be immediately visible using getFeatureState.

Return

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

Parameters

featuresetHolder

FeaturesetHolder object representing either a featureset or a single layer.

featureId

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

stateKey

The key of the property to remove. If null, all feature's state object properties are removed.

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.

callback

The FeatureStateOperationCallback called when the operation completes or ends.