Status Bar Technical Reference
Summary
- Status Bars are defined at design time through Status Bar Initial State
- They are accessed at run-time through Status Bar API section of AdapTable API
Status Bar State
The Status Bar State section contains a collection of StatusBar objects:
| Property | Description | Default |
|---|---|---|
| StatusBars | Adaptable Status Bars to display - can be unlimited and displayed in 3 locations | null |
Status Bar Definition
Each Adaptable Status Bar is defined as follows:
| Property | Description |
|---|---|
| Key | Key of Status Bar Panel as defined in AG Grid GridOptions - ensure keys are the same (note: AG Grid statusPanel is lowercase 'key') |
| StatusBarPanels | Module Status Panels to render inside Adaptable Status Bar |
Status Bar API
The Status Bar API section provides these functions:
| Method | Description |
|---|---|
| getAdaptableStatusBars() | Retrieves current AdapTable Status Bar Panels |
| getAgGridStatusPanels() | Retrieves current AG Grid Status Bar Panels |
| setStatusBarPanels(statusPanels) | Sets Adaptable Status Bar Panels |