Interface
Query parameters for the arcgis queriable data source.
Properties
Property | Type | Notes |
---|---|---|
boolean | If true, it always sends http request to server to get the response. | |
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 | |
honorOutFields inherited | 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. | |
string[] | Object IDs of records to be queried. | |
orderByFields inherited | string[] | One or more |
outFields inherited | string[] | The list of fields to be included in the returned result set. |
number | ISpatialReference | The spatial reference of the returned geometry. | |
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. |
disableClientQuery
disableClientQuery: boolean
If true, it always sends http request to server to get the response.
gdbVersion
gdbVersion: string
Specify the geodatabase version to be queried.
geometryPrecision
geometryPrecision: number
This option can be used to specify the number of decimal places for the returned geometries.
groupByFieldsForStatistics
groupByFieldsForStatistics: string[]
One or more jimuFieldName
by which the values will be grouped for calculating the statistics.
honorOutFields
honorOutFields: 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.
notAddFieldsToClient
notAddFieldsToClient: boolean
If true, don't add missed fields into layer.outFields for client query.
orderByFields
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
outFields: string[]
The list of fields to be included in the returned result set.
outSR
outSR: number | ISpatialReference
The spatial reference of the returned geometry.
outStatistics
outStatistics: StatisticDefinition[]
The definitions for one or more field-based statistics to be calculated.
returnDistinctValues
returnDistinctValues: boolean
If true, it returns distinct values based on the fields specified in outFields.
returnFullGeometry
returnFullGeometry: boolean
If true, the queried features have full precision geometry.
returnGeometry
returnGeometry: boolean
If true, the geometry of each result feature will be returned.
returnM
returnM: boolean
If true, m-values are included in the results if the features have m-values. Otherwise, m-values are not returned.
returnZ
returnZ: boolean
If true, z-values are included in the results if the features have z-values. Otherwise, z-values are not returned.
spatialRel
spatialRel: SpatialRelationship
The spatial relationship to be applied to the input geometry while performing the query.
sqlFormat
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
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.