An OGC API - Features feature collection table. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.9 |
| Inherits: |
Properties
- collectionId : string
- credential : Credential
- featureCollectionInfo : OgcFeatureCollectionInfo
- featureRequestMode : Enums.FeatureRequestMode
- populateFromServiceResult : FeatureQueryResult
- populateFromServiceStatus : Enums.TaskStatus
- requestConfiguration : RequestConfiguration
- url : url
Signals
- collectionIdChanged()
- credentialChanged()
- featureCollectionInfoChanged()
- featureRequestModeChanged()
- populateFromServiceStatusChanged()
- requestConfigurationChanged()
- urlChanged()
Methods
- string populateFromService(QueryParameters parameters, bool clearCache, list<string> outfields)
Detailed Description
To display data from an OGC feature collection table in a FeatureLayer use the FeatureLayer::featureTable constructor where the OgcFeatureCollectionTable is the parameter that is passed into the constructor. Note: The OgcFeatureCollectionTable should not be confused with FeatureCollectionTable which is used as an input to create a FeatureCollectionLayer.
The ArcGIS Runtime API for OGC API Features provides building blocks for manipulating features on the Web. For more information about the OGC API Features specification see the documents: OGC API - Features - Part 1 and OGC API - Features - Part 2.
The class includes two important members: the featureRequestMode property and the populateFromService(QueryParameters, bool, list<string>) method. Only the Enums.FeatureRequestModeManualCache mode is supported. This means populateFromService(QueryParameters, bool, list<string>) must be called to populate, query, and return features from the service. For the QueryParameters::whereClause that is used by the populateFromService(QueryParameters, bool, list<string>) method, you can put any CQL2-TEXT or CQL2-JSON string as defined in the document OGC API - Features - Part 3.
When populating or updating a local table from an OGC service, you can now request features in a specified SpatialReference (also referred to as SRS in ArcGIS or CRS in OGC). This leverages the power of the server to return features in the same spatial reference as your map rather than having to re-project them on the client.
This class supports loading and querying of features from a non-spatial OGC feature collection table.
See also FeatureTable and RemoteResource.
Property Documentation
credential : Credential |
The security credential used to access the remote resource.
This is only applicable if the service is secured.
This property was introduced in Esri.ArcGISRuntime 100.13.
featureCollectionInfo : OgcFeatureCollectionInfo |
The OGC API - Features feature-collection metadata, which includes id, title, and description.
This property may not be changed after the feature table is loaded.
The mode defining when features are requested from the service.
Note: at the current release, OgcFeatureCollectionTable only supports Enums.FeatureRequestModeManualCache mode, but defaults to Enums.FeatureRequestModeOnInteractionCache mode. Set the FeatureRequestMode to Enums.FeatureRequestModeManualCache before the table is loaded.
populateFromServiceResult : FeatureQueryResult |
The result returned when the asynchronous populateFromService operation completes (read-only).
The current status of the asynchronous populateFromService operation (read-only).
requestConfiguration : RequestConfiguration |
The configuration parameters used for network requests sent by this object.
This property was introduced in Esri.ArcGISRuntime 100.13.
The URL of the OGC API - Features service landing page.
This property may not be changed after the feature table is loaded.
Signal Documentation
Emitted when the collectionId property changes.
Note: The corresponding handler is onCollectionIdChanged.
Emitted when the credential property changes.
Note: The corresponding handler is onCredentialChanged.
This signal was introduced in Esri.ArcGISRuntime 100.13.
Emitted when the featureCollectionInfo property changes.
Note: The corresponding handler is onFeatureCollectionInfoChanged.
Emitted when the featureRequestMode property changes.
Note: The corresponding handler is onFeatureRequestModeChanged.
Emitted when the populateFromServiceStatus property changes.
Note: The corresponding handler is onPopulateFromServiceStatusChanged.
Emitted when the requestConfiguration property changes.
Note: The corresponding handler is onRequestConfigurationChanged.
This signal was introduced in Esri.ArcGISRuntime 100.13.
Emitted when the url property changes.
Note: The corresponding handler is onUrlChanged.
Method Documentation
string populateFromService(QueryParameters parameters, bool clearCache, list<string> outfields) |
Populate the OGC API - Features feature-collection table with the results of a query.
- parameters - Parameters that define how features are returned from the service.
- clearCache - If
true, clears existing table data before populating it with features returned from the service. - outfields - A list containing string.
Use the default (empty) QueryParameters to get all features from the service. Specifying null or an empty list for outfields will result in the default set of outfields being used. Spatial queries (those that specify geometries) must use the Intersects spatial relationship.
Returns a string representing the task ID of the asynchronous task.