IDashboardWidgetProps

IDashboardWidgetProps.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.

IDashboardWidgetProps.dateDatasetproperty

Specify date data set to use when passing dashboard date filter to rendered visualization.

dateDataset?: ObjRef;

Remarks

If not provided, the date filter will not be applied

IDashboardWidgetProps.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>;

IDashboardWidgetProps.exportDatapropertyAlpha

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

Data attributes for export mode to be added to the widget.

exportData?: WidgetExportData;

IDashboardWidgetProps.ignoredAttributeFiltersproperty

Specify what attribute filters to ignore for this widget.

ignoredAttributeFilters?: ObjRefInScope[];

Remarks

Those filters will not be passed to the rendered visualization.

IDashboardWidgetProps.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>;

IDashboardWidgetProps.onDrillpropertyAlpha

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

onDrill?: OnFiredDashboardDrillEvent;

IDashboardWidgetProps.onErrorpropertyAlpha

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

onError?: OnError;

IDashboardWidgetProps.onFiltersChangepropertyAlpha

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

onFiltersChange?: (filters: (IDashboardFilter | FilterContextItem)[], resetOthers?: boolean) => void;

IDashboardWidgetProps.onWidgetClickedpropertyAlpha

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

Callback that the component MUST call when the widget is clicked.

onWidgetClicked?: () => void;

IDashboardWidgetProps.parentLayoutItemSizepropertyAlpha

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

The size of layout item in which the item is nested. Undefined, when item is in the root layout.

parentLayoutItemSize?: IDashboardLayoutSizeByScreenSize;

IDashboardWidgetProps.parentLayoutPathpropertyAlpha

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

The path to the layout item in which the section is nested

parentLayoutPath?: ILayoutItemPath;

IDashboardWidgetProps.rowIndexpropertyAlpha

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

Zero-based index of the row in which the item is rendered,

rowIndex?: number;

Remarks

Optional only for the compatibility reasons with old fluid layout. Once the flexible layout is the only one supported, it can be set as required.

IDashboardWidgetProps.screenpropertyAlpha

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

screen: ScreenSize;

IDashboardWidgetProps.showHeaderpropertyAlpha

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

Turn widget header on/off.

showHeader?: boolean;

IDashboardWidgetProps.showMenupropertyAlpha

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

Turn visibility of the interactions menu on/off.

showMenu?: boolean;

IDashboardWidgetProps.widgetproperty

widget?: ExtendedDashboardWidget;

IDashboardWidgetProps.workspacepropertyAlpha

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

Workspace where the 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.