✅ You are viewing documentation for the latest version of Compose SDK.
Version:
# Interface ExecuteCustomWidgetQueryParams
Parameters for custom widget query execution.
# Properties
# beforeQuery
beforeQuery?: (
jaql) =>any
Sync or async callback that allows to modify the JAQL payload before it is sent to the server.
# Parameters
| Parameter | Type |
|---|---|
jaql | any |
# Returns
any
# count
count?:
number
Number of rows to return in the query result
If not specified, the default value is 20000
# dataOptions
dataOptions:
GenericDataOptions
# dataSource
dataSource?:
DataSource
# description
description?:
string
# filters
filters?:
FilterRelations|Filter[]
# highlights
highlights?:
Filter[]
# offset
offset?:
number
Offset of the first row to return
If not specified, the default value is 0
# styleOptions
styleOptions:
any
# ungroup
ungroup?:
boolean
Boolean flag whether to include ungroup: true in non-aggregated JAQL queries.
This improves computation and performance of querying tables when no aggregation is needed
If not specified, the default value is false