Contains parameters for a query for features. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- geometry : Geometry
- maxAllowableOffset : double
- maxFeatures : int
- objectIds : list<string>
- objectIdsAsInts : list<int>
- orderByFields : list<OrderBy>
- outSpatialReference : SpatialReference
- resultOffset : int
- returnGeometry : bool
- spatialRelationship : Enums.SpatialRelationship
- timeExtent : TimeExtent
- whereClause : string
Signals
- geometryChanged()
- maxAllowableOffsetChanged()
- maxFeaturesChanged()
- objectIdsAsIntsChanged()
- objectIdsChanged()
- orderByFieldsChanged()
- outSpatialReferenceChanged()
- resultOffsetChanged()
- returnGeometryChanged()
- spatialRelationshipChanged()
- timeExtentChanged()
- whereClauseChanged()
Detailed Description
Queries can find features based on object ID, a geometry filter, a SQL WHERE clause, and a time extent.
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| SpatialReference | outSpatialReference |
| Geometry | geometry |
| OrderBy | orderByFields (appends to list) |
| TimeExtent | timeExtent |
See also FeatureTable.
Property Documentation
[default] geometry : Geometry |
The input geometry used for a spatial filter.
The maximum allowable offset used for generalizing geometries returned by the query operation.
This is expressed in units of outSpatialReference.
The default value is 0.0.
The maximum number of features to be included in the result.
If 0, then there is no limit set on the number of features.
The default value is 0.
The list of object IDs of the features to be queried.
Only features with these object IDs, a unique identifier within the feature set, will be considered as result candidates.
Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.
Note: objectIds and objectIdsAsInts can be used interchangeably. Both reference the same underlying Runtime property.
See also objectIdsAsInts.
The same as objectIds but represented as an integer types (read-only).
Note: The underlying Runtime property is represented as a 64-bit integer type. See Accessing 64-bit integer properties from QML.
Note: objectIdsAsInts and objectIds can be used interchangeably. Both reference the same underlying Runtime property.
This property was introduced in Esri.ArcGISRuntime 100.3.
[default] orderByFields : list<OrderBy> |
[default] outSpatialReference : SpatialReference |
The spatial reference of the feature geometry in the result.
The starting offset of results to fetch in the query.
When providing a result offset to support paging of results, you must also set a maximum features value. If the result offset is set, but the maximum features value is not, the offset is ignored. For consistent ordering of the results when using pagination, the orderByFields property must be set.
The default value is 0.
This property was introduced in Esri.ArcGISRuntime 100.3.
The spatial relationship to use when applying the geometry filter.
The default value is Enums.SpatialRelationshipIntersects.
See also Enums.SpatialRelationship.
[default] timeExtent : TimeExtent |
The time extent to apply to the query.
This property was introduced in Esri.ArcGISRuntime 100.3.
The SQL WHERE clause to apply in the query.
The string that is used as the QueryParameters::whereClause should follow standard SQL syntax, discussed in SQL reference for query expressions used in ArcGIS.
If the string used as the QueryParameters::whereClause is also 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.
Note: CQL-TEXT and CQL-JSON string are not supported with ArcGISFeatureTable objects.
Signal Documentation
Emitted when the geometry property changes.
Note: The corresponding handler is onGeometryChanged.
Emitted when the maxAllowableOffset property changes.
Note: The corresponding handler is onMaxAllowableOffsetChanged.
Emitted when the maxFeatures property changes.
Note: The corresponding handler is onMaxFeaturesChanged.
Emitted when the objectIdsAsInts property changes.
Note: The corresponding handler is onObjectIdsAsIntsChanged.
Emitted when the objectIds property changes.
Note: The corresponding handler is onObjectIdsChanged.
Emitted when the orderByFields property changes.
Note: The corresponding handler is onOrderByFieldsChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
Emitted when the outSpatialReference property changes.
Note: The corresponding handler is onOutSpatialReferenceChanged.
Emitted when the resultOffset property changes.
Note: The corresponding handler is onResultOffsetChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
Emitted when the returnGeometry property changes.
Note: The corresponding handler is onReturnGeometryChanged.
Emitted when the spatialRelationship property changes.
Note: The corresponding handler is onSpatialRelationshipChanged.
Emitted when the timeExtent property changes.
Note: The corresponding handler is onTimeExtentChanged.
This signal was introduced in Esri.ArcGISRuntime 100.3.
Emitted when the whereClause property changes.
Note: The corresponding handler is onWhereClauseChanged.