ArcGIS Runtime SDK for iOS: AGSStatisticsQueryParameters Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSStatisticsQueryParameters Class Reference

Description

Parameters to perform a statistic query using AGSFeatureTable.

Instances of this class represent parameters that can be used to perform a statistic query using queryStatisticsWithParameters:completion: (AGSFeatureTable).

All parameters related to geometry and spatial queries will be ignored when querying non spatial data.

Since
100.2
Inheritance diagram for AGSStatisticsQueryParameters:
AGSObject

Instance Methods

(instancetype) - initWithStatisticDefinitions:
 

Class Methods

(instancetype) + statisticsQueryParametersWithStatisticDefinitions:
 

Properties

AGSGeometrygeometry
 
NSArray< NSString * > * groupByFieldNames
 
NSArray< AGSOrderBy * > * orderByFields
 
AGSSpatialRelationship spatialRelationship
 
NSArray< AGSStatisticDefinition * > * statisticDefinitions
 
AGSTimeExtenttimeExtent
 
NSString * whereClause
 

Method Documentation

◆ initWithStatisticDefinitions:

- (instancetype) initWithStatisticDefinitions: (NSArray< AGSStatisticDefinition * > *)  statisticDefinitions

Intialize the query parameter with the provided statistic definitions

Parameters
statisticDefinitionsdescribing which statistics are required in the query result
Returns
An initialized query parameter
Since
100.2

◆ statisticsQueryParametersWithStatisticDefinitions:

+ (instancetype) statisticsQueryParametersWithStatisticDefinitions: (NSArray< AGSStatisticDefinition * > *)  statisticDefinitions

Intialize the query parameter with the provided statistic definitions

Parameters
statisticDefinitionsdescribing which statistics are required in the query result
Returns
An initialized query parameter
Since
100.2

Property Documentation

◆ geometry

- (AGSGeometry*) geometry
readwritenonatomicstrong

The geometry to use while performing a spatial query. Valid geometry types are AGSEnvelope, AGSPoint, AGSMultipoint, AGSPolygon, and AGSPolyline. Results of the query will include only those features which conform to the specified spatialRelationship with this geometry.

Since
100.2

◆ groupByFieldNames

- (NSArray<NSString*>*) groupByFieldNames
readwritenonatomiccopy

The fields by which statistical query results should be grouped.

Since
100.2

◆ orderByFields

- (NSArray<AGSOrderBy*>*) orderByFields
readwritenonatomiccopy

Fields by which the results need to be ordered. Note, the service being queried must support advanced queries.

Since
100.2

◆ spatialRelationship

- (AGSSpatialRelationship) spatialRelationship
readwritenonatomicassign

The spatial constraint that needs to be applied on the query geometry. Only data satisfying this relationship will be returned as results.

Since
100.2

◆ statisticDefinitions

- (NSArray<AGSStatisticDefinition*>*) statisticDefinitions
readwritenonatomiccopy

The definition of which statistics (input field, output name, statistic type) to include in the results of statistical query.

Since
100.2

◆ timeExtent

- (AGSTimeExtent*) timeExtent
readwritenonatomicstrong

Time extent for the query. Only features that fall within this time period will be returned.

Since
100.2

◆ whereClause

- (NSString*) whereClause
readwritenonatomiccopy

A SQL where clause to filter results for the query. If the where clause includes dates, they must be correctly formatted based on the geodatabase datasource used in the service. Refer to this document for date formats expected by different datasources.

Since
100