Configuring Data Change History

View as Markdown

Summary

  • Set how Data Change History works and what is tracked

Data Change History is configured in dataChangeHistoryOptions on Adaptable Options:

PropertySection on this page
activeByDefaultMaking Active by Default
showDataChangeLimiting Data Changes
showLastDataChangeOnlyShow All Data Changes
maxDataChangesInStoreLimiting Data Changes in Store

Find Out More

Making Active by Default

By default Data Change History tracking is inactive, and needs to be explicitly activated in the UI.

This can be changed via the activeByDefault property.

activeByDefault

Default: false
Boolean
Whether Data Change history should be Active by default

Limiting Data Changes

Another useful property is showDataChange, which lets you specify which data changes appear in the monitor.

Hint

This is useful when you want to display changes only in certain columns, or user edits but not ticking data changes

showDataChange

Function which specifies which Data Changes should be displayed in Data Changes Monitor
Data Change History: Limiting Changes
Fork
  • showDataChange in adaptableOptions.ts excludes:
    • ticking data changes (only direct user edits are shown)
    • user edits on updated_at or language
Try It Out
  • Click Show on the Data Change History toolbar to open the Data Changes Monitor
  • Edit updated_at or language and note the edit does not appear in the log
Loading demo…

Show All Data Changes

By default only the last change for each cell is displayed in the Data Change History Monitor.

If this behaviour is not wanted, then set the showLastDataChangeOnly property to false in order to see every change for each cell.

showLastDataChangeOnly

Default: true
Boolean
Whether to show all changes for each cell or just the last one
Data Change History: Showing all Changes
Fork
  • showLastDataChangeOnly: false in adaptableOptions.ts keeps every change per cell in the log
  • onAdaptableReady.ts updates github_stars on the first row three times; open the monitor to see three entries
Try It Out
  • Open the Data Change History monitor after the scripted updates and confirm three changes for the same cell
Loading demo…

Limiting Data Changes in Store

By default AdapTable retains every logged data change in State indefinitely.

This is fine if you are tracking user edits, but the store can grow unboundedly when tracking ticking data.

Use the maxDataChangesInStore property to cap the number of changes held in memory at any one time.

Hint

  • When the cap is reached, the oldest change is dropped as each new change is logged
  • This ensures that the store never exceeds the size you configure

maxDataChangesInStore

Default: undefined
Number
Maximum number of Data Changes to retain in State; oldest changes are removed once the limit is reached
Data Change History: Capping Store Size
Fork
  • maxDataChangesInStore: 8 and showLastDataChangeOnly: false in adaptableOptions.ts; ticking is driven from onAdaptableReady.ts
  • Each tick updates a random row/column among github_stars, github_watchers, open_issues_count, or updated_at
  • The monitor opens automatically; once eight entries exist, each new change drops the oldest
Try It Out
  • Watch the Data Change History monitor as ticking updates arrive
  • The list fills to eight entries and then holds steady — each new change pushes the oldest one out
Loading demo…