Parameters to perform a statistical query on a FeatureTable. More...
Import Statement: | import Esri.ArcGISRuntime |
Since: | Esri.ArcGISRuntime 100.2 |
Inherits: |
- List of all members, including inherited members
- StatisticsQueryParameters is part of QML Type List.
Properties
- geometry : Geometry
- groupByFieldNames : list<string>
- orderByFields : list<OrderBy>
- spatialRelationship : Enums.SpatialRelationship
- statisticDefinitions : list<StatisticDefinition>
- timeExtent : TimeExtent
- whereClause : string
Signals
- geometryChanged()
- groupByFieldNamesChanged()
- orderByFieldsChanged()
- spatialRelationshipChanged()
- statisticDefinitionsChanged()
- timeExtentChanged()
- whereClauseChanged()
Detailed Description
Perform statistical analyses such as average, count, maximum, and standard deviation on a feature table by defining a Enums.StatisticType on a StatisticDefinition. Use a combination of attribute, spatial, and temporal criteria to filter the features to be analyzed. If no filters are defined, all features in the table are included in the statistical query. You can also control how to group the results.
Queries can find statistics based on a geometry filter, or a SQL WHERE clause.
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 |
---|---|
Geometry | geometry |
OrderBy | orderByFields (appends to list) |
StatisticDefinition | statisticDefinitions (appends to list) |
TimeExtent | timeExtent |
See also FeatureTable::queryStatistics(StatisticsQueryParameters) and StatisticDefinition::statisticType.
Property Documentation
[default] geometry : Geometry |
The geometry used to filter the results.
The geometry that (along with the spatialRelationship) defines features to be included in the statistical query.
groupByFieldNames : list<string> |
The fields by which statistical query results will be grouped.
[read-only] orderByFields : list<OrderBy> |
The fields by which statistical query results will be ordered.
Results can be sorted on one or more fields. Each OrderBy instance includes a field name and whether to sort by that field in ascending or descending order. If a service-based table is being queried it must support advanced queries.
See also OrderBy.
spatialRelationship : Enums.SpatialRelationship |
The spatial relationship that (along with the geometry) defines features to be included in the query.
The default spatial relationship is Enums.SpatialRelationshipIntersects.
See also Enums.SpatialRelationship.
[read-only] statisticDefinitions : list<StatisticDefinition> |
The definition of statistics (input field, output name, statistic type) to include in the statistical query of a table.
See also StatisticDefinition.
[default, since Esri.ArcGISRuntime 100.3] timeExtent : TimeExtent |
The time extent to apply to the query.
This property was introduced in Esri.ArcGISRuntime 100.3.
whereClause : string |
The attribute expression that defines features to be included in the statistics query.
The where clause should follow standard SQL syntax similar to that discussed in the document SQL reference for query expressions used in ArcGIS.
If the where clause includes dates, they must be correctly formatted based on the geodatabase datasource used in the service. Refer to Dates and time for date formats expected by different data sources.
ArcGISFeatureTable objects expect that any Enums.FieldTypeGlobalId or Enums.FieldTypeGUID parameters in the where clause are formatted as: '{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}'. All characters are uppercase, wrapped in curly braces and surrounded by single quotes.
Signal Documentation
geometryChanged() |
Emitted when the geometry property changes.
Note: The corresponding handler is onGeometryChanged
.
groupByFieldNamesChanged() |
Emitted when the groupByFieldNames property changes.
Note: The corresponding handler is onGroupByFieldNamesChanged
.
orderByFieldsChanged() |
Emitted when the orderByFields property changes.
Note: The corresponding handler is onOrderByFieldsChanged
.
spatialRelationshipChanged() |
Emitted when the spatialRelationship property changes.
Note: The corresponding handler is onSpatialRelationshipChanged
.
statisticDefinitionsChanged() |
Emitted when the statisticDefinitions property changes.
Note: The corresponding handler is onStatisticDefinitionsChanged
.
|
Emitted when the timeExtent property changes.
Note: The corresponding handler is onTimeExtentChanged
.
This signal was introduced in Esri.ArcGISRuntime 100.3.
whereClauseChanged() |
Emitted when the whereClause property changes.
Note: The corresponding handler is onWhereClauseChanged
.