useDataView()

Home > @gooddata/sdk-ui > useDataView

useDataView() function

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Warning: This API is now obsolete.

use useExecutionDataView() instead

This hook provides easy way to get data for the provided IPreparedExecution.

Signature:

export declare function useDataView({ execution, window, onCancel, onError, onLoading, onPending, onSuccess, }: {
    execution: IPreparedExecution | undefined | null;
    window?: DataViewWindow;
} & UseDataViewCallbacks, deps?: DependencyList): UseDataViewState;

Parameters

ParameterTypeDescription
{ execution, window, onCancel, onError, onLoading, onPending, onSuccess, }{ execution: IPreparedExecution | undefined | null; window?: DataViewWindow; } & UseDataViewCallbacks
depsDependencyList(Optional)

Returns:

UseDataViewState

Remarks

You can use it to create custom visualizations on top of GoodData platform. Be aware that execution is re-executed only on dependency list change, not on execution/window/callbacks change.

← UseDataExportStateUseDataViewCallbacks →