InitialState

The initial state of Adaptable which is populated at design-time and used to create the Adaptable State - must include at least one Layout.

TypeScript

export interface

Properties

Property	Type	Description
Alert	`AlertState`	Collection of `AlertDefinitions` which will fire Alerts when the rule is met
Application	`ApplicationState`	Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.
CalculatedColumn	`CalculatedColumnState`	Collection of CalculatedColumn objects that will display a value based on other cells in the row (using a Calculated Column Expression)
Charting	`ChartingState`	Named Charts (wrapping Chart models)
CustomSort	`CustomSortState`	Collection of Custom Sort objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
Dashboard	`DashboardState`	Large series of properties to give users full control over the look and feel of the Dashboard - the section above the grid with toolbars and buttons
Export	`ExportState`	Collection of Report objects, together with name of the Current Report, as part of AdapTable export Module
FlashingCell	`FlashingCellState`	Definitions of which cells flash in response to data changes
FormatColumn	`FormatColumnState`	Collection of FormatColumn objects that will style an entire column either fully or using a Condition
FreeTextColumn	`FreeTextColumnState`	Collection of FreeText objects that define user-owned columns whose cell values are stored in Adaptable State (not the grid DataSource). Use for editable per-row fields such as ops notes, flags, or codes — distinct from cell-level Notes and Comments.
Layout	`LayoutState`	Collection of Layouts to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.
NamedQuery	`NamedQueryState`	Named Queries available for use across multiple AdapTable Modules
Note	`NoteState`	Collection of personal Notes that are edited at Cell level
PlusMinus	`PlusMinusState`	Plus Minus module: nudge rules. Optional `IncrementKey` / `DecrementKey` on each nudge accept either a single key or a keyboard shortcut combination (e.g. `shift+Enter`); when omitted, `AdaptableOptions.plusMinusOptions` applies, then `+` / `-`.
QuickSearch	`QuickSearchState`	Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
Shortcut	`ShortcutState`	Collection of Shortcut objects to aid data entry and prevent 'fat finger' issues
StatusBar	`StatusBarState`	Configures the Adaptable Status Bar
StyledColumn	`StyledColumnState`	Collection of Special Column Styles
Theme	`ThemeState`	Specifies current Theme and lists User and System themes available for selection
ToolPanel	`ToolPanelState`	Sets order & visibility of Tool Panel controls in AdapTable ToolPanel (on right of grid)
UserInterface	`UserInterfaceState`	Controls the visibility of AdapTable UI elements (Dashboard, Tool Panel, Status Bar, Menus etc.)

Property Details

Alert

Collection of AlertDefinitions which will fire Alerts when the rule is met

TypeScript

Alert?: AlertState;

Property Value

AlertState

Application

Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.

TypeScript

Application?: ApplicationState;

Property Value

ApplicationState

CalculatedColumn

Collection of CalculatedColumn objects that will display a value based on other cells in the row (using a Calculated Column Expression)

TypeScript

CalculatedColumn?: CalculatedColumnState;

Property Value

CalculatedColumnState

Charting

Named Charts (wrapping Chart models)

TypeScript

Charting?: ChartingState;

Property Value

ChartingState

CustomSort

Collection of Custom Sort objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways

TypeScript

CustomSort?: CustomSortState;

Property Value

CustomSortState

Dashboard

Large series of properties to give users full control over the look and feel of the Dashboard - the section above the grid with toolbars and buttons

TypeScript

Dashboard?: DashboardState;

Property Value

DashboardState

Export

Collection of Report objects, together with name of the Current Report, as part of AdapTable export Module

TypeScript

Export?: ExportState;

Property Value

ExportState

FlashingCell

Definitions of which cells flash in response to data changes

TypeScript

FlashingCell?: FlashingCellState;

Property Value

FlashingCellState

FormatColumn

Collection of FormatColumn objects that will style an entire column either fully or using a Condition

TypeScript

FormatColumn?: FormatColumnState;

Property Value

FormatColumnState

FreeTextColumn

Collection of FreeText objects that define user-owned columns whose cell values are stored in Adaptable State (not the grid DataSource). Use for editable per-row fields such as ops notes, flags, or codes — distinct from cell-level Notes and Comments.

TypeScript

FreeTextColumn?: FreeTextColumnState;

Property Value

FreeTextColumnState

Layout

Collection of Layouts to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.

TypeScript

Layout: LayoutState;

Property Value

LayoutState

NamedQuery

Named Queries available for use across multiple AdapTable Modules

TypeScript

NamedQuery?: NamedQueryState;

Property Value

NamedQueryState

Note

Collection of personal Notes that are edited at Cell level

TypeScript

Note?: NoteState;

Property Value

NoteState

PlusMinus

Plus Minus module: nudge rules. Optional IncrementKey / DecrementKey on each nudge accept either a single key or a keyboard shortcut combination (e.g. shift+Enter); when omitted, AdaptableOptions.plusMinusOptions applies, then + / -.

TypeScript