removeFeatureState

suspend fun MapboxMap.removeFeatureState(sourceId: String, sourceLayerId: String? = null, featureId: String, stateKey: String? = null): Expected<String, None>

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

None or a string describing an error.

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.