IUseInsightDataViewConfig
Home > @gooddata/sdk-ui > IUseInsightDataViewConfig
IUseInsightDataViewConfig interface
Configuration for useInsightDataView() hook.
Signature:
export interface IUseInsightDataViewConfig
Properties
| Property | Type | Description |
|---|---|---|
| backend? | IAnalyticalBackend | (Optional) Backend to work with. |
| dateFormat? | string | ((def: IExecutionDefinition) => string) | (Optional) Modify date formatting on prepared insight execution, before it's executed. |
| dimensions? | IDimension[] | ((def: IExecutionDefinition) => IDimension[]) | (Optional) Modify dimensions on prepared insight execution, before it's executed. |
| executeByReference? | boolean | (Optional) Indicates that the execution to obtain the data for the insight should be an 'execution by reference'.Execution by reference means that the useInsightDataView will ask analytical backend to compute results for an insight which is stored on the backend by specifying link to the insight, additional filters and description how to organize the data.Otherwise, a freeform execution is done, in which the InsightView will send to backend the full execution definition of what to compute.This distinction is in place because some backends MAY want to prohibit users from doing freeform executions and only allow computing data for set of insights created by admins.Note: the need for execute by reference is rare. You will typically be notified by the solution admin to use this mode. |
| filters? | INullableFilter[] | (Optional) Specify filters to merge with filters already defined in the insight. |
| insight? | ObjRef | (Optional) Reference to the insight for which you want to get the data view. |
| sorts? | ISortItem[] | ((def: IExecutionDefinition) => ISortItem[]) | (Optional) Modify sorts on prepared insight execution, before it's executed. |
| window? | DataViewWindow | (Optional) You can define only a specific "window" of data to load. |
| workspace? | string | (Optional) Workspace where execution should be executed. |