QueryParameters

class QueryParameters

An object that represents a database query.

Constructors

Link copied to clipboard
fun QueryParameters()

Creates a new query parameters object.

Properties

Link copied to clipboard
var geometry: Geometry?
Link copied to clipboard
var maxAllowableOffset: Double

The max allowable offset.

Link copied to clipboard
var maxFeatures: Int

The max number of features the query should return. For consistent ordering of results when using pagination, you should also provide a value for the order by field. Warning: If providing a maximum features value to support paging of results, you should also set a result offset. If maximum features is set, but result offset is not, the result may contain local features in place of server features if they satisfy the query. To ensure strict paging of server features, specify both maximum features and result offset.

Link copied to clipboard
val objectIds: MutableList<Long>
Link copied to clipboard
val orderByFields: MutableList<OrderBy>
Link copied to clipboard
var outSpatialReference: SpatialReference?
Link copied to clipboard
var resultOffset: Int

The starting offset of results to fetch. For consistent ordering of results when using pagination, you should also provide a value for the order by field. Warning: If providing a result offset to support paging of results, you must also set a maximum features value. If result offset is set, but maximum features is not, the offset will be ignored.

Link copied to clipboard
var returnGeometry: Boolean

True if geometry values should be returned from the query.

Link copied to clipboard
var spatialRelationship: SpatialRelationship

The spatial relationship to use for filtering features.

Link copied to clipboard
var timeExtent: TimeExtent?
Link copied to clipboard
var whereClause: String

The where clause of the query. The string that is used as the QueryParameters.getWhereClause() should follow standard SQL syntax similar to what is discussed in the document https://pro.arcgis.com/en/pro-app/latest/help/mapping/navigation/sql-reference-for-elements-used-in-query-expressions.htm.