IDashboardKpiProps

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

IDashboardKpiProps interface

KPI Widget props

Signature:

export interface IDashboardKpiProps

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
alert?IWidgetAlert(Optional) Specify alert set by the current user to this KPI.
backend?IAnalyticalBackend(ALPHA) (Optional) Backend to work with.
ErrorComponent?React.ComponentType<IErrorProps>(ALPHA) (Optional) Component to render if embedding fails.
kpiWidgetIKpiWidgetThe KPI to execute and display.
LoadingComponent?React.ComponentType<ILoadingProps>(ALPHA) (Optional) Component to render while the KPI is loading.
onDrill?OnFiredDashboardDrillEvent(ALPHA) (Optional) Called when user triggers a drill on a visualization.
onError?OnError(ALPHA) (Optional) Called in case of any error, either in the dashboard loading or any of the widgets execution.
onFiltersChange?(filters: (IDashboardFilter | FilterContextItem)[], resetOthers?: boolean) => void(ALPHA) (Optional) Specify a callback that will be triggered when the filters should be changed. (e.g. to apply filters of a KPI alert to the whole dashboard)
workspace?string(ALPHA) (Optional) Workspace where the KPI exists.
← IDashboardKpiCustomizerIDashboardLayoutCustomizer →