FeatureLayerQueryParams

Interface

Query parameters for featuer layer.

Inheritance: FeatureLayerQueryParamsSqlQueryParams

Properties

Hide inherited properties
PropertyTypeNotes
number

The buffer distance for the input geometries.

string

Specify the geodatabase version to be queried.

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

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

number[]

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.

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.

boolean

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

boolean

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

SpatialRelationship

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

"none" | "standard" | "native"

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

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

The unit for calculating the buffer distance.

where
 inherited 
string

A where clause for the query.

distance

optional
Interface Property
distance: number

The buffer distance for the input geometries.

gdbVersion

optional
Interface Property
gdbVersion: string

Specify the geodatabase version to be queried.

geometry

optional
Interface Property
geometry: IGeometry

The geometry of the spatial filter.

geometryPrecision

optional
Interface Property
geometryPrecision: number

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

groupByFieldsForStatistics

optionalinherited
Interface Property
groupByFieldsForStatistics: string[]

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

notAddFieldsToClient

optional
Interface Property
notAddFieldsToClient: boolean

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

objectIds

optional
Interface Property
objectIds: number[]

Object IDs of records to be queried.

orderByFields

optionalinherited
Interface Property
orderByFields: 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

optionalinherited
Interface Property
outFields: string[]

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

outStatistics

optional
Interface Property
outStatistics: StatisticDefinition[]

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

page

optionalinherited
Interface Property
page: number

Page number starts from 1, not 0.

Inherited from SqlQueryParams.page

pageSize

optionalinherited
Interface Property
pageSize: number

Page size.

returnDistinctValues

optional
Interface Property
returnDistinctValues: boolean

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

returnFullGeometries

optional
Interface Property
returnFullGeometries: boolean

If true, the queried features have full precision geometry.

returnGeometry

optional
Interface Property
returnGeometry: boolean

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

returnM

optional
Interface Property
returnM: boolean

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

returnZ

optional
Interface Property
returnZ: boolean

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

spatialRel

optional
Interface Property
spatialRel: SpatialRelationship

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

sqlFormat

optional
Interface Property
sqlFormat: "none" | "standard" | "native"

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

time

optional
Interface Property
time: 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

optional
Interface Property
units: Units

The unit for calculating the buffer distance.

where

optionalinherited
Interface Property
where: string

A where clause for the query.

Inherited from SqlQueryParams.where

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