DashboardOptions
Options related to the Dashboard in Adaptable.
TypeScript
export interfaceProperties
| Property | Type | Description | Default |
|---|---|---|---|
| buttonsLocation | DashboardButtonsLocation | Where in Dashboard to display Module and Custom Buttons | 'right' |
| canFloat | boolean | Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode | true |
| customDashboardButtons | AdaptableButton<DashboardButtonContext>[] | Custom Adaptable Buttons to appear in Dashboard | |
| customToolbars | CustomToolbar[] | Toolbars provided by Users which contain custom content | |
| showQuickSearchInHeader | boolean | Shows Quick Search input in Dashboard Header | true |
Property Details
buttonsLocation
Where in Dashboard to display Module and Custom Buttons
TypeScript
buttonsLocation?: DashboardButtonsLocation;Default Value
'right'
Property Value
canFloat
Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode
TypeScript
canFloat?: boolean;Default Value
true
Property Value
boolean
customDashboardButtons
Custom Adaptable Buttons to appear in Dashboard
TypeScript
customDashboardButtons?: AdaptableButton<DashboardButtonContext>[];Property Value
AdaptableButton<DashboardButtonContext>[]
customToolbars
Toolbars provided by Users which contain custom content
TypeScript
customToolbars?: CustomToolbar[];Property Value
showQuickSearchInHeader
Shows Quick Search input in Dashboard Header
TypeScript
showQuickSearchInHeader?: boolean;Default Value
true
Property Value
boolean