AdapTable Types Reference

DataChangeHistoryApi

Provides run-time access to the Data Change History Module

TypeScript
export interface

Methods

MethodDescription
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

Method Details

activateDataChangeHistory

Activates Data Change History tracking (or resumes it, if it is currently suspended)

TypeScript
activateDataChangeHistory(forceReset?: boolean): void;
Parameters
ParameterTypeDescription
forceResetbooleanreactivates the Data Change History even if it is currently suspended
Returns

void

addDataChangeHistoryEntry

Adds item to Data Change History log

TypeScript
addDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
Parameters
ParameterTypeDescription
dataChangeInfoCellDataChangedInfothe change to log
Returns

void

clearDataChangeHistoryEntry

Clears a Row in Data Change Grid

TypeScript
clearDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): void;
Parameters
ParameterTypeDescription
dataChangeInfoCellDataChangedInfothe change to be undone
Returns

void

deactivateDataChangeHistory

Deactivates Data Change History tracking and flushes the cache

TypeScript
deactivateDataChangeHistory(): void;
Returns

void

getDataChangeForGridCell

Retrieves last data change for a given Cell

TypeScript
getDataChangeForGridCell(gridCell: GridCell): CellDataChangedInfo | undefined;
Parameters
ParameterType
gridCellGridCell
Returns

CellDataChangedInfo | undefined

getDataChangeHistoryLog

Retrieves all data changes which are currently available

TypeScript
getDataChangeHistoryLog(): CellDataChangedInfo[];
Returns

CellDataChangedInfo[]

getDataChangeHistoryMode

Retrieves current Data Change History mode: 'ACTIVE', 'INACTIVE', 'SUSPENDED'

TypeScript
getDataChangeHistoryMode(): 'ACTIVE' | 'INACTIVE' | 'SUSPENDED';
Returns

'ACTIVE' | 'INACTIVE' | 'SUSPENDED'

openDataChangeHistorySettingsPanel

Opens Data Change History panel

TypeScript
openDataChangeHistorySettingsPanel(): void;
Returns

void

suspendDataChangeHistory

Suspends data change history tracking

TypeScript
suspendDataChangeHistory(): void;
Returns

void

undoAllDataChangeHistoryEntries

Reverts all data changes to previous values and returns GridCells that were undone

TypeScript
undoAllDataChangeHistoryEntries(): GridCell[];
Returns

GridCell[]

undoDataChangeHistoryEntry

Reverts provided data change to its previous value and returns GridCell that was undone

TypeScript
undoDataChangeHistoryEntry(dataChangeInfo: CellDataChangedInfo): GridCell | undefined;
Parameters
ParameterTypeDescription
dataChangeInfoCellDataChangedInfothe change to be undone
Returns

GridCell | undefined

PreviousDataChangedScopeNextDataChangeHistoryButton