✅ 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

Data options defining dimensions and measures


# dataSource

dataSource?: DataSource

Data source for the query


# filters

filters?: FilterRelations | Filter[]

Filters to apply to the query


# highlights

highlights?: Filter[]

Highlight filters


# offset

offset?: number

Offset of the first row to return

If not specified, the default value is 0


# 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