AdaptableOptions

Large group of options enabling developers to set up AdapTable at design time to fit precise requirements

export interface AdaptableOptions<TData = any, TContext = Record<string,

Properties

Property Details

actionColumnOptions

Options for managing Action Columns

actionColumnOptions?: ActionColumnOptions<TData>;

Property Value

ActionColumnOptions<TData>

adaptableContext

Application-specific context object - is included by AdapTable in all callbacks and Events

adaptableContext?: TContext;

Default Value

Property Value

TContext

adaptableId

Identifier for this instance of AdapTable

adaptableId?: string;

Default Value

'adaptable_id_$random_number'

Property Value

string

adaptableStateKey

Identifier used as localStorage persistence key for AdaptableState

adaptableStateKey?: string;

Default Value

adaptableId value

Property Value

string

alertOptions

Options for managing Alerts in AdapTable

alertOptions?: AlertOptions<TData>;

Property Value

AlertOptions<TData>

autogeneratePrimaryKey

Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities

autogeneratePrimaryKey?: boolean;

Default Value

false

Property Value

boolean

calendarOptions

Options for managing Holidays and Working Days

calendarOptions?: CalendarOptions;

Property Value

CalendarOptions

cellSummaryOptions

Options for adding custom Cell Summaries

cellSummaryOptions?: CellSummaryOptions<TData>;

Property Value

CellSummaryOptions<TData>

chartingOptions

Options for managing AG Grid's Charting

chartingOptions?: ChartingOptions;

Property Value

ChartingOptions

columnMenuOptions

Options for managing AdapTable Column Menu

columnMenuOptions?: ColumnMenuOptions<TData>;

Property Value

ColumnMenuOptions<TData>

columnOptions

Options related to Columns

columnOptions?: ColumnOptions;

Property Value

ColumnOptions

commentOptions

Options for managing collaborative Comments

commentOptions?: CommentOptions<TData>;

Property Value

CommentOptions<TData>

containerOptions

Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed

containerOptions?: ContainerOptions;

Property Value

ContainerOptions

contextMenuOptions

Options for managing AdapTable Context Menu

contextMenuOptions?: ContextMenuOptions<TData>;

Property Value

ContextMenuOptions<TData>

customSortOptions

Options for using Custom Sort

customSortOptions?: CustomSortOptions;

Property Value

CustomSortOptions

dashboardOptions

Options for managing the Dashboard in AdapTable

dashboardOptions?: DashboardOptions;

Property Value

DashboardOptions

dataChangeHistoryOptions

Options to manage Data Change History Module which provides an overview of all data changes

dataChangeHistoryOptions?: DataChangeHistoryOptions<TData>;

Property Value

DataChangeHistoryOptions<TData>

dataImportOptions

Options for managing the Data Import function

dataImportOptions?: DataImportOptions;

Property Value

DataImportOptions

dataSetOptions

Options to manage Data Sets

dataSetOptions?: DataSetOptions<TData>;

Property Value

DataSetOptions<TData>

editOptions

Options related to Editing in AdapTable including Server Validation

editOptions?: EditOptions<TData>;

Property Value

EditOptions<TData>

entitlementOptions

Options for managing Entitlements

entitlementOptions?: EntitlementOptions;

Property Value

EntitlementOptions

exportOptions

Options for managing Exporting and Reports in AdapTable

exportOptions?: ExportOptions<TData>;

Property Value

ExportOptions<TData>

expressionOptions

Options for managing AdapTableQL Expressions

expressionOptions?: ExpressionOptions<TData>;

Property Value

ExpressionOptions<TData>

fdc3Options

Options for managing FDC3 in AdapTable

fdc3Options?: Fdc3Options;

Property Value

Fdc3Options

filterOptions

Filtering Options - both Column Filters and the Grid Filter

filterOptions?: FilterOptions<TData>;

Property Value

FilterOptions<TData>

flashingCellOptions

Options for managing Flashing Cells - primarily default values

flashingCellOptions?: FlashingCellOptions;

Property Value

FlashingCellOptions

formatColumnOptions

Options for providing Custom Display Formats

formatColumnOptions?: FormatColumnOptions;

Property Value

FormatColumnOptions

initialState

Initial State set at design-time and shipped with AdapTable for first use; must include at least one Layout

initialState: InitialState;

Default Value

undefined

Property Value

InitialState

layoutOptions

Options related to Layouts

layoutOptions?: LayoutOptions;

Property Value

LayoutOptions

licenseKey

Commercial license key. If the license is not provided or is expired, various visual information notes will be displayed and some functionality may be limited.

licenseKey?: string;

Property Value

string

noteOptions

Options for managing personal Notes

noteOptions?: NoteOptions;

Property Value

NoteOptions

notificationsOptions

Options for managing Notifications in AdapTable

notificationsOptions?: NotificationsOptions;

Property Value

NotificationsOptions

plugins

Used for managing the AdapTable Plugins

plugins?: AdaptablePlugin[];

Property Value

AdaptablePlugin[]

predicateOptions

Options for managing Predicates in AdapTableQL

predicateOptions?: PredicateOptions;

Property Value

PredicateOptions

primaryKey

Name of Column in AdapTable guaranteed to contain unique values

primaryKey: string;

Default Value

n/a (Mandatory)

Property Value

string

quickSearchOptions

Options for managing Search related functions in AdapTable

quickSearchOptions?: QuickSearchOptions<TData>;

Property Value

QuickSearchOptions<TData>

rowFormOptions

Options for managing Row Forms

rowFormOptions?: RowFormOptions<TData>;

Property Value

RowFormOptions<TData>

settingsPanelOptions

Setting panel options

settingsPanelOptions?: SettingsPanelOptions;

Property Value

SettingsPanelOptions

stateOptions

Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage

stateOptions?: StateOptions;

Property Value

StateOptions

teamSharingOptions

Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues

teamSharingOptions?: TeamSharingOptions;

Property Value

TeamSharingOptions

toolPanelOptions

Options related to managing the Tool Panel elements in AdapTable

toolPanelOptions?: ToolPanelOptions;

Property Value

ToolPanelOptions

userInterfaceOptions

Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc.

userInterfaceOptions?: UserInterfaceOptions<TData>;

Property Value

UserInterfaceOptions<TData>

userName

Name of current AdapTable user

userName?: string;

Default Value

'anonymous'

Property Value

string