SYIDAX / DATA GRID

View change history

Record and query edit history.

Get started
View change historySample order data
120 rows
Loading Grid…

Options

Changes below update the Grid and code immediately.

Latest result

Audit history is enabled here. Edit a Quantity cell and press Enter.

View code
Current preview

Usage guide

#

Record edits so users can later inspect when and how order values changed.

Try it yourself

  1. Create a change

    Audit history is enabled here. Edit a Quantity cell and press Enter.

  2. Inspect the edit result

    The latest result above the code view shows the edited row and changes. The next operation replaces it with one new result.

  3. Read accumulated history

    Click Read audit log above the table to inspect getAuditLog(). In your app, query relevant conditions and display a separate history view.

Expected results

Track and query changes, including before/after values.

Latest results shows only the last operation. Use Read audit log for accumulated records and connect server storage for long-term retention.

Useful terms

auditLog
A setting enabling edit audit history.
getAuditLog
A method querying changes recorded by the Grid.

Key API examples

Application code that references the registered Grid element as grid.

grid.auditLog = true;
console.log(await grid.getAuditLog());

API reference

#

Other properties2
Attribute / PropertyType / DefaultDescription
auditLog
booleanDefault: falseenable the audit trail: a bounded, append-only log of row/cell/ selection mutations and undo/redo transitions. Read it via getAuditLog and subscribe to auditLogChanged. Off by default (zero overhead).
auditLogMax
numberDefault: 1000Cap on retained audit entries (oldest evict first).
Events1
EventsDetail typeDescription
{ entry: AuditEntry }Fires per entry appended to the audit trail (when `audit-log` is on).
Methods6
Method / ArgumentsReturn typeDescription
filter?: AuditLogFilter
Promise<AuditEntry[]>The audit trail entries (optionally filtered). Empty when off.
Promise<void>Clear the audit trail (seq keeps advancing; never reused).
filter?: AuditLogFilter
Promise<string>The audit trail as a CSV string (flat union columns, filterable).
filter?: AuditLogFilter, pretty?: boolean
Promise<string>The audit trail as a JSON array string (structure preserved).
fileName?: string, filter?: AuditLogFilter
Promise<void>Download the audit trail as a CSV file.
fileName?: string, filter?: AuditLogFilter
Promise<void>Download the audit trail as a JSON file.