sisense.com
✅ You are viewing documentation for the latest version of Compose SDK.
Version:

Interface DashboardProps

Props for the Dashboard component

Properties

config

config?: DashboardConfig

The configuration for the dashboard


defaultDataSource

defaultDataSource?: DataSource

The default data source to use for the dashboard


filters

filters?: FilterRelations | Filter[]

The dashboard filters to be applied to each of the widgets based on the widget filter options


layoutOptions

layoutOptions?: DashboardLayoutOptions

Dashboard layout options


onChange

onChange?: (event) => void

Callback to receive changes

This callback is invoked when the dashboard state changes, such as filter updates, layout changes, or widget deletions. See DashboardChangeEvent for all possible event types.

Parameters

ParameterTypeDescription
eventDashboardChangeEventThe event that occurred

Returns

void


styleOptions

styleOptions?: DashboardStyleOptions

The style options for the dashboard


title

title?: string

The title of the dashboard


widgets

widgets: WidgetProps[]

The widgets to render in the dashboard


widgetsOptions

widgetsOptions?: WidgetsOptions

The options for each of the widgets

Last Updated: