Skip to content

Interface

Query parameters for the feature layer data source.

Inheritance: FeatureLayerQueryParamsArcGISQueryParams

Properties

Hide inherited properties
PropertyTypeNotes
boolean

If true, it always sends http request to server to get the response.

distance
inherited
number

The buffer distance for the input geometries.

gdbVersion
inherited
string

Specify the geodatabase version to be queried.

geometry
inherited
IGeometry

The geometry of the spatial filter.

number

This option can be used to specify the number of decimal places for the returned geometries.

string[]

One or more jimuFieldName by which the values will be grouped for calculating the statistics.

boolean

Since widgets share the loaded data when using the load method, the data source will concatenate all the fields used by the widgets as the final outField when sending the request. If set to true, the data source will use the outFields provided directly. This can improve performance, but please ensure that you pass in sufficient fields to avoid errors in the widgets.

boolean

If true, don't add missed fields into layer.outFields for client query.

objectIds
inherited
string[]

Object IDs of records to be queried.

orderByFields
inherited
string[]

One or more jimuFieldName by which the features/records will be ordered. Use ASC for ascending and DESC for descending. The following fields are used to control the ordering. orderByFields is set to ASC (ascending order) by default if <ORDER> is unspecified.

outFields
inherited
string[]

The list of fields to be included in the returned result set.

outSR
inherited
number | ISpatialReference

The spatial reference of the returned geometry.

outStatistics
inherited
StatisticDefinition[]

The definitions for one or more field-based statistics to be calculated.

page
inherited
number

Page number starts from 1, not 0.

pageSize
inherited
number

Page size.

boolean

If true, it returns distinct values based on the fields specified in outFields.

boolean

If true, the queried features have full precision geometry.

boolean

If true, the geometry of each result feature will be returned.

returnM
inherited
boolean

If true, m-values are included in the results if the features have m-values. Otherwise, m-values are not returned.

returnZ
inherited
boolean

If true, z-values are included in the results if the features have z-values. Otherwise, z-values are not returned.

spatialRel
inherited
SpatialRelationship

The spatial relationship to be applied to the input geometry while performing the query.

sqlFormat
inherited
"standard" | "none" | "native"

The sqlFormat parameter can be either standard SQL-92 standard or it can use the native SQL of the underlying data store.

time
inherited
TimeExtent

The time instant or the time extent to query. A null value specified for start time or end time will represent infinity for start or end time, respectively.

units
inherited
Units

The unit for calculating the buffer distance.

where
inherited
string

A where clause for the query.

disableClientQuery

optionalinheritedinherited
Interface Property

distance

optionalinheritedinherited
Interface Property

gdbVersion

optionalinheritedinherited
Interface Property

geometry

optionalinheritedinherited
Interface Property

geometryPrecision

optionalinheritedinherited
Interface Property

groupByFieldsForStatistics

optionalinheritedinherited
Interface Property

honorOutFields

optionalinheritedinherited
Interface Property

notAddFieldsToClient

optionalinheritedinherited
Interface Property

objectIds

optionalinheritedinherited
Interface Property

orderByFields

optionalinheritedinherited
Interface Property

outFields

optionalinheritedinherited
Interface Property

outSR

optionalinheritedinherited
Interface Property

outStatistics

optionalinheritedinherited
Interface Property

page

optionalinheritedinherited
Interface Property

pageSize

optionalinheritedinherited
Interface Property

returnDistinctValues

optionalinheritedinherited
Interface Property

returnFullGeometry

optionalinheritedinherited
Interface Property

returnGeometry

optionalinheritedinherited
Interface Property

returnM

optionalinheritedinherited
Interface Property

returnZ

optionalinheritedinherited
Interface Property

spatialRel

optionalinheritedinherited
Interface Property

sqlFormat

optionalinheritedinherited
Interface Property

time

optionalinheritedinherited
Interface Property

units

optionalinheritedinherited
Interface Property

where

optionalinheritedinherited
Interface Property

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.