Data Change History Technical Reference
Summary
- Data Change History Options contains properties enabling Data Change History to be configured
- Data Change History API Section of Adaptable API provides run-time accesss
Data Change History Options
The DataChangeHistoryOptions section of Adaptable Options contains these properties:
| Property | Description | Default |
|---|---|---|
| activeByDefault | Make Data Change History active by default | false |
| changeHistoryButton | Action button definition; can be used to implement undo functionality | undefined |
| showDataChange | Function specifying which data changes to include in Data Change History | undefined (all data changes are logged) |
| showLastDataChangeOnly | Show all changes for a Cell or just the last one | true |
Data Change History API
The DataChangeHistoryAPI section of Adaptable API contains these functions:
| Method | Description |
|---|---|
| activateDataChangeHistory(forceReset) | Activates Data Change History tracking (or resumes it, if it is currently suspended) |
| addDataChangeHistoryEntry(dataChangeInfo) | Adds item to Data Change History log |
| clearDataChangeHistoryEntry(dataChangeInfo) | Clears a Row in Data Change Grid |
| deactivateDataChangeHistory() | Deactivates Data Change History tracking and flushes the cache |
| getDataChangeForGridCell(gridCell) | Retrieves last data change for a given Cell |
| getDataChangeHistoryLog() | Retrieves all data changes which are currently available |
| getDataChangeHistoryMode() | Retrieves current Data Change History mode: 'ACTIVE', 'INACTIVE', 'SUSPENDED' |
| openDataChangeHistorySettingsPanel() | Opens Data Change History panel |
| suspendDataChangeHistory() | Suspends data change history tracking |
| undoAllDataChangeHistoryEntries() | Reverts all data changes to previous values and returns GridCells that were undone |
| undoDataChangeHistoryEntry(dataChangeInfo) | Reverts provided data change to its previous value and returns GridCell that was undone |