IDashboardInsightProps

IDashboardInsightProps.backendpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Backend to work with.

backend?: IAnalyticalBackend;

Remarks

Note: the backend must come either from this property or from BackendContext. If you do not specify backend here, then the component MUST be rendered within an existing BackendContext.

IDashboardInsightProps.clientHeightpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

clientHeight?: number;

IDashboardInsightProps.clientWidthpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

clientWidth?: number;

IDashboardInsightProps.drillStepproperty

This property contains current drill step context.

It is undefined if rendered insight is placed directly in the dashboard. It is defined when the insight is rendered in a drill dialog.

drillStep?: IDrillStep;

IDashboardInsightProps.ErrorComponentpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Error component to use when insight rendering fails for any reason.

ErrorComponent: ComponentType<IErrorProps>;

IDashboardInsightProps.exportDatapropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

exportData?: WidgetExportDataAttributes;

IDashboardInsightProps.insightproperty

An insight to render.

insight: IInsight;

Remarks

Note: the insight object provided here represents the insight as it is stored on the backend. It does not reflect dashboard filters that should be applied when computing data for this insight.

Use the useWidgetFilters() to obtain filters to use on this insight. Use those filters to replace all insight filters using insightSetFilters() function available in @gooddata/sdk-model.

IDashboardInsightProps.LoadingComponentpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Loading component to use while loading and preparing data to render.

LoadingComponent: ComponentType<ILoadingProps>;

IDashboardInsightProps.onDrillpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onDrill?: OnWidgetDrill;

IDashboardInsightProps.onDrillDownpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onDrillDown?: OnDrillDownSuccess;

IDashboardInsightProps.onDrillToAttributeUrlpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onDrillToAttributeUrl?: OnDrillToAttributeUrlSuccess;

IDashboardInsightProps.onDrillToCustomUrlpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onDrillToCustomUrl?: OnDrillToCustomUrlSuccess;

IDashboardInsightProps.onDrillToDashboardpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onDrillToDashboard?: OnDrillToDashboardSuccess;

IDashboardInsightProps.onDrillToInsightpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onDrillToInsight?: OnDrillToInsightSuccess;

IDashboardInsightProps.onErrorpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onError?: OnError;

IDashboardInsightProps.onExportReadypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onExportReady?: OnExportReady;

IDashboardInsightProps.onKeyDriverAnalysisSuccesspropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onKeyDriverAnalysisSuccess?: OnKeyDriverAnalysisSuccess;

IDashboardInsightProps.onLoadingChangedpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onLoadingChanged?: OnLoadingChanged;

IDashboardInsightProps.widgetproperty

Definition of insight widget to render.

widget: IInsightWidget;

IDashboardInsightProps.workspacepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Workspace where the Insight widget exists.

workspace?: string;

Remarks

Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify workspace here, then the component MUST be rendered within an existing WorkspaceContext.