AdapTable Dashboard
Summary
- The Dashboard provides quick access to commonly used AdapTable functionality
- It contains a number of items including:
- Tabs and Toolbars (including Custom Toolbars)
- Dashboard Buttons
- Quick Search
- The Dashboard can be viewed in multiple ways:
- Collapsed
- Inline
- Floating
- Hidden
The Dashboard is designed to make it easy for run-time users to access AdapTable functionality.
Hint
- The Dashboard is typically, and by default, placed above AG Grid
- However Dashboard placement - like everything else Dashboard related - is fully customisable and configurable
Dashboard Elements
The Dashboard contains 3 main elements:
- Toolbars - both Module and Custom - which can be placed in Tabs or pinned above the Grid
- Adaptable Buttons - both Module and Custom
- Quick Search component
All of these controls are highly configurable and customisable with a wealth of options available.
Tabs and Toolbars
One of the main elements in the Dashboard are Toolbars, which contain small UI controls.
AdapTable supports 2 types of Toolbars:
- Module (i.e. shipped by AdapTable): collections of controls providing quick, easy access to a single Module
- Custom (i.e. user-provided): bespoke Toolbars which contain fully custom-rendered content
Toolbars can be displayed in 2 ways:
- grouped into named Tabs for ease of use
- pinned above the Grid
Find Out More
- See Tabs and Toolbars for a list of which Modules supply Toolbars
- The Guide to Custom Toolbars explains how to provide bespoke content to the Dashboard
Dashboard Buttons
The Dashboard contains Adaptable Buttons as shortcuts to particular actions. These can be:
-
Module Buttons - supplied by AdapTable which open the associated section in the Settings Panel
-
Custom Buttons - provided by Developers at design-time which perform bespoke actions when clicked
Find Out More
See Dashboard Buttons for further details
- This example shows elements of the AdapTable Dashboard (explained in more detail in the other pages in this section). These include:
- 3 Tabs each with a collection of Toolbars:
Admin,Edit,Custom Tab AdminandEditTabs contain Toolbars provided by AdapTableCustom Tabcontains 2 Custom Toolbars:Buttons- contains 2 AdapTable Buttons (to switch theme and show time)BespokeRendering - has bespoke content
- 1 Pinned Toolbar -
GridFilter- which sits above the Grid - 5 Module Dashboard Buttons -
FormatColumn,DataChangeHistory,CalculatedColumn,Shortcut,SettingsPanel - 1 Custom Dashboard Button - which switches the Theme
Quick Search Input
The Quick Search Input is displayed, by default, on the right hand side of the Dashboard.
It performs a simple text search across all visible columns in AG Grid (using the Quick Search Module).
Dashboard Modes
There are a number of different Modes for viewing Dashboard content:
- Default - Visible, placed above AG Grid, and expanded (so contents of the first Tab are visible)
- Inline - screen estate saving option where Header collapses to become the first Toolbar, and a dropdown displays a list of available Tabs
- Collapsed - displays just Header, Title, Buttons & Quick Search; Toolbars are not visible and only appear when the name of the Tab is clicked
- Floating - smaller Header with just Title showing; displays on top of AG Grid (used as space saving feature)
- Hidden - hides Dashboard so not initially visible (but it is instantiated by AdapTable)
Find Out More
See Dashboard Modes for more information and demo examples
Configuring the Dashboard
AdapTable provides developers with full flexibility and control over every element in the Dashboard.
Note
This is done via a mixture of Dashboard Initial State and properties in Dashboard Options
Configuration options for developers include:
- Tabs and Module Toolbars
- Custom Toolbars
- Module Buttons
- Custom Buttons
- Dashboard Modes
- Dashboard Header Text
- Application Icon
- Quick Search Input
Find Out More
See Configuring the Dashboard at Design Time for full details on how to provide or set each of these elements
Using the Dashboard
Run Time users are able to re-configure their Dashboard if needed.
In particular they can use the Dashboard section of the Settings Panel to:
- Create / Edit / Delete Tabs
- Decide which Toolbars are visible and placed into which Tab
- Manage Pinned Toolbars
- Configure the order and visiblity of Module (but not Custom) Dashboard Buttons
- Switch between Dashboard Modes
Find Out More
See Configuring the Dashboard via the Settings Panel for details on runtime Dashboard configuration
Setting UI Entitlements
UI Entitlements behaviour for the Dashboard is as follows:
-
Full- fully visible and configurable -
ReadOnly- cannot be configured (but can be expanded / hidden / floated etc.); toolbars cannot be closed or re-ordered. -
Hidden- entirely hidden from the User and can never be displayed
AdapTable Dashboard
FAQ
Why can I not see some toolbars in my Dashboard that other user have?
First check that they've not been closed; you can see available toolbars in the Dashboard section of the Settings Panel.
If the toolbar is not listed there then the Module might be marked as Hidden in your Entitlements which means you don't have access to see it.
Why do I see a tab called 'Toolbars'? In older versions of AdapTable a Tab named 'Toolbars' (containing a default set of Toolbars) was created automatically, if no Toolbars were provided. This was removed in Version 11.
Can I add my own content to the Dashboard?
Yes, the customToolbars and customDashboardButtons properties in Dashboard Options serve precisely this purpose.
Is there a way to see just the Toolbars without creating a Tab? Yes, you can do this in 2 ways:
- Create Pinned Toolbars (which will sit above the Grid and don't require a Tab)
- Use Inline Mode and you only see one Tab (the Tab selector dropdown will be hidden).
Can I prevent my users from moving Toolbars and Tabs around?
Yes, set the Entitlements accessLevel for the Dashboard Module to ReadOnly