AdapTable Version:

Framework:

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	Description
Alert	Collection of `AlertDefinitions` which will fire Alerts when the rule is met
Application	Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.
CalculatedColumn	Collection of CalculatedColumn objects that will display a value based on other cells in the row (using a Calculated Column Expression)
Charting	Named Charts (wrapping Chart models)
CustomSort	Collection of Custom Sort objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
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
Export	Collection of Report objects, together with name of the Current Report, as part of AdapTable export Module
FlashingCell	Definitions of which cells flash in response to data changes
FormatColumn	Collection of FormatColumn objects that will style an entire column either fully or using a Condition
FreeTextColumn	Collection of FreeText objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource). Useful if needing a 'Comments' column.
Layout	Collection of Layouts to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.
NamedQuery	Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up
Note	Collection of personal Notes that are edited at Cell level
PlusMinus	Collection of PlusMinus rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
QuickSearch	Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
Schedule	Collection of Schedule objects
Shortcut	Collection of Shortcut objects to aid data entry and prevent 'fat finger' issues
StatusBar	Configures the Adaptable Status Bar
StyledColumn	Collection of Special Column Styles
Theme	Specifies current Theme and lists User and System themes available for selection
ToolPanel	Sets order & visibility of Tool Panel controls in AdapTable ToolPanel (on right of grid)
UserInterface	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 so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource). Useful if needing a 'Comments' column.

TypeScript