FeatureLayerQueryParams
Interface
Query parameters for featuer layer.
Properties
| Property | Type | Notes |
|---|---|---|
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 | |
number[] | Object IDs of records to be queried. | |
string[] | One or more | |
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. | ||
number | Page number starts from 1, not 0. | |
number | Page size. | |
boolean | If true, it returns distinct values based on the fields specified in outFields. | |
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 native. | |
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. | |
string | A where clause for the query. |
distance optional
gdbVersion optional
gdbVersion: stringSpecify the geodatabase version to be queried.
geometry optional
geometry: IGeometryThe geometry of the spatial filter.
geometryPrecision optional
geometryPrecision: numberThis option can be used to specify the number of decimal places for the returned geometries.
groupByFieldsForStatistics optional
groupByFieldsForStatistics: string[]One or more jimuFieldName by which the values will be grouped for calculating the statistics.
objectIds optional
objectIds: number[]Object IDs of records to be queried.
orderByFields optional
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
outFields optional
outFields: string[]The list of fields to be included in the returned result set.
outStatistics optional
outStatistics: StatisticDefinition[]The definitions for one or more field-based statistics to be calculated.
page optional
page: numberPage number starts from 1, not 0.
pageSize optional
pageSize: numberPage size.
returnDistinctValues optional
returnDistinctValues: booleanIf true, it returns distinct values based on the fields specified in outFields.
returnGeometry optional
returnGeometry: booleanIf true, the geometry of each result feature will be returned.
returnM optional
returnM: booleanIf true, m-values are included in the results if the features have m-values. Otherwise, m-values are not returned.
returnZ optional
returnZ: booleanIf true, z-values are included in the results if the features have z-values. Otherwise, z-values are not returned.
spatialRel optional
spatialRel: SpatialRelationshipThe spatial relationship to be applied to the input geometry while performing the query.
sqlFormat optional
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 native.
time optional
time: TimeExtentThe 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
units: UnitsThe unit for calculating the buffer distance.
where optional
where: stringA where clause for the query.
distance: numberThe buffer distance for the input geometries.