⚠️ You are viewing documentation for an older version of Compose SDK.
Version:
# Function useComposedDashboard Alpha
useComposedDashboard<
D>(...args):object
React hook that takes in separate dashboard elements and composes them into a coordinated dashboard with change detection, cross filtering, and drill down.
# Type parameters
| Parameter |
|---|
D extends ComposableDashboardProps | DashboardProps |
# Parameters
| Parameter | Type |
|---|---|
...args | [D, UseComposedDashboardOptions?] |
# Returns
# dashboard
dashboard: D
# layoutOptions
layoutOptions: DashboardLayoutOptions
# setFilters
setFilters: (filters) => void
# Parameters
| Parameter | Type |
|---|---|
filters | FilterRelations | Filter[] |
# Returns
void
# setWidgetsLayout
setWidgetsLayout: (newLayout) => void
# Parameters
| Parameter | Type |
|---|---|
newLayout | WidgetsPanelColumnLayout |
# Returns
void