useInsightDataView

React hook that loads a saved visualization by reference and returns its execution result as a DataViewFacade. For ad-hoc executions, use useExecutionDataView.

Basic usage

import { useInsightDataView } from "@gooddata/sdk-ui";
import { idRef } from "@gooddata/sdk-model";

function VisualizationData({ visualizationId }: { visualizationId: string }) {
    const { result, status, error } = useInsightDataView({
        insight: idRef(visualizationId),
    });

    if (status === "loading" || status === "pending") {
        return <div>Loading...</div>;
    }

    if (status === "error") {
        return <div>Error: {error?.message}</div>;
    }

    const data = result?.data().slices().toArray();
    // ...
}

Parameters

Return value

UseCancelablePromiseState<DataViewFacade, GoodDataSdkError>, the same shape as useCancelablePromise returns.

States

The hook works in two steps: it loads the visualization, then executes it through useExecutionDataView. The returned status is the status of the first step that has not succeeded yet.

When it re-runs

• The visualization is loaded again when backend, workspace, the insight reference (compared by its string form, so a new idRef() object with the same identifier does not reload), or an item in deps changes.
• The hook rebuilds the prepared execution on every render from the loaded visualization, filters, sorts, dimensions, dateFormat, and executeByReference. The execution runs again when the fingerprint of that prepared execution changes, and when backend, workspace, window.offset, window.size (by reference), enableExecutionCancelling, or an item in deps changes.
• A superseded or unmounted load is canceled the same way as in useExecutionDataView: its result is ignored, and the execution request is aborted only when enableExecutionCancelling is true.

Notes

• Without a backend prop or a BackendProvider, the hook throws: “useInsightDataView: IAnalyticalBackend must be defined. Either pass it as a parameter or make sure there is a BackendProvider up the component tree.” A missing workspace throws the matching WorkspaceProvider error.
• The backend and workspace props take precedence over the context values.
• sorts, dimensions, and dateFormat accept either a value or a function. The function receives the execution definition of the visualization and returns the value to apply.
• The callbacks onLoading, onPending, onSuccess, onError, and onCancel track only the execution step. While the visualization is loading, onPending is called, not onLoading. A failed visualization load is returned in error but does not call onError.
• Errors from the visualization load are returned as the backend rejects them. Only execution errors are converted to a GoodDataSdkError subtype.
• window.offset and window.size are arrays compared by reference. Keep them stable; a new array on every render starts a new execution on every render.

Props