ArcGISFeatureTable Class

Member Function Documentation

[signal] void ArcGISFeatureTable::addedFeaturesCompleted(QUuid taskId, Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult)

Signal emitted after a task started by addedFeatures has completed.

• taskId - The task ID for the asynchronous operation.
• featureQueryResult - The features that have been added to the table.

The returned FeatureQueryResult object has the ArcGISFeatureTable as its parent.

See also Returned QObjects Parenting.

[signal] void ArcGISFeatureTable::addedFeaturesCountCompleted(QUuid taskId, qint64 count)

Signal emitted after a task started by addedFeaturesCount has completed.

• taskId - The task ID for the asynchronous operation.
• count - The count of features that have been added to the table.

[signal] void ArcGISFeatureTable::deletedFeaturesCompleted(QUuid taskId, Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult)

Signal emitted after a task started by deletedFeatures has completed.

• taskId - The task ID for the asynchronous operation.
• featureQueryResult - The result of features that have been deleted from the table.

The returned FeatureQueryResult objects have the ArcGISFeatureTable as their parent.

See also Returned QObjects Parenting.

[signal] void ArcGISFeatureTable::deletedFeaturesCountCompleted(QUuid taskId, qint64 count)

Signal emitted after a task started by deletedFeaturesCount has completed.

• taskId - The task ID for the asynchronous operation.
• count - The count of features that have been deleted from the table.

[signal] void ArcGISFeatureTable::localEditsCompleted(QUuid taskId, Esri::ArcGISRuntime::LocalFeatureEditsResult *localEditsResult)

Signal emitted when the localEdits operation completes.

• taskId - The task ID of the asynchronous operation.
• localEditsResult - The result of the localEdits operation.

The returned LocalFeatureEditsResult object has the ArcGISFeatureTable as its parent.

This function was introduced in Esri::ArcGISRuntime 100.12.

See also Returned QObjects Parenting.

[signal] void ArcGISFeatureTable::localEditsCountCompleted(QUuid taskId, qint64 localEditsCount)

Signal emitted when the localEditsCount operation completes.

• taskId - The task ID of the asynchronous operation.
• localEditsCount - The result of the localEditsCount operation.

This function was introduced in Esri::ArcGISRuntime 100.12.

[signal] void ArcGISFeatureTable::queryRelatedFeatureCountCompleted(QUuid taskId, quint64 count)

Signal emitted after a task started by queryRelatedFeatureCount has completed.

• taskId - The task ID for the asynchronous operation.
• count - The count of related features.

This function was introduced in Esri::ArcGISRuntime 100.3.

[signal] void ArcGISFeatureTable::queryRelatedFeaturesCompleted(QUuid taskId, QList<Esri::ArcGISRuntime::RelatedFeatureQueryResult *> relatedFeatureQueryResults)

Signal emitted after a task started by queryRelatedFeatures has completed.

• taskId - The task ID for the asynchronous operation.
• relatedFeatureQueryResults - The list ofRelatedFeatureQueryResult, one per related table containing features related to the queried feature.

The returned RelatedFeatureQueryResult objects have the ArcGISFeatureTable as their parent.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also Returned QObjects Parenting.

[signal] void ArcGISFeatureTable::updatedFeaturesCompleted(QUuid taskId, Esri::ArcGISRuntime::FeatureQueryResult *featureQueryResult)

Signal emitted after a task started by updatedFeatures has completed.

• taskId - The task ID for the asynchronous operation.
• featureQueryResult - A result of features that have been updated in the table.

The returned FeatureQueryResult objects have the ArcGISFeatureTable as their parent.

See also Returned QObjects Parenting.

[signal] void ArcGISFeatureTable::updatedFeaturesCountCompleted(QUuid taskId, qint64 count)

Signal emitted after a task started by updatedFeaturesCount has completed.

• taskId - The task ID for the asynchronous operation.
• count - The count of features that have been updated in the table.

[signal] void ArcGISFeatureTable::validateRelationshipConstraintsCompleted(QUuid taskId, Esri::ArcGISRuntime::RelationshipConstraintViolationType relationshipConstraintViolationType)

Signal emitted after a task started by validateRelationshipConstraints has completed.

• taskId - The task ID for the asynchronous operation.
• relationshipConstraintViolationType - The type of violation, such as cardinality.

[override virtual] ArcGISFeatureTable::~ArcGISFeatureTable()

Destructor.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::addedFeatures()

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.

This method returns a TaskWatcher for the asynchronous operation.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::addedFeaturesCount()

Requests a count of features added to the local dataset but not yet added to the original source dataset.

For mobile geodatabases created by ArcGIS Pro, this method returns 0 because there is no concept of syncing.

Returns a TaskWatcher object representing the asynchronous retrieval of features added since last sync. The value of the task result is qint64.

Esri::ArcGISRuntime::ContingentValuesResult *ArcGISFeatureTable::contingentValues(Esri::ArcGISRuntime::ArcGISFeature *feature, const QString &field) const

Returns possible values for the specified field, in the context of defined contingencies.

• feature - The feature.
• field - The name of the field for which to get possible values.

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 and an associated list of ContingentValue objects. These objects are accessed via ContingentValuesResult::contingentValuesByFieldGroup, by 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::contingentValuesAllGroups.

This function was introduced in Esri::ArcGISRuntime 100.13.

Esri::ArcGISRuntime::ContingentValuesDefinition *ArcGISFeatureTable::contingentValuesDefinition() const

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

This function was introduced in Esri::ArcGISRuntime 100.13.

Esri::ArcGISRuntime::ArcGISFeature *ArcGISFeatureTable::createFeatureWithSubtype(const Esri::ArcGISRuntime::FeatureSubtype &featureSubtype, QObject *parent = nullptr) const

Creates and returns a new feature based on the specified featureSubtype, with an optional parent.

Note, the new feature is only available in memory at this point, it is not committed to the dataset and will need to be explicitly added.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also FeatureTable::addFeature.

Esri::ArcGISRuntime::ArcGISFeature *ArcGISFeatureTable::createFeatureWithSubtype(const Esri::ArcGISRuntime::FeatureSubtype &featureSubtype, const Esri::ArcGISRuntime::Geometry &geometry, QObject *parent = nullptr) const

Creates and returns a new feature based on the specified featureSubtype and geometry with an optional parent.

Note, the new feature is only available in memory at this point, it is not committed to the dataset and will need to be explicitly added.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also FeatureTable::addFeature.

Esri::ArcGISRuntime::ArcGISFeature *ArcGISFeatureTable::createFeatureWithTemplate(const Esri::ArcGISRuntime::FeatureTemplate &featureTemplate, QObject *parent = nullptr) const

Creates and returns a new feature based on the given featureTemplate, with an optional parent.

The new feature is only available in memory at this point, it is not committed to the dataset and will need to be explicitly added.

See also FeatureTable::addFeature.

Esri::ArcGISRuntime::ArcGISFeature *ArcGISFeatureTable::createFeatureWithTemplate(const Esri::ArcGISRuntime::FeatureTemplate &featureTemplate, const Esri::ArcGISRuntime::Geometry &geometry, QObject *parent = nullptr) const

Creates and returns a new feature based on the specified featureTemplate and geometry, with an optional parent.

The new feature is only available in memory at this point, it is not committed to the dataset and will need to be explicitly added.

See also FeatureTable::addFeature.

Esri::ArcGISRuntime::ArcGISFeature *ArcGISFeatureTable::createFeatureWithType(const Esri::ArcGISRuntime::FeatureType &featureType, QObject *parent = nullptr) const

Creates and returns a new feature based on the specified featureType, with an optional parent.

Note, the new feature is only available in memory at this point, it is not committed to the dataset and will need to be explicitly added.

See also FeatureTable::addFeature.

Esri::ArcGISRuntime::ArcGISFeature *ArcGISFeatureTable::createFeatureWithType(const Esri::ArcGISRuntime::FeatureType &featureType, const Esri::ArcGISRuntime::Geometry &geometry, QObject *parent = nullptr) const

Creates and returns a new feature based on the specified featureType and geometry with an optional parent.

Note, the new feature is only available in memory at this point, it is not committed to the dataset and will need to be explicitly added.

See also FeatureTable::addFeature.

QVariant ArcGISFeatureTable::defaultSubtypeCode() const

Returns the table's default subtype code.

This function was introduced in Esri::ArcGISRuntime 100.3.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::deletedFeatures()

Returns the features deleted since the last sync.

For mobile geodatabases created by ArcGIS Pro, this method returns 0 because there is no concept of syncing.

Returns a TaskWatcher object representing the asynchronous retrieval of features deleted since last sync. The value of the task result is a FeatureQueryResult object.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::deletedFeaturesCount()

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.

Returns a TaskWatcher object representing the asynchronous retrieval of features deleted since last sync. The value of the task result is qint64.

QList<Esri::ArcGISRuntime::Field> ArcGISFeatureTable::editableAttributeFields() const

Returns a list of Field objects representing the subset of fields (columns) in the dataset that are editable.

QList<Esri::ArcGISRuntime::FeatureSubtype> ArcGISFeatureTable::featureSubtypes() const

Returns a list of FeatureSubtype objects describing the subtypes of the layer.

This list is included for layers that have subtypes. The domains in the types list will match the domains in the subtype list for layers that have a unique value renderer based on the subtype column.

This function was introduced in Esri::ArcGISRuntime 100.3.

Esri::ArcGISRuntime::FeatureTemplate ArcGISFeatureTable::featureTemplate(const QString &name) const

Returns a feature template given its name.

QList<Esri::ArcGISRuntime::FeatureTemplate> ArcGISFeatureTable::featureTemplates() const

Returns a list of feature templates for this ArcGISFeatureTable.

A feature template contains all the information required to create a feature, including the attributes a feature is created with. An ArcGISFeatureTable may have one or more feature templates that correspond to different types of features that you may create in the ArcGISFeatureTable.

You can get feature templates if this ArcGISFeatureTable does not contain feature subtypes.

Esri::ArcGISRuntime::FeatureType ArcGISFeatureTable::featureType(const QString &name) const

Returns a feature type given its name.

QList<Esri::ArcGISRuntime::FeatureType> ArcGISFeatureTable::featureTypes() const

Returns a list of FeatureType objects representing feature subtypes in the layer.

For example, a roads layer may contain two feature subtypes: highways and streets.

QString ArcGISFeatureTable::globalIdField() const

Returns the name of field which contains the GLOBALID for each feature.

bool ArcGISFeatureTable::hasAttachments() const

Returns true if features may have attachments.

bool ArcGISFeatureTable::hasLocalEdits() const

Returns whether the feature table has local edits.

For Esri::ArcGISRuntime::ServiceFeatureTable, local edits are edits that have not yet been applied to the feature service. For Esri::ArcGISRuntime::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(QDateTime).

When a table is not change tracked, it will emit an Error with an Error::errorType of {Esri::ArcGISRuntime::ErrorType} {ErrorType::GeodatabaseChangeTrackingNotEnabled}. (Geodatabase change tracking not enabled).

This function was introduced in Esri::ArcGISRuntime 100.9.

bool ArcGISFeatureTable::isUseAdvancedSymbology() const

Returns whether the dataset should be visualized using advanced CIM symbology from the service.

See also setUseAdvancedSymbology.

Esri::ArcGISRuntime::ArcGISFeatureLayerInfo ArcGISFeatureTable::layerInfo() const

Returns the service information associated with the feature layer.

Note, feature layer information can only be obtained after the table is loaded.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::localEdits()

Returns all the features that were added, updated or deleted since the last sync.

Returns a LocalFeatureEditsResult containing an LocalFeatureEditIterator of LocalFeatureEdit objects. For mobile geodatabases created by ArcGIS Pro, the iterator in the result object is empty because there is no concept of syncing.

Note that edits inside a transaction (between calls to Geodatabase::beginTransaction and either Geodatabase::commitTransaction or Geodatabase::rollbackTransaction) share a common LocalFeatureEdit::editDateTime and may not be returned in a consistent order.

This method returns a TaskWatcher for the asynchronous operation.

This function was introduced in Esri::ArcGISRuntime 100.12.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::localEditsCount()

Returns the number of features that were added, updated or deleted since the last sync.

For a mobile geodatabase created by ArcGIS Pro, this method returns a count of 0 because there is no concept of syncing.

This method returns a TaskWatcher for the asynchronous operation.

This function was introduced in Esri::ArcGISRuntime 100.12.

QString ArcGISFeatureTable::objectIdField() const

Returns the name of field which contains the object ID for each feature.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::queryRelatedFeatureCount(Esri::ArcGISRuntime::ArcGISFeature *feature)

Requests a count of features related to the supplied feature.

Returns a TaskWatcher that represents the asynchronous query of related feature count. The value of the task result contains a qint64.

This function was introduced in Esri::ArcGISRuntime 100.3.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::queryRelatedFeatureCount(Esri::ArcGISRuntime::ArcGISFeature *feature, const Esri::ArcGISRuntime::RelatedQueryParameters &relatedQueryParameters)

Requests a count of features related to the supplied feature based on the relatedQueryParameters.

A task that represents the asynchronous query of related feature count. The value of the task result contains a qint64.

This function was introduced in Esri::ArcGISRuntime 100.3.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::queryRelatedFeatures(Esri::ArcGISRuntime::ArcGISFeature *feature)

Queries for related features of a given feature in all relationships.

This table and all related tables must be associated with the same Map, either as a feature source for a layer or added to the Map via Map::tables(). Otherwise, the query will return no results.

This method returns a TaskWatcher for the asynchronous operation.

This function was introduced in Esri::ArcGISRuntime 100.1.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::queryRelatedFeatures(Esri::ArcGISRuntime::ArcGISFeature *feature, const Esri::ArcGISRuntime::RelatedQueryParameters &relatedQueryParameters)

Queries for features related to the given feature in a specific relationship.

• feature - The feature.
• relatedQueryParameters - Description of the relationship and the query to perform.

This table and related tables must be associated with the same Map, either as a feature source for a layer or added to the Map via Map::tables(). Otherwise, the query will return no results.

This method returns a TaskWatcher for the asynchronous operation.

This function was introduced in Esri::ArcGISRuntime 100.1.

QList<Esri::ArcGISRuntime::ArcGISFeatureTable *> ArcGISFeatureTable::relatedTables(const Esri::ArcGISRuntime::RelationshipInfo &relationshipInfo) const

Returns list of tables related by the given relationshipInfo.

Only returns tables that have been added to the same map. If there are multiple instances of the related table on the map, all such instances will be returned.

This function was introduced in Esri::ArcGISRuntime 100.1.

QList<Esri::ArcGISRuntime::ArcGISFeatureTable *> ArcGISFeatureTable::relatedTables() const

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.

This function was introduced in Esri::ArcGISRuntime 100.1.

qint64 ArcGISFeatureTable::serviceLayerId() const

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

Note, service layer ID can only be obtained after the table is loaded, with the exception of GeodatabaseFeatureTable which can obtain the service layer ID after instantiation.

void ArcGISFeatureTable::setUseAdvancedSymbology(bool advancedSymbology)

Sets whether the dataset should be visualized using advanced CIM symbology from the service.

• advancedSymbology - Whether to support advanced symbology.

You cannot change this property after the table is successfully loaded.

The default value is true.

Services that do not support CIM symbols will ignore this property and return regular symbols instead.

See also isUseAdvancedSymbology().

QString ArcGISFeatureTable::subtypeField() const

Return the table's subtype field.

If the table does not have subtypes, an empty string is returned.

This function was introduced in Esri::ArcGISRuntime 100.3.

QString ArcGISFeatureTable::typeIdField() const

Returns the name of the field that contains the subtype information for each feature.

QJsonObject ArcGISFeatureTable::unknownJson() const

Returns the unknown data from the source JSON.

Unknown JSON is a QJsonObject of values that was in the source JSON but was not parsed by the Runtime.

This function was introduced in Esri::ArcGISRuntime 100.8.

QJsonObject ArcGISFeatureTable::unsupportedJson() const

Returns the unsupported data from the source JSON.

Unsupported JSON is a QJsonObject of values that are supported by webmaps, but not exposed through the native Runtime API.

This function was introduced in Esri::ArcGISRuntime 100.8.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::updatedFeatures()

Requests a collection of features updated in the local dataset but not yet updated in the original source dataset.

For mobile geodatabases created by ArcGIS Pro, this method returns 0 because there is no concept of syncing.

Returns a TaskWatcher for the asynchronous operation.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::updatedFeaturesCount()

Requests a count of features updated in the local dataset but not yet updated in the original source dataset.

For mobile geodatabases created by ArcGIS Pro, this method returns 0 because there is no concept of syncing.

Returns a TaskWatcher object representing the asynchronous retrieval of features updated since last sync. The value of the task result is qint64.

QList<Esri::ArcGISRuntime::ContingencyConstraintViolation *> ArcGISFeatureTable::validateContingencyConstraints(Esri::ArcGISRuntime::ArcGISFeature *feature) const

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

• feature - The feature.

This function was introduced in Esri::ArcGISRuntime 100.13.

Esri::ArcGISRuntime::TaskWatcher ArcGISFeatureTable::validateRelationshipConstraints(Esri::ArcGISRuntime::ArcGISFeature *feature)

Validates constraints for a given feature participating in a relationship.

Returns a TaskWatcher that represents the asynchronous validation of relationship constraints operation. The value of the task result contains a RelationshipConstraintViolationType enum.

The following are considered violations:

• RelationshipConstraintViolationType::Orphaned
  • In a composite relationship, adding an orphan feature to the destination table without relating it to an origin feature.
• RelationshipConstraintViolationType::Cardinality
  • In 1:1 relationships, if an origin feature is already related to a destination feature, relating another feature to either of them.
  • In 1:n relationships, relating a destination feature to more than one origin feature.

To recover from an orphaned destination feature violation, relate it to a valid origin feature. You can usually recover from a cardinality violation by un-relating the appropriate features. See ArcGISFeature::unrelateFeature.

Edit operations do not cause an error when there are constraint violations. This allows you to recover from violations in a back office operation after applying edits or syncing, if you choose to do so. See ArcGIS Desktop topic Validating features and relationships in ArcMap for a description of that process.

This method makes network calls to query for the related features if they are not present locally. If you have just related the feature you are validating, first you must call FeatureTable::updateFeature to reflect the modified attribute value in the table. If this is not done, validation results may be incorrect.

This function was introduced in Esri::ArcGISRuntime 100.1.