QueryParameters class final
Parameters to perform a query on a dataset.
These parameters provide attribute, spatial, and temporal criteria that you can use to filter features. You can define attribute criteria using a standard SQL expression based on the available attribute fields, spatial criteria using a geometry and a spatial relationship (such as within, contains, intersect), or temporal filters using a single date/time, or a range. You can also control how the results are sorted and whether to return geometry.
In addition to querying features in a table, you can also use these parameters to count specific features, calculate the extent of features, select features in layers, and populate service-based tables. If the query method produces a set of features, they are returned in a FeatureQueryResult.
Different query parameter objects are available to query data sources such as related features (RelatedQueryParameters), statistical information (StatisticsQueryParameters), and portals (PortalQueryParameters). Specialized query parameters also exist for working with utility networks and routing.
- Implemented types
Constructors
- QueryParameters()
-
Creates a new query parameters object.
factory
Properties
- geometry ↔ Geometry?
-
The geometry used to filter the results.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- maxAllowableOffset ↔ double
-
The maximum allowable offset.
getter/setter pair
- maxFeatures ↔ int
-
The maximum number of features the query should return.
getter/setter pair
-
objectIds
→ List<
int> -
The object ids of the features to query for.
no setter
-
orderByFields
→ List<
OrderBy> -
The fields by which query results will be ordered.
no setter
- outSpatialReference ↔ SpatialReference?
-
The spatial reference of the feature results' geometry.
getter/setter pair
- resultOffset ↔ int
-
The starting offset of results to fetch. This is useful for paging through
results.
getter/setter pair
- returnGeometry ↔ bool
-
True if geometry values are returned in the results, otherwise false.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spatialRelationship ↔ SpatialRelationship
-
The spatial relationship that (along with the QueryParameters.geometry)
defines features to be included in the query.
getter/setter pair
- timeExtent ↔ TimeExtent?
-
A span of time used to query features in a time-aware feature layer.
getter/setter pair
- whereClause ↔ String
-
The attribute expression that defines features to be included in the
query.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited