• Public
  • Public/Protected
  • All

The Predefined Configuration for the Dashboard function




Optional ActiveTab

ActiveTab: number

The index of the Active Tab (in the Tabs collection)

Optional CanFloat

CanFloat: boolean

Whether or not the Dashboard can be floated.

If set to true (the default) then double-clicking the Dasbhoard will put it in float mode.

If set to false then double-clicking is disabled and the floating menu options are removed.

Default Value: True

Optional CustomButtons

CustomButtons: ToolbarButton[]

Buttons set by the User at design-time to appear in the top corner of the Dashboard - next to the Visible Function Buttons

These buttons - if provided - are always present and cannot be removed at design time.

When a button is clicked the DashboardButtonClicked event is fired.

Optional CustomToolbars

CustomToolbars: CustomToolbar[]

Toolbars provided by the User

Each Custom toolbar contains a Name (to identify it) and a Title.

It can optionally also contain a Glyph and an array of ToolbarButton.

Optional FloatingPosition

FloatingPosition: AdaptableCoordinate

The position of the Dashboard when in 'floating mode'.

This property is set by AdapTable and stored so the Dashboard will be in the same position when the grid next starts.

Optional HomeToolbarTitle

HomeToolbarTitle: string

The 'title' to display in the the Dashboard Header

If no value is provided then it will display the value of the 'adaptableId' property in Adaptable Options

Note: It is called HomeToolbarTitle for backward compatibiility

Default Value: the adaptableId property in Adaptable Options

Optional IsCollapsed

IsCollapsed: boolean

Whether or not the Dashboard is collapsed.

If the Dashboard is collapsed then only the header is visible but not the contents of any tabs.

Default Value: False

Optional IsFloating

IsFloating: boolean

Whether or not the Dashboard is floating.

If the Dashboard is floating then it will appear anywhere you drag it to (in minmised form).

Double-click the Dashboard header to revert it to its default position above the grid.

Default Value: False

Optional IsInline

IsInline: boolean

An alternative way of showing the Dashboard in 'Expanded' view.

Instead of a Header and Body it has the headers section to the left of the Toolbars. (Similar to how it was pre Version 6.1)

Default Value: False

Optional Revision

Revision: number

The 'version' number of the Item - used for when developers want to update one section in Predefined Config while keeping others unchanged.

Optional ShowFunctionsDropdown

ShowFunctionsDropdown: boolean

Whether to show the Home dropdown in the Dashboard Header.

If 'true' (the default) then the dropdown will be visible as the first item (with a 'house' icon).

Clicking the button will open a dropdown listing all the Functions that your Entitlements allows.

Selecting a menu item in the dropdown will open the associated popup for that Function.

Default Value: true

Optional ShowQuickSearchInHeader

ShowQuickSearchInHeader: boolean

Whether to show the Quick Search textbox in the Dashboard Header.

If 'true' (the default) then the textbox will be visible.

Default Value: true

Optional Tabs

Tabs: DashboardTab[]

A tab is a named group of Toolbars.

You can create as many tabs as you want, but please ensure that each Toolbar is only in one tab.

Note: if you do not provide a Tab in your config then AdapTable will create one for you named 'Toolbars'

Optional VisibleButtons

VisibleButtons: AdaptableFunctionButtons

Which Function Buttons should be visible in the Dasbhoard Header when the application loads.

Each button is connected to a Function in AdapTable and opens the relevant popup screen.

Default Value: 'SystemStatus', 'GridInfo', 'Layout', 'ConditionalStyle'

Generated using TypeDoc