mapbox-maps-android/com.mapbox.maps.interactions/FeaturesetFeature

FeaturesetFeature

@MapboxExperimental

open class FeaturesetFeature<FS : FeatureState> @RestrictTo(value = [RestrictTo.Scope.LIBRARY]) constructor(val id: FeaturesetFeatureId?, val descriptor: TypedFeaturesetDescriptor<FS, *>, val state: FS, originalFeature: Feature)

The map interaction result object returned in the callback of:

User map interactions (ClickInteraction, LongClickInteraction).
Map query methods like MapboxMap.queryRenderedFeatures.

Constructors

FeaturesetFeature

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

fun <FS : FeatureState> FeaturesetFeature(id: FeaturesetFeatureId?, descriptor: TypedFeaturesetDescriptor<FS, *>, state: FS, originalFeature: Feature)

Functions

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

Override equals method.

open override fun hashCode(): Int

Override hashCode method.

Properties

val descriptor: TypedFeaturesetDescriptor<FS, *>

The TypedFeaturesetDescriptor this concrete feature comes from. List of supported featuresets could be found in the nested classes (e.g. TypedFeaturesetDescriptor.Featureset, TypedFeaturesetDescriptor.Layer etc).

val geometry: Geometry

Mandatory feature Geometry.

val id: FeaturesetFeatureId?

Optional identifier holding feature id and feature namespace. It could be NULL when underlying Feature.id is null.

val properties: JSONObject

The feature properties stored in JSONObject.

Current feature state stored as a concrete instance of FeatureState. Important: this state is immutable and represents the feature state at the precise moment of the interaction callback.