Interface
Query parameters for the feature layer data source.
Properties
| Property | Type | Notes |
|---|---|---|
disableClientQueryinherited | boolean | If true, it always sends http request to server to get the response. |
distanceinherited | number | The buffer distance for the input geometries. |
gdbVersioninherited | string | Specify the geodatabase version to be queried. |
geometryinherited | IGeometry | The geometry of the spatial filter. |
geometryPrecisioninherited | number | This option can be used to specify the number of decimal places for the returned geometries. |
groupByFieldsForStatisticsinherited | string[] | One or more |
historicMomentinherited | string | number | The historic moment to query. |
honorOutFieldsinherited | 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. |
notAddFieldsToClientinherited | boolean | If true, don't add missed fields into layer.outFields for client query. |
objectIdsinherited | string | number[] | Object IDs or unique IDs of records to be queried. |
orderByFieldsinherited | string[] | One or more |
outDistanceinherited | { ascendingOrder: boolean; outDistanceUnit: Units; returnDistance: boolean } | If returnDistance is true, will return the distance from the input geometry. |
outFieldsinherited | string[] | The list of fields to be included in the returned result set. |
outSRinherited | number | ISpatialReference | The spatial reference of the returned geometry. |
outStatisticsinherited | StatisticDefinition[] | The definitions for one or more field-based statistics to be calculated. |
pageinherited | number | Page number starts from 1, not 0. |
pageSizeinherited | number | Page size. |
returnDistinctValuesinherited | boolean | If true, it returns distinct values based on the fields specified in outFields. |
returnFullGeometryinherited | boolean | If true, the queried features have full precision geometry. |
returnGeometryinherited | boolean | If true, the geometry of each result feature will be returned. |
returnMinherited | boolean | If true, m-values are included in the results if the features have m-values. Otherwise, m-values are not returned. |
returnZinherited | boolean | If true, z-values are included in the results if the features have z-values. Otherwise, z-values are not returned. |
spatialRelinherited | SpatialRelationship | The spatial relationship to be applied to the input geometry while performing the query. |
sqlFormatinherited | "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. |
timeinherited | 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. |
unitsinherited | Units | The unit for calculating the buffer distance. |
whereinherited | string | A where clause for the query. |
disableClientQuery
disableClientQuery: booleanIf true, it always sends http request to server to get the response.
distance
distance: numberThe buffer distance for the input geometries.
gdbVersion
gdbVersion: stringSpecify the geodatabase version to be queried.
geometryPrecision
geometryPrecision: numberThis 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.
historicMoment
historicMoment: string | numberThe historic moment to query.
honorOutFields
honorOutFields: booleanSince 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: booleanIf true, don't add missed fields into layer.outFields for client query.
objectIds
objectIds: string | number[]Object IDs or unique IDs of records to be queried.
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.
outDistance
outDistance: { ascendingOrder: boolean; outDistanceUnit: Units; returnDistance: boolean }If returnDistance is true, will return the distance from the input geometry.
Type declaration
outFields
outFields: string[]The list of fields to be included in the returned result set.
outSR
outSR: number | ISpatialReferenceThe spatial reference of the returned geometry.
outStatistics
outStatistics: StatisticDefinition[]The definitions for one or more field-based statistics to be calculated.
returnDistinctValues
returnDistinctValues: booleanIf true, it returns distinct values based on the fields specified in outFields.
returnFullGeometry
returnFullGeometry: booleanIf true, the queried features have full precision geometry.
returnGeometry
returnGeometry: booleanIf true, the geometry of each result feature will be returned.
returnM
returnM: booleanIf true, m-values are included in the results if the features have m-values. Otherwise, m-values are not returned.
returnZ
returnZ: booleanIf true, z-values are included in the results if the features have z-values. Otherwise, z-values are not returned.
spatialRel
spatialRel: SpatialRelationshipThe spatial relationship to be applied to the input geometry while performing the query.
sqlFormat
sqlFormat: "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
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.