ArcGISFeatureTable QML Type

  • Esri.ArcGISRuntime
  • ArcGISFeatureTable
  • A table of features that typically represents real-world objects created from an ArcGIS feature service or an ArcGIS geodatabase. More...

    Import Statement: import Esri.ArcGISRuntime
    Since: Esri.ArcGISRuntime 100.0
    Inherits:

    FeatureTable

    Inherited By:

    GeodatabaseFeatureTable and ServiceFeatureTable

    Properties

    Signals

    Methods

    Detailed Description

    Note: You cannot declare or create a component of this type in QML code.

    This is the base class for the ArcGIS specific feature tables GeodatabaseFeatureTable and ServiceFeatureTable.

    If the FeatureTable::hasGeometry is true, you can display the features in a Map or Scene. To do this create a FeatureLayer from the feature table and add it to the map or scene's collection of operational layers (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.

    Subtypes of this type represent a feature set from a specific type of ArcGIS source such as a feature service or a geodatabase. The features in the set might or might not include geometry. You can query the ArcGISFeatureTable using attribute or spatial criteria. If permitted, you can edit the features. Edits are tracked, so you can later retrieve a list of your edits. If the feature set contains geographic features, you can display them on a map using a FeatureLayer.

    An ArcGISFeatureTable may have FeatureTemplates, FeatureTypes, and support edit capabilities. These are defined by the table's service definition. An ArcGISFeatureTable may have editable attribute fields.

    ArcGISFeatureTables from the same data source can be related to one another. RelationshipInfo defines relationships between tables. A relationship's cardinality may be one-to-one (1:1), one-to-many (1:n), or many-to-many (m:n), depending on the capabilities of the data source. If a table has relationships, you can find related tables, query for related features, and edit them.

    To query or edit using related tables, all the tables participating in the relationship must be loaded into the same Map. Otherwise, the query will not return results and the edits cannot be performed.

    RelatedQueryParameters defines queries on related tables.

    See also Cancelable and Loadable.

    Property Documentation

    [read-only] addedFeaturesCountResult : string

    Returns the result of the addedFeaturesCount operation (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    See also addedFeaturesCountResultAsInt.


    [read-only, since Esri.ArcGISRuntime 100.3] addedFeaturesCountResultAsInt : int

    The same as addedFeaturesCountResult but represented as an integer type (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] addedFeaturesCountStatus : Enums.TaskStatus

    Returns the status of the addedFeaturesCount operation (read-only).

    See also Enums.TaskStatus.


    [read-only] addedFeaturesResult : FeatureQueryResult

    Returns the result of the addedFeatures operation (read-only).


    [read-only] addedFeaturesStatus : Enums.TaskStatus

    Returns the status of the addedFeatures operation (read-only).

    See also Enums.TaskStatus.


    [read-only, since Esri.ArcGISRuntime 100.13] contingentValuesDefinition : ContingentValuesDefinition

    The table's contingent values definition (read-only).

    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 property was introduced in Esri.ArcGISRuntime 100.13.


    [read-only, since Esri.ArcGISRuntime 100.3] defaultSubtypeCode : var

    Returns the table's default subtype code (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] deletedFeaturesCountResult : string

    Returns the result of the deletedFeaturesCount operation (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    See also deletedFeaturesCountResultAsInt.


    [read-only, since Esri.ArcGISRuntime 100.3] deletedFeaturesCountResultAsInt : int

    The same as deletedFeaturesCountResult but represented as an integer type (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] deletedFeaturesCountStatus : Enums.TaskStatus

    Returns the status of the deletedFeaturesCount operation (read-only).

    See also Enums.TaskStatus.


    [read-only] deletedFeaturesResult : FeatureQueryResult

    Returns the result of the deletedFeatures operation (read-only).


    [read-only] deletedFeaturesStatus : Enums.TaskStatus

    Returns the status of the deletedFeatures operation (read-only).

    See also Enums.TaskStatus.


    [read-only] editableAttributeFields : list<string>

    Returns the names of the table's editable attribute fields (read-only).

    This property is populated after the table loads.


    [read-only, since Esri.ArcGISRuntime 100.3] featureSubtypes : list<FeatureSubtype>

    Returns a list of FeatureSubtype objects describing the subtypes of the layer (read-only).

    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 property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] featureTemplates : list<FeatureTemplate>

    Returns a list of feature templates for this ArcGISFeatureTable (read-only).

    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.

    This property is populated after the table loads.


    [read-only] featureTypes : list<FeatureType>

    Returns a list of feature types for this ArcGISFeatureTable (read-only).

    This property is populated after the table loads.


    [read-only] globalIdField : string

    Returns the name of the table's global ID field (read-only).

    This property is populated after the table loads.


    [read-only] hasAttachments : bool

    Returns whether feature attachments are enabled (read-only).

    This property is populated after the table loads.


    [read-only, since Esri.ArcGISRuntime 100.9] hasLocalEdits : bool

    Returns whether the feature table has local edits. (read-only)

    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(date).

    When a table is not change-tracked, it will emit an Error with an Error::errorType of Enums.ErrorTypeGeodatabaseChangeTrackingNotEnabled.

    This property was introduced in Esri.ArcGISRuntime 100.9.


    [read-only] layerInfo : ArcGISFeatureLayerInfo

    Returns the service information associated with the feature layer (read-only).

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


    [read-only, since Esri.ArcGISRuntime 100.12] localEditsCountResult : string

    The result returned when the asynchronous localEditsCount operation completes (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.12.

    See also localEditsCountResultAsInt.


    [read-only, since Esri.ArcGISRuntime 100.12] localEditsCountResultAsInt : int

    The result returned when the asynchronous localEditsCount operation completes (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.12.


    [read-only, since Esri.ArcGISRuntime 100.12] localEditsCountStatus : Enums.TaskStatus

    The current status of the asynchronous localEditsCount operation (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.12.


    [read-only, since Esri.ArcGISRuntime 100.12] localEditsResult : LocalFeatureEditsResult

    The result returned when the asynchronous localEdits operation completes (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.12.


    [read-only, since Esri.ArcGISRuntime 100.12] localEditsStatus : Enums.TaskStatus

    The current status of the asynchronous localEdits operation (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.12.


    [read-only] objectIdField : string

    Returns the name of the table's object ID field (read-only).

    This property is populated after the table loads.


    [read-only, since Esri.ArcGISRuntime 100.3] queryRelatedFeatureCountResult : string

    Returns the result of the queryRelatedFeatureCount operation (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.3.

    See also queryRelatedFeatureCountResultAsInt.


    [read-only, since Esri.ArcGISRuntime 100.3] queryRelatedFeatureCountResultAsInt : int

    The same as queryRelatedFeatureCountResult but represented as an integer type (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only, since Esri.ArcGISRuntime 100.3] queryRelatedFeatureCountStatus : Enums.TaskStatus

    Returns the status of the queryRelatedFeatureCount operation (read-only).

    This property was introduced in Esri.ArcGISRuntime 100.3.

    See also Enums.TaskStatus.


    [read-only] queryRelatedFeaturesResults : list<RelatedFeatureQueryResult>

    Returns a list of results from a queryRelatedFeatures operation (read-only).

    These results contain the related features to the queried feature.

    Obtain the results once the queryRelatedFeaturesStatusChanged signal emits, and the queryRelatedFeaturesStatus is complete.


    [read-only] queryRelatedFeaturesStatus : Enums.TaskStatus

    Returns the status of the queryRelatedFeatures operation (read-only).

    See also Enums.TaskStatus.


    [read-only, since Esri.ArcGISRuntime 100.1] relatedTables : list<ArcGISFeatureTable>

    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 property is populated after this table loads.

    This property was introduced in Esri.ArcGISRuntime 100.1.


    [read-only] serviceLayerId : string

    Returns the layer ID in the feature service that this table was created from (read-only).

    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.

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    See also serviceLayerIdAsInt.


    [read-only, since Esri.ArcGISRuntime 100.3] serviceLayerIdAsInt : int

    The same as serviceLayerId but represented as an integer type (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only, since Esri.ArcGISRuntime 100.3] subtypeField : string

    Return the table's subtype field (read-only).

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

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] typeIdField : string

    Returns the name of the table's type ID field (read-only).

    This property is populated after the table loads.


    [read-only, since Esri.ArcGISRuntime 100.8] unknownJson : jsobject

    Unknown data from the source JSON (read-only).

    Unknown JSON is a QJsonObject 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.

    This property was introduced in Esri.ArcGISRuntime 100.8.


    [read-only, since Esri.ArcGISRuntime 100.8] unsupportedJson : jsobject

    Unsupported data from the source JSON (read-only).

    Unsupported JSON is a jsobject 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.

    This property was introduced in Esri.ArcGISRuntime 100.8.


    [read-only] updatedFeaturesCountResult : string

    Returns the result of the updatedFeaturesCount operation (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    See also updatedFeaturesCountResultAsInt.


    [read-only, since Esri.ArcGISRuntime 100.3] updatedFeaturesCountResultAsInt : string

    The same as updatedFeaturesCountResult but represented as an integer type (read-only).

    Note: The underlying property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.

    This property was introduced in Esri.ArcGISRuntime 100.3.


    [read-only] updatedFeaturesCountStatus : Enums.TaskStatus

    Returns the status of the updatedFeaturesCount operation (read-only).

    See also Enums.TaskStatus.


    [read-only] updatedFeaturesResult : FeatureQueryResult

    Returns the result of the updatedFeatures operation (read-only).


    [read-only] updatedFeaturesStatus : Enums.TaskStatus

    Returns the status of the updatedFeatures operation (read-only).

    See also Enums.TaskStatus.


    useAdvancedSymbology : bool

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

    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.


    [read-only, since Esri.ArcGISRuntime 200.0] username : string

    Returns the table's username (read-only).

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

    Note: this property may change after the object is loaded.

    This property was introduced in Esri.ArcGISRuntime 200.0.

    See also Loadable.


    [read-only] validateRelationshipConstraintsResult : Enums.RelationshipConstraintViolationType

    Returns the result of the validateRelationshipConstraints operation (read-only).

    See also Enums.RelationshipConstraintViolationType.


    [read-only] validateRelationshipConstraintsStatus : Enums.TaskStatus

    Returns the status of the validateRelationshipConstraints operation (read-only).

    See also Enums.TaskStatus.


    Signal Documentation

    addedFeaturesCountStatusChanged()

    Emitted when the addedFeaturesCountStatus property changes.

    Note: The corresponding handler is onAddedFeaturesCountStatusChanged.


    addedFeaturesStatusChanged()

    Emitted when the addedFeaturesStatus property changes.

    Note: The corresponding handler is onAddedFeaturesStatusChanged.


    [since Esri.ArcGISRuntime 100.3] defaultSubtypeCodeChanged()

    Emitted when the defaultSubtypeCode property changes.

    Note: The corresponding handler is onDefaultSubtypeCodeChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.3.


    deletedFeaturesCountStatusChanged()

    Emitted when the deletedFeaturesCountStatus property changes.

    Note: The corresponding handler is onDeletedFeaturesCountStatusChanged.


    deletedFeaturesStatusChanged()

    Emitted when the deletedFeaturesStatus property changes.

    Note: The corresponding handler is onDeletedFeaturesStatusChanged.


    editableAttributeFieldsChanged()

    Emitted when the editableAttributeFields property changes.

    Note: The corresponding handler is onEditableAttributeFieldsChanged.


    [since Esri.ArcGISRuntime 100.3] featureSubtypesChanged()

    Emitted when the featureSubtypes property changes.

    Note: The corresponding handler is onFeatureSubtypesChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.3.


    featureTemplatesChanged()

    Emitted when the featureTemplates property changes.

    Note: The corresponding handler is onFeatureTemplatesChanged.


    featureTypesChanged()

    Emitted when the featureTypes property changes.

    Note: The corresponding handler is onFeatureTypesChanged.


    globalIdFieldChanged()

    Emitted when the globalIdField property changes.

    Note: The corresponding handler is onGlobalIdFieldChanged.


    hasAttachmentsChanged()

    Emitted when the hasAttachments property changes.

    Note: The corresponding handler is onHasAttachmentsChanged.


    [since Esri.ArcGISRuntime 100.9] hasLocalEditsChanged()

    Emitted when the hasLocalEdits property changes.

    Note: The corresponding handler is onHasLocalEditsChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.9.


    layerInfoChanged()

    Emitted when the layerInfo property changes.

    Note: The corresponding handler is onLayerInfoChanged.


    [since Esri.ArcGISRuntime 100.12] localEditsCountStatusChanged()

    Emitted when the localEditsCountStatus property changes.

    Note: The corresponding handler is onLocalEditsCountStatusChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.12.


    [since Esri.ArcGISRuntime 100.12] localEditsStatusChanged()

    Emitted when the localEditsStatus property changes.

    Note: The corresponding handler is onLocalEditsStatusChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.12.


    objectIdFieldChanged()

    Emitted when the objectIdField property changes.

    Note: The corresponding handler is onObjectIdFieldChanged.


    [since Esri.ArcGISRuntime 100.3] queryRelatedFeatureCountStatusChanged()

    Emitted when the queryRelatedFeatureCountStatus property changes.

    Note: The corresponding handler is onQueryRelatedFeatureCountStatusChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.3.


    queryRelatedFeaturesStatusChanged()

    Emitted when the queryRelatedFeaturesStatus property changes.

    Note: The corresponding handler is onQueryRelatedFeaturesStatusChanged.


    relatedTablesChanged()

    Emitted when the relatedTables property changes.

    Note: The corresponding handler is onRelatedTablesChanged.


    [since Esri.ArcGISRuntime 100.3] serviceLayerIdAsIntChanged()

    Emitted when the serviceLayerIdAsInt property changes.

    Note: The corresponding handler is onServiceLayerIdAsIntChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.3.


    serviceLayerIdChanged()

    Emitted when the serviceLayerId property changes.

    Note: The corresponding handler is onServiceLayerIdChanged.


    [since Esri.ArcGISRuntime 100.3] subtypeFieldChanged()

    Emitted when the subtypeField property changes.

    Note: The corresponding handler is onSubtypeFieldChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.3.


    typeIdFieldChanged()

    Emitted when the typeIdField property changes.

    Note: The corresponding handler is onTypeIdFieldChanged.


    updatedFeaturesCountStatusChanged()

    Emitted when the updatedFeaturesCountStatus property changes.

    Note: The corresponding handler is onUpdatedFeaturesCountStatusChanged.


    updatedFeaturesStatusChanged()

    Emitted when the updatedFeaturesStatus property changes.

    Note: The corresponding handler is onUpdatedFeaturesStatusChanged.


    useAdvancedSymbologyChanged()

    Emitted when the useAdvancedSymbology property changes.

    Note: The corresponding handler is onUseAdvancedSymbologyChanged.


    [since Esri.ArcGISRuntime 200.0] usernameChanged()

    Emitted when the username property changes.

    Note: The corresponding handler is onUsernameChanged.

    This signal was introduced in Esri.ArcGISRuntime 200.0.


    validateRelationshipConstraintsStatusChanged()

    Emitted when the validateRelationshipConstraintsStatus property changes.

    Note: The corresponding handler is onValidateRelationshipConstraintsStatusChanged.


    Method Documentation

    string 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. Returns a string representing the task ID of the asynchronous task.

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

    See also Enums.TaskStatus and Cancelable.


    string addedFeaturesCount()

    Returns the number of features added since the last sync.

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

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

    See also Enums.TaskStatus and Cancelable.


    [since Esri.ArcGISRuntime 100.13] ContingentValuesResult contingentValues(ArcGISFeature feature, string field)

    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 object 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 method was introduced in Esri.ArcGISRuntime 100.13.


    [since Esri.ArcGISRuntime 100.3] ArcGISFeature createFeatureWithSubtype(FeatureSubtype featureSubtype)

    Returns a new ArcGISFeature based on the given featureSubtype.

    Creates a feature object in memory without adding it to the dataset. Use addFeature or addFeatures to add the new feature to the dataset.

    This method was introduced in Esri.ArcGISRuntime 100.3.


    [since Esri.ArcGISRuntime 100.3] ArcGISFeature createFeatureWithSubtypeAndGeometry(FeatureSubtype featureSubtype, Geometry geometry)

    Returns a new ArcGISFeature based on the given featureSubtype and geometry.

    Creates a feature object in memory without adding it to the dataset. Use addFeature or addFeatures to add the new feature to the dataset.

    This method was introduced in Esri.ArcGISRuntime 100.3.


    ArcGISFeature createFeatureWithTemplate(FeatureTemplate featureTemplate)

    Returns a new ArcGISFeature based on the given featureTemplate.

    Creates a feature object in memory without adding it to the dataset. Use addFeature or addFeatures to add the new feature to the dataset.


    ArcGISFeature createFeatureWithTemplateAndGeometry(FeatureTemplate featureTemplate, Geometry geometry)

    Returns a new ArcGISFeature based on the given featureTemplate and geometry.

    Creates a feature object in memory without adding it to the dataset. Use addFeature or addFeatures to add the new feature to the dataset.


    ArcGISFeature createFeatureWithType(FeatureType featureType)

    Returns a new ArcGISFeature based on the given featureType.

    Creates a feature object in memory without adding it to the dataset. Use addFeature or addFeatures to add the new feature to the dataset.


    ArcGISFeature createFeatureWithTypeAndGeometry(FeatureType featureType, Geometry geometry)

    Returns a new ArcGISFeature based on the given featureType and geometry.

    Creates a feature object in memory without adding it to the dataset. Use addFeature or addFeatures to add the new feature to the dataset.


    string deletedFeatures()

    Returns the features deleted since the last sync.

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

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

    See also Enums.TaskStatus and Cancelable.


    string deletedFeaturesCount()

    Returns the number of features deleted since the last sync.

    The task object representing the asynchronous retrieval of features deleted since last sync. The value of the task result is string.

    See also Enums.TaskStatus and Cancelable.


    FeatureTemplate featureTemplate(string name)

    Returns a feature template given its name.


    FeatureType featureType(string name)

    Returns a feature type given its name.


    [since Esri.ArcGISRuntime 100.12] string localEdits()

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

    Returns a LocalFeatureEditsResult object containing a FeatureIterator 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.

    Returns a string representing the task ID of the asynchronous task.

    This method was introduced in Esri.ArcGISRuntime 100.12.


    [since Esri.ArcGISRuntime 100.12] string 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.

    Returns a string representing the task ID of the asynchronous task.

    This method was introduced in Esri.ArcGISRuntime 100.12.


    [since Esri.ArcGISRuntime 100.3] string queryRelatedFeatureCount(Feature feature)

    Determines the count of features related to the provided feature.

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

    The queryRelatedFeatureCountStatusChanged signal emits when the operation is complete. Check the queryRelatedFeatureCountStatus property to make sure the operation completed successfully. The results are then available through queryRelatedFeatureCountResult.

    This method was introduced in Esri.ArcGISRuntime 100.3.

    See also Cancelable.


    [since Esri.ArcGISRuntime 100.3] string queryRelatedFeatureCountWithParameters(Feature feature, RelatedQueryParameters relatedQueryParameters)

    Determines the 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 string.

    The queryRelatedFeatureCountStatusChanged signal emits when the operation is complete. Check the queryRelatedFeatureCountStatus property to make sure the operation completed successfully. The results are then available through queryRelatedFeatureCountResult.

    Returns a task ID that can be used to cancel the task.

    This method was introduced in Esri.ArcGISRuntime 100.3.

    See also Cancelable.


    [since Esri.ArcGISRuntime 100.1] string queryRelatedFeatures(Feature feature)

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

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

    The queryRelatedFeaturesStatusChanged signal emits when the operation is complete. Check the queryRelatedFeaturesStatus property to make sure the operation completed successfully. The results are then available through queryRelatedFeaturesResults.

    This method was introduced in Esri.ArcGISRuntime 100.1.


    [since Esri.ArcGISRuntime 100.1] string queryRelatedFeaturesWithParameters(Feature feature, 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 GeoModel, either as a feature source for a layer or added to the GeoModel via GeoModel.tables. Otherwise, the query will return no results.

    The queryRelatedFeaturesStatusChanged signal emits when the operation is complete. Check the queryRelatedFeaturesStatus to make sure the operation completed successfully. The results are then available through queryRelatedFeaturesResults.

    This method was introduced in Esri.ArcGISRuntime 100.1.


    [since Esri.ArcGISRuntime 100.1] list<ArcGISFeatureTable> relatedTablesWithRelationshipInfo(RelationshipInfo relationshipInfo)

    Returns a 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 method was introduced in Esri.ArcGISRuntime 100.1.


    string updatedFeatures()

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

    This method uses an asynchronous task that cannot be started if it is already running from a previous call to updatedFeatures. You should check that the updatedFeaturesStatus property is not Enums.TaskStatusInProgress before calling this method.

    After the task starts, you may use the signal updatedFeaturesStatusChanged to monitor task status.

    Returns a task ID that can be used to cancel the updatedFeatures task.

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

    See also Enums.TaskStatus and Cancelable.


    string updatedFeaturesCount()

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

    Returns a task ID representing the asynchronous retrieval of features updated since last sync. The value of the task result is string.

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

    See also Enums.TaskStatus and Cancelable.


    [since Esri.ArcGISRuntime 100.13] list<ContingencyConstraintViolation> validateContingencyConstraints(ArcGISFeature feature)

    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 method was introduced in Esri.ArcGISRuntime 100.13.


    [since Esri.ArcGISRuntime 100.1] string validateRelationshipConstraints(Feature feature)

    Validates constraints for a given feature participating in a relationship.

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

    This method returns a task ID for the asynchronous operation.

    • feature - The feature.

    The following are considered violations:

    • In a composite relationship, adding an orphan feature to the destination table without relating it to an origin feature
    • Cardinality Violations: - 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 method was introduced in Esri.ArcGISRuntime 100.1.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.