Interface ExecuteCustomWidgetQueryParams

Parameters for executing a query for a custom widget.

Properties

count?: number

Number of rows to return in the query result

If not specified, the default value is 20000

dataOptions: GenericDataOptions

Data options defining dimensions and measures

dataSource?: DataSource

Data source for the query

enabled?: boolean

Boolean flag to control if the hook is executed

If not specified, the default value is true

filters?: FilterRelations | Filter[]

Filters to apply to the query

highlights?: Filter[]

Highlight filters

offset?: number

Offset of the first row to return

If not specified, the default value is 0

onBeforeQuery?: (jaql) => any

Sync or async callback that allows to modify the JAQL payload before it is sent to the server.

Note: In React, wrap this function in useCallback hook to avoid triggering query execution on each render.

const onBeforeQuery = useCallback((jaql) => {
  // modify jaql here
  return jaql;
}, []);

Parameter	Type
`jaql`	`any`

any

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