Class QueryParameters
Represents the parameters to perform a query on a dataset.
Inheritance
Namespace: Esri.ArcGISRuntime.Data
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class QueryParameters
Remarks
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.
Constructors
Name | Description |
---|---|
QueryParameters() | Initializes a new instance of the QueryParameters class. |
Properties
Name | Description |
---|---|
Geometry | Gets or sets the Geometry that (along with the SpatialRelationship) defines features to be included in the query. |
MaxAllowableOffset | Gets or sets the maximum allowable offset. |
MaxFeatures | Gets or sets the maximum number of features the query should return. |
ObjectIds | Gets the object IDs of the features to query. |
OrderByFields | Gets the fields by which query results will be ordered. |
OutSpatialReference | Gets or sets the SpatialReference of feature results' geometry. |
ResultOffset | Gets or sets the starting offset of results to fetch. This is useful for paging through results. |
ReturnGeometry | Gets or sets a value indicating whether to return Geometry in the feature results. |
SpatialRelationship | Gets or sets the type of SpatialRelationship (along with the Geometry) that defines features to be included in the query. |
TimeExtent | Gets or sets the TimeExtent used to query features in a time-aware feature layer. |
WhereClause | Gets or sets the attribute expression that defines features to be included in the query. |
See Also
Applies to
Target | Versions |
---|---|
.NET Standard 2.0 | 100.3 - 200.5 |
.NET | 100.13 - 200.5 |
.NET Windows | 100.13 - 200.5 |
.NET Android | 200.0 - 200.5 |
.NET iOS | 200.0 - 200.5 |
.NET Framework | 100.0 - 200.5 |
Xamarin.Android | 100.0 - 100.15 |
Xamarin.iOS | 100.0 - 100.15 |
UWP | 100.0 - 200.5 |