Interface ExecutePivotQueryParams

Parameters for useExecutePivotQuery hook.

Properties

enabled?: boolean

Boolean flag to control if query is executed

If not specified, the default value is true

columns?: (Attribute | PivotAttribute)[]

Dimensions for the columns of the pivot table

dataSource?: DataSource

Data source the query is run against - e.g. Sample ECommerce

If not specified, the query will use the defaultDataSource specified in the parent Sisense Context.

grandTotals?: PivotGrandTotals

Options for grand totals

rows?: (Attribute | PivotAttribute)[]

Dimensions for the rows of the pivot table

values?: (Measure | PivotMeasure)[]

Measures for the values of the pivot table

filters?: FilterRelations | Filter[]

Filters that will slice query results

highlights?: Filter[]

Filters that will highlight query results

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