OgcFeatureCollectionTable class final

An OGC API - Features feature collection table.

To display data from an OGC feature collection table in a FeatureLayer use the FeatureLayer.withFeatureTable 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 FeatureCollection.

This API provides building blocks for manipulating OGC 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 pieces: the OgcFeatureCollectionTable.featureRequestMode property and the OgcFeatureCollectionTable.populateFromService methods. Only the FeatureRequestMode.manualCache mode is supported. This means that one of the OgcFeatureCollectionTable.populateFromService methods must be called to populate, query, and return features from the service.

For the QueryParameters.whereClause used by the OgcFeatureCollectionTable.populateFromService methods, you can put any CQL2-TEXT or CQL2-JSON string as defined in the document Common Query Language (CQL2). Use the OgcFeatureCollectionTable.populateFromServiceWithQueryLanguage method to explicitly specify the query language of the QueryParameters.whereClause.

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.

Inheritance

Constructors

OgcFeatureCollectionTable.withFeatureCollectionInfo(OgcFeatureCollectionInfo featureCollectionInfo)
Creates a new OGC API - Features feature collection table.
factory
OgcFeatureCollectionTable.withUriAndCollectionId({required Uri uri, required String collectionId})
Creates a new OGC API - Features feature collection table.
factory

Properties

displayName ↔ String
A user-friendly name that can be displayed in the UI (for example, in a Table of Contents).
getter/setter pairinherited
extent → Envelope?
The geographic extent of features within the table.
no setterinherited
featureCollectionInfo → OgcFeatureCollectionInfo?
The OGC API - Features feature collection metadata, which includes id, title, and description.
no setter
featureRequestMode ↔ FeatureRequestMode
The mode defining when features are requested from the service.
getter/setter pair
fields → List<Field>
The collection of Field objects representing the fields of the feature table.
no setterinherited
geometryType → GeometryType
The type of geometry of the features stored in this table.
no setterinherited
hasGeometry → bool
True if the feature table supports geographic features, false otherwise.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hasM → bool
True if the feature table supports geometries with M values, false otherwise.
no setterinherited
hasZ → bool
True if the feature table supports geometries with Z values, false otherwise.
no setterinherited
isEditable → bool
True if this feature table is editable, false otherwise.
no setterinherited
layer → Layer?
The layer that displays this table, if any.
no setterinherited
loadError → ArcGISException?
The load error.
no setterinherited
loadStatus → LoadStatus
The load status.
no setterinherited
numberOfFeatures → int
The number of features in the table.
no setterinherited
onLoadStatusChanged → Stream<LoadStatus>
A stream that reports changes to the LoadStatus.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
spatialReference → SpatialReference?
The spatial reference of the table.
no setterinherited
tableName → String
The name of the table in the source dataset.
no setterinherited
uri → Uri
The URL of the OGC API - Features service landing page.
no setter

Methods

addFeature(Feature feature) → Future<void>
Adds a feature to the table.
inherited
addFeatures(List<Feature> features) → Future<void>
Adds a collection of features to the table.
inherited
canAdd() → bool
Determines whether you can add new features to the table.
inherited
cancelLoad() → void
Cancels loading metadata for the object.
inherited
canDelete(Feature feature) → bool
Determines whether you can delete the feature from the table.
inherited
canEditGeometry() → bool
Determines whether you can edit the geometry field in a table.
inherited
canUpdate(Feature feature) → bool
Determines whether you can update the feature in the table.
inherited
createFeature({Map<String, dynamic> attributes = const {}, Geometry? geometry}) → Feature
Creates a new feature with the provided attribute values and, optionally, geometry.
inherited
deleteFeature(Feature feature) → Future<void>
Deletes a feature from the table.
inherited
deleteFeatures(List<Feature> features) → Future<void>
Deletes a collection of features from the table.
inherited
getField({required String fieldName}) → Field?
Retrieves the field with the given name.
inherited
load() → Future<void>
Loads the metadata for the object asynchronously.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
populateFromService({QueryParameters? parameters, required bool clearCache, required List<String> outFields}) → Future<FeatureQueryResult>
Populate the OGC API - Features feature collection table with the results of a query.
populateFromServiceWithQueryLanguage({QueryParameters? parameters, required bool clearCache, required List<String> outFields, required String queryLanguage}) → Future<FeatureQueryResult>
Populate the OGC API - Features feature collection table with the results of a query.
queryExtent(QueryParameters queryParameters) → Future<Envelope>
Determines the minimum bounding envelope that contains features satisfying the provided query parameters.
inherited
queryFeatureCount(QueryParameters queryParameters) → Future<int>
Determines the count of features that satisfy the provided query parameters.
inherited
queryFeatures(QueryParameters queryParameters) → Future<FeatureQueryResult>
Submits a query against the table.
inherited
queryStatistics(StatisticsQueryParameters statisticsQueryParameters) → Future<StatisticsQueryResult>
Calculates values for the requested statistics.
inherited
retryLoad() → Future<void>
Loads or retries loading metadata for the object asynchronously.
inherited
toString() → String
A string representation of this object.
inherited
updateFeature(Feature feature) → Future<void>
Updates a feature in the table.
inherited
updateFeatures(List<Feature> features) → Future<void>
Updates a collection of features in the table.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited