AdapTable Version:

Framework:

AdapTable Tool Panel

Summary

The AdapTable Tool Panel Component provides access to all functionality available in AdapTable
It is situated in the AG Grid Sidebar - the collapsible area typically positioned at the right of the Grid
It is often used as an alternative to the Dashboard when screen estate is at a premium

The AdapTable Tool Panel Component is a bespoke Tool Panel which sits inside the AG Grid Sidebar.

It provides AdapTable-related functionality and comprises 2 main types of content:

A set of Tool Panels which contain related pieces of functonality
Adaptable Buttons that will perform frequently required actions when clicked

Note

Both the Tool Panel and Button collections can contain items shipped by AdapTable
They can also display custom items supplied by developers at design-time

The Component is typically named 'AdapTable' and is the last of the Tool Panels displayed.

However all this is fully configurable.

Find Out More

The Tool Panel Set-up Guide contains full instructions on how to set up the AdapTable Tool Panel Component

AdapTable Tool Panel: Introduction

Fork Fork

The AdapTable Tool Panel Component by default sits on the right hand side of the grid in the AG Grid sidebar
It is typically the 3rd Tool Panel on display after the AG Grid Filters and Columns Tool Panels
Here the AdapTable Tool Panel Component has been set to open automatically when the Grid initialises

Module Tool Panels

The Tool Panel Component includes a number of Module Tool Panels - which are shipped by AdapTable.

Each Module Tool Panel contains module-specific functionality and controls.

For instance the Layout Toolpanel contains a Layout selector and Add, Clone, Edit and Delete buttons.

Caution

The Tool Panel will not be available for any Module which has an Entitlement of Hidden

Custom Tool Panels

Developers are able to provide custom Tool Panels containing bespoke elements.

They are rendered inside the Adaptable Tool Panel Component alongside the Module Tool Panels.

Note

Once defined, Custom Tool Panels can be configured and used in the same way as Module Tool Panels

Similar to Custom Dashboard Toolbars they can contain 2 different sets of content:

Buttons - an array of Adaptable Button
Bespoke content - for when more than buttons are required

Custom Tool Panel are provided in the customToolPanels property of Tool Panel Options.

Tool Panel Buttons

The area at the top of the AdapTable Tool Panel Component can display a group of Buttons:

Similar to Tool Panels, these can be of 2 types:

Module Buttons - provided by AdapTabe and open the relevant Module Page in the Settings Panel
Custom Buttons - supplied by users at design-time and contain bespoke functionality

Using the AdapTable Tool Panel

The AdapTable Tool Panel can be customised by users at run-time.

The Configure button in the Adaptable Tool Panel header opens the Tool Panel Section of the Settings Panel.

Note

This button (which looks like a wrench) is hidden if the Entitlement is ReadOnly

This window contains 2 tabs:

Tool Panels: sets order and visibility of the Tool Panels - both Module and Custom
Module Buttons: sets order and visibility of the Module Buttons

Caution

Only Module Buttons can be set in this tab - and not Custom Buttons

Configuring the AdapTable Tool Panel

Tool Panel configuration is managed in both AG Grid and AdapTable.

The division between the 2 is as follows:

AG Grid GridOptions: manages the overall components, their order, icons, names, widths etc.

Find Out More

See the Guide to setting up the Tool Panel for full details on setting up Tool Panel Components

AdapTable Tool Panel Adaptable State: definitions for Module Tool Panels and Module Buttons
AdapTable Tool Panel Options: definitions for Custom Tool Panels and Custom Buttons

AdapTable Tool Panel: Configuration

Fork Fork

In this example, the AdapTable Tool Panel Component has been configured with these overrides:
- placed first in the list (and with Filter Tool Panel hidden)
- set to open at start-up
- been renamed 'Grid Manager'
- given a new icon
- provided with a bigger initial width (and minimum width)
- set with column dropdown not visible

Open to see a custom Tool Panel configuration

In AG Grid GridOptions we define the sideBar like this:

sideBar: {
  toolPanels: [
    {
      id: 'adaptable',
      toolPanel: 'AdaptableToolPanel',
      labelDefault: 'Grid Manager',
      labelKey: 'Grid Manager',
      iconKey: 'columnMoveValue',
      minWidth: 150,
      width: 400,
    },
    'columns',
    ],
},

We set the Panels dropdown to be hidden in ToolPanelOptions:

toolPanelOptions:{
  showToolPanelsDropdown: false
},

Note

The custom icon has to be provided with the standard AG Grid mechanism, see AG Grid custom icons for more details

Find Out More

See Module Tool Panels for details on how to configure Module Tool Panels
See Custom Tool Panels for details on how to configure Custom Tool Panels
See Tool Panel Buttons for details on how to provide Tool Panel buttons

FAQ

Why can't I clear the Settings Panel Module Button? It keeps coming back! If alwaysShowInDashboard in set to true in Settings Panel Options, the Settings Panel button will always display

How do I display only the AG Grid Tool Panels? Provide this in AG Grid GridOptions, e.g.:

sideBar = ['columns', 'filters'];

Can I display just the Adaptable Tool Panel? Yes - provide 'adaptable' as the only entry in the sideBar property in GridOptions:

sideBar = ['adaptable'];

PreviousTechnical Reference NextModule Tool Panels