ArcGISFeature

An ArcGIS specific feature stored in an ArcGISFeatureTable. ArcGIS features are stored in ArcGIS specific data sources such as a GeodatabaseFeatureTable or ServiceFeatureTable. Since ArcGISFeature is a subclass of Feature, it contains a geometry that defines its location and shape, and a set of attributes that describe the real-world entity it represents.

In addition, ArcGISFeature objects can also contain:

  • Feature attachments such as images or documents, that can be edited, updated or deleted.

  • Feature subtypes that define different default values or domains for fields.

  • The ability to relate this feature to another ArcGISFeature.

  • Geometry that has m-values, which are typically used for linear referencing.

If you create a ServiceFeatureTable from the URL of a feature service, features in the table are initially in one of the following states:

  • A minimum set of attributes are available in the table, and m-values are omitted. This is an optimization for faster rendering.

  • All attributes defined by the service are available in the table, including m-values, which might be NaN.

The initial state of features is determined by the feature request mode of the table. For important details, see FeatureRequestMode.

By default, a query on ArcGISFeature objects in a minimum state returns them in the same state. To access all attributes (or the m-values) of features returned by a query, you must load the features. You can do one of the following:

For more information, see the class description for ServiceFeatureTable.

Since

200.1.0

See also

Properties

Link copied to clipboard

True if attachments on this feature can be edited, otherwise false.

Link copied to clipboard

True if the geometry of this feature can be edited, otherwise false.

Inherited properties

Link copied to clipboard
open override val attributes: MutableMap<String, Any?>

The attributes of the GeoElement as a collection of name/value pairs.

Link copied to clipboard

The FeatureTable that this feature belongs to.

Link copied to clipboard
open override var geometry: Geometry?

The geometry defines the shape and location of the GeoElement.

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Functions

Link copied to clipboard
suspend fun addAttachment(name: String, contentType: String, data: ByteArray?): Result<Attachment>

Adds a new attachment to this feature.

Link copied to clipboard
suspend fun deleteAttachment(attachment: Attachment): Result<Unit>

Deletes the given attachment from this feature.

Link copied to clipboard
suspend fun deleteAttachments(attachments: Iterable<Attachment>): Result<Unit>

Deletes the given attachments from this feature.

Link copied to clipboard

Gets a collection of attachments on this feature. Attachments are returned in descending order based on their id.

Link copied to clipboard

Gets the corresponding FeatureSubtype for this feature. If this feature belongs to an ArcGISFeatureTable that defines an ArcGISFeatureTable.subtypeField, a FeatureSubtype that matches FeatureSubtype.code with this feature's attribute value for subtype field is returned; otherwise, this will return null.

Link copied to clipboard
fun relateFeature(feature: ArcGISFeature, relationshipInfo: RelationshipInfo? = null): Result<Unit>

Sets up a relationship between this feature and the provided feature based on the given relationshipInfo if it is not null.

Link copied to clipboard

Removes the relationship between this feature and the provided feature. If there is no existing relationship between the features, an IllegalStateException is thrown.

Link copied to clipboard
suspend fun updateAttachment(attachmentInfo: Attachment, name: String, contentType: String, data: ByteArray?): Result<Unit>

Updates the given attachment of this feature.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open override fun close()
Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard

Resets the attributes and geometry to the values in the data source. Discards any in-memory changes to the Feature that have not been applied to the table, and reloads the Feature geometry and all attributes.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.