> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown. # IDashboardInsightProps - Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md) - Kind: interface - Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/widget/insight/types.ts Insight widget props. **Signature:** ```typescript 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?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsbackend) | | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | **_(ALPHA)_** _(Optional)_ Backend to work with. | | [clientHeight?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsclientheight) | | number | **_(ALPHA)_** _(Optional)_ | | [clientWidth?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsclientwidth) | | number | **_(ALPHA)_** _(Optional)_ | | [drillStep?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsdrillstep) | | [IDrillStep](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idrillstep/index.md) | _(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](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropserrorcomponent) | | ComponentType<[IErrorProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ierrorprops/index.md)> | **_(ALPHA)_** Error component to use when insight rendering fails for any reason. | | [exportData?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsexportdata) | | [WidgetExportDataAttributes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.widgetexportdataattributes/index.md) | **_(ALPHA)_** _(Optional)_ | | [insight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsinsight) | | [IInsight](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsight/index.md) | An insight to render. | | [LoadingComponent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsloadingcomponent) | | ComponentType<[ILoadingProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iloadingprops/index.md)> | **_(ALPHA)_** Loading component to use while loading and preparing data to render. | | [onDrill?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsondrill) | | [OnWidgetDrill](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.onwidgetdrill/index.md) | **_(ALPHA)_** _(Optional)_ | | [onDrillDown?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsondrilldown) | | [OnDrillDownSuccess](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ondrilldownsuccess/index.md) | **_(ALPHA)_** _(Optional)_ | | [onDrillToAttributeUrl?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsondrilltoattributeurl) | | [OnDrillToAttributeUrlSuccess](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ondrilltoattributeurlsuccess/index.md) | **_(ALPHA)_** _(Optional)_ | | [onDrillToCustomUrl?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsondrilltocustomurl) | | [OnDrillToCustomUrlSuccess](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ondrilltocustomurlsuccess/index.md) | **_(ALPHA)_** _(Optional)_ | | [onDrillToDashboard?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsondrilltodashboard) | | [OnDrillToDashboardSuccess](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ondrilltodashboardsuccess/index.md) | **_(ALPHA)_** _(Optional)_ | | [onDrillToInsight?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsondrilltoinsight) | | [OnDrillToInsightSuccess](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ondrilltoinsightsuccess/index.md) | **_(ALPHA)_** _(Optional)_ | | [onError?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsonerror) | | [OnError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.onerror/index.md) | **_(ALPHA)_** _(Optional)_ | | [onExportReady?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsonexportready) | | [OnExportReady](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.onexportready/index.md) | **_(ALPHA)_** _(Optional)_ | | [onKeyDriverAnalysisSuccess?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsonkeydriveranalysissuccess) | | OnKeyDriverAnalysisSuccess | **_(ALPHA)_** _(Optional)_ | | [onLoadingChanged?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsonloadingchanged) | | [OnLoadingChanged](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.onloadingchanged/index.md) | **_(ALPHA)_** _(Optional)_ | | [widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropswidget) | | [IInsightWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iinsightwidget/index.md) | Definition of insight widget to render. | | [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardinsightprops/index.md#idashboardinsightpropsworkspace) | | string | **_(ALPHA)_** _(Optional)_ Workspace where the Insight widget exists. | ## Property details ### IDashboardInsightProps.backend > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Backend to work with. **Signature:** ```typescript 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.clientHeight > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript clientHeight?: number; ``` ### IDashboardInsightProps.clientWidth > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript clientWidth?: number; ``` ### IDashboardInsightProps.drillStep 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. **Signature:** ```typescript drillStep?: IDrillStep; ``` ### IDashboardInsightProps.ErrorComponent > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Error component to use when insight rendering fails for any reason. **Signature:** ```typescript ErrorComponent: ComponentType; ``` ### IDashboardInsightProps.exportData > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript exportData?: WidgetExportDataAttributes; ``` ### IDashboardInsightProps.insight An insight to render. **Signature:** ```typescript 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.LoadingComponent > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Loading component to use while loading and preparing data to render. **Signature:** ```typescript LoadingComponent: ComponentType; ``` ### IDashboardInsightProps.onDrill > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onDrill?: OnWidgetDrill; ``` ### IDashboardInsightProps.onDrillDown > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onDrillDown?: OnDrillDownSuccess; ``` ### IDashboardInsightProps.onDrillToAttributeUrl > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onDrillToAttributeUrl?: OnDrillToAttributeUrlSuccess; ``` ### IDashboardInsightProps.onDrillToCustomUrl > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onDrillToCustomUrl?: OnDrillToCustomUrlSuccess; ``` ### IDashboardInsightProps.onDrillToDashboard > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onDrillToDashboard?: OnDrillToDashboardSuccess; ``` ### IDashboardInsightProps.onDrillToInsight > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onDrillToInsight?: OnDrillToInsightSuccess; ``` ### IDashboardInsightProps.onError > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onError?: OnError; ``` ### IDashboardInsightProps.onExportReady > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onExportReady?: OnExportReady; ``` ### IDashboardInsightProps.onKeyDriverAnalysisSuccess > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onKeyDriverAnalysisSuccess?: OnKeyDriverAnalysisSuccess; ``` ### IDashboardInsightProps.onLoadingChanged > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > **Signature:** ```typescript onLoadingChanged?: OnLoadingChanged; ``` ### IDashboardInsightProps.widget Definition of insight widget to render. **Signature:** ```typescript widget: IInsightWidget; ``` ### IDashboardInsightProps.workspace > **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md). > Workspace where the Insight widget exists. **Signature:** ```typescript 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.