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

Property	Modifiers	Type	Description
backend?		IAnalyticalBackend	(ALPHA) (Optional) Backend to work with.
clientHeight?		number	(ALPHA) (Optional)
clientWidth?		number	(ALPHA) (Optional)
drillStep?		DrillStep	(Optional) 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.
ErrorComponent		ComponentType<IErrorProps>	(ALPHA) Error component to use when insight rendering fails for any reason.
exportData?		WidgetExportDataAttributes	(ALPHA) (Optional)
insight		IInsight	An insight to render.
LoadingComponent		ComponentType<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)
widget		IInsightWidget	Definition of insight widget to render.
workspace?		string	(ALPHA) (Optional) Workspace where the Insight widget exists.