ArcGISFeatureTable

A table of features that typically represent real-world objects created from an ArcGIS feature service or an ArcGIS geodatabase. This is the base class for the ArcGIS specific feature tables GeodatabaseFeatureTable and ServiceFeatureTable. You can create instances of these subclasses using their constructors.

If the FeatureTable.hasGeometry is true, you can display the features in an com.arcgismaps.mapping.ArcGISMap or com.arcgismaps.mapping.ArcGISScene. To do this create a com.arcgismaps.mapping.layers.FeatureLayer from the feature table and add it to the map or scene's collection of operational layers (com.arcgismaps.mapping.GeoModel.operationalLayers). The ArcGISFeatureTable can also contain features that do not have a geometry (FeatureTable.hasGeometry is false).

ArcGISFeatureTable provides methods for querying related features (for example, ArcGISFeatureTable.queryRelatedFeaturesAsync(ArcGISFeature)), and methods to create new features based on a FeatureSubtype or a FeatureTemplate.

Since

200.1.0

Inheritors

Properties

Link copied to clipboard

The table's contingent values definition. The contingent values definition must be loaded after the table has loaded. If the list of field groups is empty after loading, then no contingent values are defined for this table.

Link copied to clipboard

The table's default subtype code.

Link copied to clipboard

A list of editable fields.

Link copied to clipboard

The table's feature subtypes.

Link copied to clipboard

A list of the feature templates on this table.

Link copied to clipboard

The feature types for this table.

Link copied to clipboard

The global id field name.

Link copied to clipboard

True if the features in this table support attachments, false otherwise.

Link copied to clipboard

The service information related to the feature layer. Explore the editing capabilities of this feature table with com.arcgismaps.arcgisservices.ArcGISFeatureLayerInfo.capabilities or the editor tracked fields with com.arcgismaps.arcgisservices.ArcGISFeatureLayerInfo.editFieldsInfo.

Link copied to clipboard

The object id field name.

Link copied to clipboard

The layer ID in the feature service that this table was created from.

Link copied to clipboard

The table's subtype field.

Link copied to clipboard

The type id field name.

Link copied to clipboard

Unknown data from the source JSON. Unknown JSON is a dictionary of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.

Link copied to clipboard

Unsupported data from the source JSON. Unsupported JSON is a dictionary of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.

Link copied to clipboard

True if the table is using advanced symbology, false otherwise.

Link copied to clipboard

The username of the feature table. The username is used for ownership-based access control (OBAC) and editor tracking purposes.

Inherited properties

Link copied to clipboard

A user-friendly name that can be displayed in the UI (for example, in a Table of Contents). If the table is displayed with a com.arcgismaps.mapping.layers.FeatureLayer, the FeatureTable.displayName is used as the com.arcgismaps.mapping.layers.FeatureLayer.name.

Link copied to clipboard

The geographic extent of features within the table. This is calculated differently for specific types and modes of feature tables:

Link copied to clipboard

Defines the user interface to display when editing a feature in this layer or table. This is null if an error occurs or if the table does not have an associated feature form definition.

Link copied to clipboard
open val fields: List<Field>

The collection of Field objects representing the fields of the feature table.

Link copied to clipboard

The type of geometry of the features stored in this table. If FeatureTable.hasGeometry is false, then the geometry type is com.arcgismaps.geometry.GeometryType.Unknown.

Link copied to clipboard

True if the feature table supports geographic features, false otherwise.

Link copied to clipboard

True if the feature table supports geometries with M values, false otherwise.

Link copied to clipboard

True if the feature table supports geometries with Z values, false otherwise.

Link copied to clipboard

True if this feature table is editable, false otherwise. Underlying file permissions (for subclasses such as ShapefileFeatureTable and GeodatabaseFeatureTable) can be changed while the feature table is open. In these cases the value of this property may not be accurate.

Link copied to clipboard
open override var isPopupEnabled: Boolean

A flag indicating whether the PopupDefinition defined on the PopupSource is enable / disable. Will return false if an error occurs.

Link copied to clipboard
val layer: Layer?

The layer that displays this table, if any. The com.arcgismaps.mapping.layers.Layer type depends on how the feature table is created. For example, a com.arcgismaps.mapping.layers.Layer will be an com.arcgismaps.mapping.layers.AnnotationLayer if the FeatureTable is created from a table that supports annotation. See com.arcgismaps.mapping.layers.Layer for more information about the supported layer types.

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

The load status.

Link copied to clipboard

The number of features in the table. If all the features are stored in the local table, for example with a GeodatabaseFeatureTable or a ShapefileFeatureTable, then the FeatureTable.numberOfFeatures will return the full number of features.

Link copied to clipboard
open override var popupDefinition: PopupDefinition?

The pop-up definition. The PopupDefinition associated with the popup source. A null if an error occurs or if the popup source is not associated with a pop-up definition.

Link copied to clipboard

The spatial reference of the table. A spatial reference defines how the coordinates of a feature's com.arcgismaps.geometry.Geometry correspond to locations in the real world. For more information, see the com.arcgismaps.geometry.SpatialReference class or the Spatial references documentation.

Link copied to clipboard

The name of the table in the source dataset.

Functions

Link copied to clipboard
fun createFeature(featureSubtype: FeatureSubtype, geometry: Geometry? = null): ArcGISFeature

Creates a new feature based on the provided feature subtype and geometry.

fun createFeature(featureTemplate: FeatureTemplate, geometry: Geometry? = null): ArcGISFeature

Creates a new feature based on the provided feature template and geometry.

fun createFeature(featureType: FeatureType, geometry: Geometry? = null): ArcGISFeature

Creates a new feature based on the provided feature type and geometry.

Link copied to clipboard

Returns the features added since the last sync. For mobile geodatabases created by ArcGIS Pro, this method returns no features because there is no concept of syncing.

Link copied to clipboard

Returns the number of features added since the last sync. For mobile geodatabases created by ArcGIS Pro, this method returns 0 because there is no concept of syncing.

Link copied to clipboard

Returns possible values for the specified field, in the context of defined contingencies. This method iterates over all the field groups that the input field participates in. For each, it looks at the input feature's field values for the other fields participating in that field group. Contingencies that are satisfied by the other fields are identified, and their values for the input field are aggregated. These are returned in a ContingentValuesResult, which contains a dictionary of field group names to an array of ContingentValue objects accessed via ContingentValuesResult.byFieldGroup, specifying possible values for the input field that will satisfy a contingency in that field group. If the feature participates in multiple field groups and there are values that will satisfy all groups, they will be returned by ContingentValuesResult.allGroups.

Link copied to clipboard

Returns the features deleted since the last sync. For mobile geodatabases created by ArcGIS Pro, this method returns no features because there is no concept of syncing.

Link copied to clipboard

Returns the number of features deleted since the last sync. For mobile geodatabases created by ArcGIS Pro, this method returns 0 because there is no concept of syncing.

Link copied to clipboard

Searches for the feature template with the given name.

Link copied to clipboard

Searches for the feature type with the given name.

Link copied to clipboard

Returns all the features that were added, updated or deleted since the last sync. Returns a result object containing a feature edit iterator. For mobile geodatabase created by ArcGIS Pro, the iterator in the result object is empty because there is no concept of syncing.

Link copied to clipboard

Returns the number of features that were added, updated or deleted since the last sync. For mobile geodatabases created by ArcGIS Pro, this method returns a count of 0 because there is no concept of syncing.

Link copied to clipboard

Returns a list of all related tables that have been added to the map. Only returns tables that have been added to the map that this table is associated with.

Link copied to clipboard

Returns the features updated since the last sync. For mobile geodatabases created by ArcGIS Pro, this method returns no features because there is no concept of syncing.

Link copied to clipboard

Returns the number of features updated since the last sync. For mobile geodatabases created by ArcGIS Pro, this method returns 0 because there is no concept of syncing.

Link copied to clipboard

Checks whether the feature table has local edits. For ServiceFeatureTable, local edits are edits that have not yet been applied to the feature service. For GeodatabaseFeatureTable, local edits are edits that have been made since the last acknowledged upload. For mobile geodatabases created by ArcGIS Pro, this method returns false because there is no concept of uploading or applying edits. For mobile geodatabases, use GeodatabaseFeatureTable.hasLocalEditsSince.

Link copied to clipboard
suspend fun queryRelatedFeatureCount(feature: ArcGISFeature, parameters: RelatedQueryParameters? = null): Result<Long>

Performs a query that returns the number of related features to supplied feature based on the parameters.

Link copied to clipboard

Queries for related features of a given feature in a specific relationship. The origin and all destination tables must be associated with the same map, either as a feature source for a layer or added to the map via its table collection. Otherwise, the query will return no results.

Link copied to clipboard

Returns list of tables related by the given relationship info. Only returns tables that have been added to the map. If there are multiple instances of the related table on the map, all such instances will be returned.

Link copied to clipboard

Returns an array of contingency constraint violations based on the input feature. An empty array indicates that all contingencies associated with the feature are valid.

Link copied to clipboard

Validates constraints for a given feature participating in a relationship. The following are considered violations:

Inherited functions

Link copied to clipboard
suspend fun addFeature(feature: Feature): Result<Unit>

Adds a feature to the table. Adding a feature that contains a com.arcgismaps.geometry.Geometry causes the geometry to become simplified. This may change a single part geometry to a multipart geometry, or round off X, Y, Z, and M coordinate values that are above the resolution set by the com.arcgismaps.geometry.SpatialReference.

Link copied to clipboard
suspend fun addFeatures(features: Iterable<Feature>): Result<Unit>

Adds a collection of features to the table.

Link copied to clipboard

Determines whether you can add new features to the table. Although this method may state that the table allows new features to be added, the application may not be licensed to permit this. For example, a user cannot add features to a secured feature table if the application is licensed at the Lite level (com.arcgismaps.LicenseLevel.Lite).

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
fun canDelete(feature: Feature): Boolean

Determines whether you can delete the feature from the table. Although this method may state that the table allows the feature to be deleted, the application may not be licensed to permit this. For example, a user cannot delete features from a secured feature table if the application is licensed at the Lite level (com.arcgismaps.LicenseLevel.Lite).

Link copied to clipboard

Determines whether you can edit the geometry field in a table. Although this method may state that the table allows geometry fields to be edited, the application may not be licensed to permit this. For example, a user cannot update geometry in a secured feature table if the application is licensed at the Lite level (com.arcgismaps.LicenseLevel.Lite).

Link copied to clipboard
fun canUpdate(feature: Feature): Boolean

Determines whether you can update the feature in the table. Although this method may state that the table allows the feature to be updated, the application may not be licensed to permit this. For example, a user cannot update features in a secured feature table if the application is licensed at the Lite level (com.arcgismaps.LicenseLevel.Lite).

Link copied to clipboard

Creates a new empty feature. The new feature is only available in memory at this point. Execute FeatureTable.addFeature to commit the new Feature to the table.

fun createFeature(attributes: Map<String, Any?>, geometry: Geometry?): Feature

Creates a new feature with the provided attribute values and, optionally, geometry. The new feature is only available in memory at this point. Execute FeatureTable.addFeature to commit the new Feature to the table.

Link copied to clipboard
suspend fun deleteFeature(feature: Feature): Result<Unit>

Deletes a feature from the table. Deleting a feature from a GeodatabaseFeatureTable in a stand-alone mobile geodatabase created with ArcGIS Pro is not supported when the table participates in a controller dataset, such as a utility network or parcel fabric. Use FeatureTable.canDelete to determine if this operation is allowed.

Link copied to clipboard
suspend fun deleteFeatures(features: Iterable<Feature>): Result<Unit>

Deletes a collection of features from the table.

Link copied to clipboard
fun getField(fieldName: String): Field?

Retrieves the field with the given fieldName.

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

Loads the metadata for the object.

Link copied to clipboard
suspend fun queryExtent(queryParameters: QueryParameters): Result<Envelope>

Determines the minimum bounding envelope that contains features satisfying the provided query parameters. If no features meet the query criteria, an empty envelope is returned.

Link copied to clipboard
suspend fun queryFeatureCount(queryParameters: QueryParameters): Result<Long>

Determines the count of features that satisfy the provided query parameters.

Link copied to clipboard

Submits a query against the table.

Link copied to clipboard
suspend fun queryStatistics(statisticsQueryParameters: StatisticsQueryParameters): Result<StatisticsQueryResult>

Calculates values for the requested statistics. Statistics query parameters may also define fields on which results are grouped or sorted.

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

Loads or retries loading metadata for the object.

Link copied to clipboard
suspend fun updateFeature(feature: Feature): Result<Unit>

Updates a feature in the table. If you update a feature that contains a com.arcgismaps.geometry.Geometry, the geometry becomes simplified. This may change a single part geometry to a multipart geometry, or round X, Y, Z, and M coordinate values that are above the resolution set by the com.arcgismaps.geometry.SpatialReference.

Link copied to clipboard
suspend fun updateFeatures(features: Iterable<Feature>): Result<Unit>

Updates a collection of features in the table.