AdapTable Status Bar

Summary

The AdapTable Status Bar allows AdapTable-related content to be placed in the AG Grid Status Bar
Unlimited Status Bar Panels can be configured and placed in 3 locations: left, right or centre
Each Status Bar Panel can contain multiple Module Status Panels
Most Status Bar Panels provide shortcut buttons to the Module's Settings Panel screen
But some Modules (e.g. Layout, Export) provide Status Panels that contain in-place, custom functionality

Status Bars allow AdapTable content to be displayed, and accessed, from inside the AG Grid Status Bar.

This content is provided by AdapTable via Status Bar Panels - each displaying content for a specific Module.

Hint

This is particularly useful when screen real estate is constrained, as Status Bars replace much Dashboard content

Status Bar Locations

Each AdapTable Status Bar Panel can be displayed in 3 locations inside the AG Grid Status Bar:

left
center
right

Each Adaptable Status Bar Panel can include multiple Module Status Bar Panels.

Note

Only a maximum of 3 AdapTable Status Panels can be displayed
But there is no limit on the number of Module Status Bar Panels that can be displayed inside each Status Panel

Caution

The contents (i.e. Module Status Panels) of each AdapTable Status Bar Panel can be changed in the AdapTable UI
However the location and number of Status Panels can only be set at Design Time

AdapTable Status Bar

Fork Fork

This demo contains 3 Adaptable Status Bar Panels populated as follows:
- Left Status Bar: CellSummary, Filter
- Center Status Bar: GridFilter
- Right Status Bar: Layout, Theme

Expand to see how the Status Bars are configured

The Status Bars are defined inside Grid Options:

export const gridOptions: GridOptions = {
  statusBar: {
    statusPanels: [
      {
        key: 'Left Panel',
        statusPanel: 'AdaptableStatusPanel',
        align: 'left',
      },
      {
        key: 'Center Panel',
        statusPanel: 'AdaptableStatusPanel',
        align: 'center',
      },
      {
        key: 'Right Panel',
        statusPanel: 'AdaptableStatusPanel',
        align: 'right',
      },
    ],
  },
};

and then referenced in Initial Adaptable State:

StatusBar: {
  StatusBars: [
    {
      Key: 'Left Panel',
      StatusBarPanels: ['CellSummary', 'ColumnFilter'],
    },
    {
      Key: 'Center Panel',
      StatusBarPanels: ['GridFilter'],
    },
    {
      Key: 'Right Panel',
      StatusBarPanels: ['Layout', 'Theme'],
    },
  ],
},

Try It Out

Open the Status Bar page of the Settings Panel and add other Status Panels

Module Status Bar Panels

Every Adaptable Module has a Status Panel that can be displayed.

Many simply provide an icon which, when clicked, opens the relevant Settings Panel page for that Module.

However the following Modules render much richer Status Panels with in-place functionality:

Adaptable Module	Status Panel Description
Alerts	Displays any Alerts which have fired
Cell Summary	Shows all the Cell Summaries available
Charts	Displays any saved Charts
Column Filters	Lists any currently applied Column Filters
Data Set	Users can switch between available Data Sets
Export	All Reports can be sent to all Destinations
Grid Filter	The currently applied Grid Filter can be seen (and edited)
Layout	Users can switch between the available Layouts
Quick Search	Quick Search input where searches can be run
Theme	The Current Theme can be changed

Note

All the AG Grid Status Panels (e.g. FilteredRowCount) are, of course, still available for selection

AdapTable and AG Grid Status Bars

Fork Fork

This demo shows how you can use the Adaptable Status Bar Panels together with those provided by AG Grid.
There are 3 Status Panels defined, which together include 5 Status Bar Panels (a mixture of AG Grid and AdapTable):
- Left - AG Grid's Row Count
- Center: AdapTable's' Export,
- Right: AG Grid's Filtered Row Count, sandwiched between 2 AdapTable Status Panels - Filter and Cell Summary

Managing the Status Bar

Developers are able to configure whether the Status Bar is visible and how many panels it contains.

Run-time users can configure which Status Bar Panels are visible in each of the provided Status Bars.

Find Out More

See Configuring the Status Bar for the steps required by developers to provide the Status Bar

Using the Status Bar

Run-time users of AdapTable are able to edit which Status Panels are visible in the AG Grid Status Bar.

This is done in the Status Bar section of the Settings Panel which shows all the available Status Bars with a list of the available Status Bar Panels above them.

Users can simply drag and drop a Panel into the relevant container to update the Status Bar.

Caution

Users cannot change the number or location of the Status Bars
The can only update the contents of each Status Bar

FAQ

Can we provide custom content to the Status Bar like with Dashboard and Tool Panels? Not currently, but this will be available in future versions of AdapTable if there is a desire for it

Can I still use AG Grid Status Bar controls if I use AdapTable's Status Panels? Yes, you are able to mix and match the 2 as much as you want

PreviousTechnical Reference NextConfiguring Status Bar