PredefinedConfig

This is the main Predefined Config interface which developers will populate at design-time

TypeScript
export interface PredefinedConfig

Properties

PropertyDescription
AlertSupplies a collection of Alert Definition objects which will fire when their definition is triggered, and where Alerts are displayed
ApplicationEmpty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.
CalculatedColumnSupplies a collection of CalculatedColumn objects that will display a value based on other cells in the row (using a Calculated Column Expression)
ChartCollection of Charts to enable seeing grid data visually in chart format (requires Chart plugin)
ConditionalStyleSupplies a collection of ConditionalStyle objects to provides columns and rows with a particular style when the data matches a given rule
CustomSortSupplies a collection of Custom Sort objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
DashboardLarge 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
DataSourceSupplies a collection of DataSource objects to facilitate replacing the DataSource in the Grid with an alternate set of data (e.g. a Book or Stored Proc name)
ExportSupplies a collection of Report objects, together with name of the Current Report, as part of AdapTable export Module
FilterStores Filters in AdapTable - both System and Column (predicate) Filters
FormatColumnSupplies a collection of FormatColumn objects that will style an entire column in a single way (and not subject to a rule like with Conditional Style).
FreeTextColumnSupplies a 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.
LayoutSupplies a collection of Layout objects to name and manage groups of column visibility, order and sorts.
PlusMinusSupplies a collection of PlusMinus rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
QueryNamed Queries available for use across multiple AdapTable Modules; and CurrentQuery - an Expression to run at start-up
QuickSearchConfigues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
ScheduleSupplies a collection of Schedule objects
ShortcutSupplies a collection of Shortcut objects to aid data entry and prevent 'fat finger' issues
SparklineColumnColumns - where data type is a numeric array - which is rendered as a Sparkline Chart - only populated at Design Time
ThemeSpecifies the current Theme and lists the User and System themes available for selection.
ToolPanelSets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)
UserInterfaceSection (only populated at Design Time) that manages UI-related elements in AdapTable

Property Details

ActionColumn

TypeScript
ActionColumn?: any;
Deprecated
  • use User Interface Options
Property Value

any

Alert

Supplies a collection of Alert Definition objects which will fire when their definition is triggered, and where Alerts are displayed

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

Supplies a 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

CellSummary

TypeScript
CellSummary?: any;
Deprecated
  • use General Options
Property Value

any

Chart

Collection of Charts to enable seeing grid data visually in chart format (requires Chart plugin)

TypeScript
Chart?: ChartState;
Property Value

ChartState

ConditionalStyle

Supplies a collection of ConditionalStyle objects to provides columns and rows with a particular style when the data matches a given rule

TypeScript
ConditionalStyle?: ConditionalStyleState;
Property Value

ConditionalStyleState

CustomSort

Supplies a 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

DataSource

Supplies a collection of DataSource objects to facilitate replacing the DataSource in the Grid with an alternate set of data (e.g. a Book or Stored Proc name)

TypeScript
DataSource?: DataSourceState;
Property Value

DataSourceState

Entitlements

TypeScript
Entitlements?: any;
Deprecated
  • entitlements are now set in Entitlement Options
Property Value

any

Export

Supplies a collection of Report objects, together with name of the Current Report, as part of AdapTable export Module

TypeScript
Export?: ExportState;
Property Value

ExportState

Filter

Stores Filters in AdapTable - both System and Column (predicate) Filters

TypeScript
Filter?: FilterState;
Property Value

FilterState

FlashingCell

TypeScript
FlashingCell?: FlashingCellState;
Deprecated
  • DO NOT USE - flashing cell is now part of Alert
Property Value

FlashingCellState

FormatColumn

Supplies a collection of FormatColumn objects that will style an entire column in a single way (and not subject to a rule like with Conditional Style).

TypeScript
FormatColumn?: FormatColumnState;
Property Value

FormatColumnState

FreeTextColumn

Supplies a 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
FreeTextColumn?: FreeTextColumnState;
Property Value

FreeTextColumnState

GradientColumn

TypeScript
GradientColumn?: GradientColumnState;
Deprecated
  • DO NOT USE - Gradient Column is now part of Format Column
Property Value

GradientColumnState

Layout

Supplies a collection of Layout objects to name and manage groups of column visibility, order and sorts.

TypeScript
Layout?: LayoutState;
Property Value

LayoutState

PercentBar

TypeScript
PercentBar?: PercentBarState;
Deprecated
  • DO NOT USE - Percent Bar is now part of Format Column
Property Value

PercentBarState

PlusMinus

Supplies a collection of PlusMinus rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell

TypeScript
PlusMinus?: PlusMinusState;
Property Value

PlusMinusState

Query

Named Queries available for use across multiple AdapTable Modules; and CurrentQuery - an Expression to run at start-up

TypeScript
Query?: QueryState;
Property Value

QueryState

QuickSearch

Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows

TypeScript
QuickSearch?: QuickSearchState;
Property Value

QuickSearchState

Schedule

Supplies a collection of Schedule objects

TypeScript
Schedule?: ScheduleState;
Property Value

ScheduleState

Shortcut

Supplies a collection of Shortcut objects to aid data entry and prevent 'fat finger' issues

TypeScript
Shortcut?: ShortcutState;
Property Value

ShortcutState

SparklineColumn

Columns - where data type is a numeric array - which is rendered as a Sparkline Chart - only populated at Design Time

TypeScript
SparklineColumn?: SparklineColumnState;
Property Value

SparklineColumnState

SystemStatus

TypeScript
SystemStatus?: any;
Deprecated
  • use System Status Options
Property Value

any

Theme

Specifies the current Theme and lists the User and System themes available for selection.

TypeScript
Theme?: ThemeState;
Property Value

ThemeState

ToolPanel

Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)

TypeScript
ToolPanel?: ToolPanelState;
Property Value

ToolPanelState

UpdatedRow

TypeScript
UpdatedRow?: UpdatedRowState;
Deprecated
  • flashing cell is now part of Alert
Property Value

UpdatedRowState

UserInterface

Section (only populated at Design Time) that manages UI-related elements in AdapTable

TypeScript
UserInterface?: any;
Property Value

any