Data Change History Technical Reference
Data Change History Options
DataChangeHistoryOptions
Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes
number
How many data changes are held in State at any one time; when limit is reached, oldest change(s) are deleted from memory
undefined (all data changes are logged)
(cellDataChangedInfo:CellDataChangedInfo<TData>) => boolean
Function specifying which data changes to include in Data Change History
undefined (all data changes are logged)
changeHistoryButton is a list of DataChangeHistoryButton objects:
DataChangeHistoryButton
A custom AdaptableButton which provides a build in undo action
Built-in action the button runs. 'undo' restores the previous value. 'clear' removes the change from the log.
Custom application Context provided in AdaptableOptions.adaptableContext
showDataChange receives a CellDataChangedInfo:
CellDataChangedInfo
Defines a Cell Edit - includes full details of old and new values, the column and the enclosing Row
number
Timestamp of change occurrence (in milliseconds)
AdaptableColumn<TData>
Column in which cell is situated
any
Value after the change.
Absent when trigger is live.
any
Value before the change.
Absent when trigger is live.
boolean
Whether the change was prevented by a validation rule
Primary Key Column's value for the row where edited cell is situated
TData
Data in the Row
IRowNode<TData>
AG Grid RowNode that contains the cell
'edit' | 'tick' | 'undo' | 'aggChange' | 'calculatedColumnChange' | 'live'
What triggered the change - user, background change, a reverted change, a
derived update on a Calculated Column whose source value changed, or a
live Alert rule turning true for the row (live: no old / new value,column is the rule's first Scope column when it has one).
Data Change History API
DataChangeHistoryApi
The history of cell value changes: the log, the latest change for a cell, and undo.
void
Activates Data Change History tracking (or resumes it, if it is currently suspended)
void
Adds item to Data Change History log
void
Clears a Row in Data Change Grid
void
Deactivates Data Change History tracking and flushes the cache
CellDataChangedInfo | undefined
The most recent change recorded for a cell.
Retrieves all data changes which are currently available
'ACTIVE' | 'INACTIVE' | 'SUSPENDED'
Retrieves current Data Change History mode: 'ACTIVE', 'INACTIVE', 'SUSPENDED'
void
Opens Data Change History panel
void
Suspends data change history tracking
Reverts all data changes to previous values and returns GridCells that were undone
GridCell | undefined
Reverts provided data change to its previous value and returns GridCell that was undone