EditOptions

Options related to Editing in AdapTable - includes Server Validation, Smart Edit Operations and Cell Editabiility

TypeScript

export interface

Properties

Property	Type	Description	Default
customEditColumnValues	`(context:CustomEditColumnValuesContext<TData>) =>CustomEditColumnValueInfo[] \| Promise<CustomEditColumnValueInfo[]>`	List of Column values to display when Editing (i.e. in Edit Lookups, Bulk Update)
displayServerValidationMessages	`boolean`	Whether to display message after Server Validation runs	true
isCellEditable	`(cellEditableContext:CellEditableContext<TData>) => boolean`	Function which checks if a given Grid Cell is editable
plusMinusOptions	`PlusMinusOptions`	Options for Plus Minus module (keyboard increment / decrement)
showSelectCellEditor	`(currentColumContext:AdaptableColumnContext<TData>) => boolean`	Columns that will display a Select dropdown when editing
smartEditOptions	`SmartEditOptions<TData>`	Options for Smart Edit module
validateOnServer	`(serverValidationContext:ServerValidationContext<TData>) => Promise<ServerValidationResult>`	Function to validate AdapTable data edits remotely

List of Column values to display when Editing (i.e. in Edit Lookups, Bulk Update)

TypeScript

customEditColumnValues?: (context: CustomEditColumnValuesContext<TData>) => CustomEditColumnValueInfo[] | Promise<CustomEditColumnValueInfo[]>;

Whether to display message after Server Validation runs

TypeScript

displayServerValidationMessages?: boolean;

true

boolean

Function which checks if a given Grid Cell is editable

TypeScript

isCellEditable?: (cellEditableContext: CellEditableContext<TData>) => boolean;

(cellEditableContext:CellEditableContext<TData>) => boolean

Options for Plus Minus module (keyboard increment / decrement)

TypeScript

plusMinusOptions?: PlusMinusOptions;

Columns that will display a Select dropdown when editing

TypeScript

showSelectCellEditor?: (currentColumContext: AdaptableColumnContext<TData>) => boolean;

(currentColumContext:AdaptableColumnContext<TData>) => boolean

Options for Smart Edit module

TypeScript

smartEditOptions?: SmartEditOptions<TData>;

Function to validate AdapTable data edits remotely

TypeScript

validateOnServer?: (serverValidationContext: ServerValidationContext<TData>) => Promise<ServerValidationResult>;