AdaptableState
The Adaptable State is an JavaScript object you pass to the <Adaptable.Provider /> component and describes the current state of the Adaptable instance.
It contains information on views, styled cells, custom sorts, dashboard, quick search and all the other Adaptable modules.
Each module has it's own property in the state object - eg: for dashboard use state.dashboard and for the view module use state.view.
Most importantly, the state also defines the primaryKey of the data in Adaptable.
interface AdaptableState extendsExtends
Internal_AdaptableState
Properties
| Property | Description |
|---|---|
| alert | Controls the state for the alerts |
| config | Controls the state for the Config module - this includes the color palette and the application name. |
| contextMenu | Configures the state for the Context Menu module |
| customSort | Configures the state for the Custom Sort module |
| dashboard | Controls the Dashboard state |
| export | Controls the state for the export module - configures which reports are available |
| flashingCell | Controls the state for the Flashing Cells module |
| globalEntities | Defines what columns are available in Adaptable. |
| grid | Controls the state for managing grid properties used to render the grid - row height, column header height, zebra rows and more. |
| quickSearch | Controls the Quick Search state |
| styledCell | Handles the state for styled cells definitions |
| theme | Specifies the theme for the AdapTable instance |
| view | Configures the state for the your views |
Property Details
alert
Controls the state for the alerts
alert: AlertState;Property Value
config
Controls the state for the Config module - this includes the color palette and the application name.
config: ConfigState;Property Value
contextMenu
Configures the state for the Context Menu module
contextMenu: ContextMenuState;Property Value
customSort
Configures the state for the Custom Sort module
customSort: CustomSortState;Property Value
dashboard
Controls the Dashboard state
dashboard: DashboardState;Property Value
export
Controls the state for the export module - configures which reports are available
export: ExportState;Property Value
flashingCell
Controls the state for the Flashing Cells module
flashingCell: FlashingCellsState;Property Value
globalEntities
Defines what columns are available in Adaptable.
globalEntities?: AdaptableStateEntities;Property Value
grid
Controls the state for managing grid properties used to render the grid - row height, column header height, zebra rows and more.
grid: GridState;Property Value
quickSearch
Controls the Quick Search state
quickSearch: QuickSearchState;Property Value
styledCell
Handles the state for styled cells definitions
styledCell: StyledCellState;Property Value
theme
Specifies the theme for the AdapTable instance
theme: AdaptableThemeState;Property Value
AdaptableThemeState
view
Configures the state for the your views
view: AdaptableViewState;