SqlQueryParams

Interface

Query parameter which supports SQL.

Inheritance: SqlQueryParamsQueryParams
Subclasses: ArcGISQueryParams

Properties

Hide inherited properties
PropertyTypeNotes
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.

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.

string[]

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

page
inherited
number

Page number starts from 1, not 0.

pageSize
inherited
number

Page size.

string

A where clause for the query.

honorOutFields

optional
Interface Property
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.

orderByFields

optional
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

optional
Interface Property
outFields: string[]

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

page

optionalinheritedinherited
Interface Property
page: number

Page number starts from 1, not 0.

Inherited from QueryParams.page

pageSize

optionalinheritedinherited
Interface Property
pageSize: number

Page size.

Inherited from QueryParams.pageSize

where

optional
Interface Property
where: string

A where clause for the query.

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