IDashboardInsightProps

Home > @gooddata/sdk-ui-dashboard > IDashboardInsightProps

IDashboardInsightProps interface

Insight widget props.

Signature:

export interface IDashboardInsightProps

Remarks

IMPORTANT: this interface is marked as public but not all properties in it are suitable for public consumption yet. Please heed the per-property API maturity annotations; the alpha level APIs may change in a breaking way in the next release.

Properties

PropertyModifiersTypeDescription
backend?IAnalyticalBackend(ALPHA) (Optional) Backend to work with.
clientHeight?number(ALPHA) (Optional)
clientWidth?number(ALPHA) (Optional)
ErrorComponentComponentType<IErrorProps>(ALPHA) Error component to use when insight rendering fails for any reason.
insightIInsightAn insight to render.
LoadingComponentComponentType<ILoadingProps>(ALPHA) Loading component to use while loading and preparing data to render.
onDrill?OnWidgetDrill(ALPHA) (Optional)
onDrillDown?OnDrillDownSuccess(ALPHA) (Optional)
onDrillToAttributeUrl?OnDrillToAttributeUrlSuccess(ALPHA) (Optional)
onDrillToCustomUrl?OnDrillToCustomUrlSuccess(ALPHA) (Optional)
onDrillToDashboard?OnDrillToDashboardSuccess(ALPHA) (Optional)
onDrillToInsight?OnDrillToInsightSuccess(ALPHA) (Optional)
onError?OnError(ALPHA) (Optional)
onExportReady?OnExportReady(ALPHA) (Optional)
onLoadingChanged?OnLoadingChanged(ALPHA) (Optional)
widgetIInsightWidgetDefinition of insight widget to render.
workspace?string(ALPHA) (Optional) Workspace where the Insight widget exists.
← IDashboardInsightMenuPropsIDashboardKpiCustomizer →