ExecuteInsight

The ExecuteInsight component loads a visualization saved in the workspace (referenced by ObjRef), runs its execution, and passes the loading state, error, and data view to its children render function. Use it to render the data of a saved visualization with your own code instead of InsightView.

Basic usage

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

export const Example = () => (
    <ExecuteInsight insight={idRef("<visualization-id>")}>
        {({ isLoading, error, result }) => {
            if (isLoading) {
                return <div>Loading...</div>;
            }
            if (error) {
                return <div>Error: {error.message}</div>;
            }
            return <pre>{JSON.stringify(result?.dataView.data, null, 2)}</pre>;
        }}
    </ExecuteInsight>
);

States

The children function receives a WithLoadingResult in one of these states.

reload is available in every state and starts a new execution.

Rendering

ExecuteInsight picks what to render in this order:

When you set both LoadingComponent and ErrorComponent, children is called only with a successful result.

When it re-runs

• ExecuteInsight starts a new execution when insight, filters, or window changes by deep comparison.
• It also starts a new execution when onError, onLoadingChanged, onLoadingFinish, or onLoadingStart changes by reference. Memoize these callbacks.
• Changing sorts, dimensions, or dateFormat alone does not start a new execution. Call reload() to apply them.
• When a new execution starts before the running one finishes, the running one is canceled. The request itself keeps running unless enableExecutionCancelling is true; then its signal is aborted.

Notes

• backend and workspace props take precedence over BackendProvider and WorkspaceProvider. If neither is available, the load fails with an error.
• filters are added to the filters saved in the visualization. sorts, dimensions, and dateFormat override the saved ones; each also accepts a function that receives the execution definition and returns the value.
• Set executeByReference to run the saved visualization by reference instead of sending its full definition. Use it only when your backend requires executions tied to stored visualizations.
• Set loadOnMount={false} to skip the initial run, and call reload() to start it.
• Without window, ExecuteInsight reads all data. Pass window with offset and size arrays to read one page.
• exportTitle defaults to componentName, which defaults to "ExecuteInsight".

Props