Skip To Content ArcGIS for Developers Sign In Dashboard

StatisticsQueryParameters Class

(Esri::ArcGISRuntime::StatisticsQueryParameters)

Contains parameters for a query for statistics. More...

Header: #include <StatisticsQueryParameters>
Since: Esri::ArcGISRuntime 100.2

Public Functions

StatisticsQueryParameters()
StatisticsQueryParameters(const QList<StatisticDefinition> &statisticDefinitions)
StatisticsQueryParameters(const StatisticsQueryParameters &other)
StatisticsQueryParameters(StatisticsQueryParameters &&other)
~StatisticsQueryParameters()
void clear()
Geometry geometry() const
QStringList groupByFieldNames() const
bool isEmpty() const
QList<OrderBy> orderByFields() const
void setGeometry(const Geometry &geometry)
void setGroupByFieldNames(const QStringList &groupByFieldNames)
void setOrderByFields(const QList<OrderBy> &orderByFields)
void setSpatialRelationship(SpatialRelationship relationship)
void setStatisticDefinitions(const QList<StatisticDefinition> &statisticDefinitions)
void setTimeExtent(const TimeExtent &timeExtent)
void setWhereClause(const QString &whereClause)
SpatialRelationship spatialRelationship() const
QList<StatisticDefinition> statisticDefinitions() const
TimeExtent timeExtent() const
QString whereClause() const
StatisticsQueryParameters &operator=(const StatisticsQueryParameters &other)
StatisticsQueryParameters &operator=(StatisticsQueryParameters &&other)

Detailed Description

Contains parameters for a query for statistics.

Queries can find statistics based on a geometry filter, or a SQL WHERE clause.

Member Function Documentation

StatisticsQueryParameters::StatisticsQueryParameters()

Default Constructor. Create an empty StatisticsQueryParameters instance.

StatisticsQueryParameters::StatisticsQueryParameters(const QList<StatisticDefinition> &statisticDefinitions)

Create a StatisticsQueryParameters instance with the definition of statistics (statisticDefinitions) to include in a statistical query of a table.

StatisticsQueryParameters::StatisticsQueryParameters(const StatisticsQueryParameters &other)

Copy constructor from other StatisticsQueryParameters.

StatisticsQueryParameters::StatisticsQueryParameters(StatisticsQueryParameters &&other)

Move constructor from other StatisticsQueryParameters.

StatisticsQueryParameters::~StatisticsQueryParameters()

Destructor

void StatisticsQueryParameters::clear()

Clears this StatisticsQueryParameters and sets back to empty.

Geometry StatisticsQueryParameters::geometry() const

Returns the geometry to use as a filter.

See also setGeometry().

QStringList StatisticsQueryParameters::groupByFieldNames() const

Returns the fields by which statistical query results will be grouped.

See also setGroupByFieldNames().

bool StatisticsQueryParameters::isEmpty() const

Returns whether this StatisticsQueryParameters is empty.

QList<OrderBy> StatisticsQueryParameters::orderByFields() const

Returns the sort order of result.

See also setOrderByFields.

void StatisticsQueryParameters::setGeometry(const Geometry &geometry)

Sets the geometry to use as a filter.

See also geometry().

void StatisticsQueryParameters::setGroupByFieldNames(const QStringList &groupByFieldNames)

Sets the fields by which statistical query results will be grouped to groupByFieldNames.

See also groupByFieldNames().

void StatisticsQueryParameters::setOrderByFields(const QList<OrderBy> &orderByFields)

Sets the orderByFields to be applied to the query operation.

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.

See also orderByFields() and OrderBy.

void StatisticsQueryParameters::setSpatialRelationship(SpatialRelationship relationship)

Sets the spatial relationship to use when applying the geometry filter.

See also spatialRelationship().

void StatisticsQueryParameters::setStatisticDefinitions(const QList<StatisticDefinition> &statisticDefinitions)

Sets the definition of statistics (input field, output name, statistic type) to include in a statistical query of a table to statisticDefinitions.

See also statisticDefinitions().

void StatisticsQueryParameters::setTimeExtent(const TimeExtent &timeExtent)

Sets the time extent to apply in the query to timeExtent.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also timeExtent().

void StatisticsQueryParameters::setWhereClause(const QString &whereClause)

Sets the SQL whereClause to apply in the query.

See also whereClause().

SpatialRelationship StatisticsQueryParameters::spatialRelationship() const

Returns the spatial relationship to use when applying the geometry filter.

See also setSpatialRelationship().

QList<StatisticDefinition> StatisticsQueryParameters::statisticDefinitions() const

Returns the definition of statistics (input field, output name, statistic type) to include in a statistical query of a table.

See also setStatisticDefinitions().

TimeExtent StatisticsQueryParameters::timeExtent() const

Returns the time extent to apply in the query.

This function was introduced in Esri::ArcGISRuntime 100.3.

See also setTimeExtent().

QString StatisticsQueryParameters::whereClause() const

Returns the SQL WHERE clause to apply in the query.

See also setWhereClause().

StatisticsQueryParameters &StatisticsQueryParameters::operator=(const StatisticsQueryParameters &other)

Assignment operator from other StatisticsQueryParameters.

StatisticsQueryParameters &StatisticsQueryParameters::operator=(StatisticsQueryParameters &&other)

Move operator from other StatisticsQueryParameters.


Feedback on this topic?