Tool Panel

An alternative to using the Dashboard is the AdapTable Tool Panel.

important

The AdapTable Tool Panel has many of the same features as the Dashboard (except for Custom Toolbars) and is ideal for when screen estate is at a premium.

The Tool Panel is the collapsible area to the right of the Grid.

caution

The Tool Panel is only available when using ag-Grid as the underlying vendor Grid

Making AdapTable Tool Panel available

In order to ensure the AdapTable Tool Panel is available, follow these steps:

  1. Ensure that the Entitlement for the Tool Panel Function does not have an Access Level of 'Hidden'

  2. Set showAdaptableToolPanel to true in User Interface Options section of Adaptable Options.

  3. Set the Sidebar property in GridOptions

    tip

    AdapTable will automatically add the Tool Panel into the Sidebar if this property is set to 'true' or to the names of ag-Grid Tool Panels; but not if it is missing or set to 'false'

Framework Wrappers

warning

There are additional steps required if wanting to use the AdapTable Tool Panel with a Framework Wrapper.

See the relevant instructions for the React Wrapper and for the Angular Wrapper

Tool Panel Name

By default the Tool Panel will display the word 'AdapTable'.

This can be changed by providing a value for the adaptableToolPanelTitle property in User Interface Options section of Adaptable Options.

Functions with Tool Panels

The Adaptable Functions which have Tool Panel components are:

Tool Panel Settings

There are a number of properties available in Tool Panel Predefined Config:

AdaptableToolPanels

Sets which ToolPanels should be available to the User to choose to use.

If this value is empty, then ALL Adaptable ToolPanels will be available.

tip

Provide an empty array for no ToolPanels to be visible

VisibleToolPanels

Sets which ToolPanels should be visible in the Adaptable ToolPanel when your application first loads.

note

Note: If the AvailableToolPanels property has been set, then the visible toolbars listed here must also be included there.

VisibleButtons

Sets which Function Buttons should be visible in the Adaptable ToolPanel when the application first loads.

tip

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

ShowFunctionsDropdown

Whether to show the Home dropdown in the Adaptable ToolPanel.

If 'true' 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 popup for that Function.

ShowColumnsDropdown

Whether to show the Columns dropdown in the Adaptable ToolPanel.

If 'true' then the dropdown will be visible as the penultimate item.

Clicking the button will open a dropdown listing all the Columns in your grid. You can click the checkbox to show / hide the column.

Note: if you want to move Columns in your Grid then you need to update the Layout.

ShowToolPanelsDropdown

Whether to show the ToolPanels dropdown in the Adaptable ToolPanel.

If 'true' then the dropdown will be visible as the last item.

Clicking the button will open a dropdown listing all the ToolPanels available (see the AvailableToolPanels property). You can click the checkbox to show / hide the ToolPanel.

Note: if you want to move / reposition the ToolPanels in the Adaptable ToolPanel then you need to open the ToolPanel Configuration popup (via the configure button).