DataChangeHistoryOptions

Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes

TypeScript
export interface

Properties

PropertyTypeDescriptionDefault
activeByDefaultbooleanMake Data Change History active by defaultfalse
changeHistoryButtonDataChangeHistoryButton<TData> |DataChangeHistoryButton<TData>[]Action button definition; can be used to implement undo functionalityundefined
maxDataChangesInStorenumberHow many data changes are held in State at any one time; when limit is reached, oldest change(s) are deleted from memoryundefined (all data changes are logged)
showDataChange(cellDataChangedInfo:CellDataChangedInfo<TData>) => booleanFunction specifying which data changes to include in Data Change Historyundefined (all data changes are logged)
showLastDataChangeOnlybooleanShow all changes for a Cell or just the last onetrue

Property Details

activeByDefault

Make Data Change History active by default

TypeScript
activeByDefault?: boolean;
Default Value

false

Property Value

boolean

changeHistoryButton

Action button definition; can be used to implement undo functionality

TypeScript
changeHistoryButton?: DataChangeHistoryButton<TData> | DataChangeHistoryButton<TData>[];
Default Value

undefined

Property Value

DataChangeHistoryButton<TData> |DataChangeHistoryButton<TData>[]

maxDataChangesInStore

How many data changes are held in State at any one time; when limit is reached, oldest change(s) are deleted from memory

TypeScript
maxDataChangesInStore?: number;
Default Value

undefined (all data changes are logged)

Property Value

number

showDataChange

Function specifying which data changes to include in Data Change History

TypeScript
showDataChange?: (cellDataChangedInfo: CellDataChangedInfo<TData>) => boolean;
Default Value

undefined (all data changes are logged)

Property Value

(cellDataChangedInfo:CellDataChangedInfo<TData>) => boolean

showLastDataChangeOnly

Show all changes for a Cell or just the last one

TypeScript
showLastDataChangeOnly?: boolean;
Default Value

true

Property Value

boolean