EntityChanges Class
The frontend transaction-change payload for onElementsChanged and onModelsChanged.
Iterate TxnEntityChanges to inspect their id, type, and metadata, or use filter to select by change type or class hierarchy.
Both payloads include metadata. Frontend changes also expose a per-change type, while backend changes are grouped into inserts, deletes, and updates; the compressed inserted, deleted, and updated sets remain available for bulk operations.
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(args: NotifyEntitiesChangedArgs): EntityChanges | ||
| [iterator](): Iterator<TxnEntityChange> | ||
| filter(options: TxnEntityChangesFilterOptions): TxnEntityChangeIterable | Obtain an iterator over changes meeting the criteria specified by options. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| args Readonly | NotifyEntitiesChangedArgs | ||
| deleted Accessor ReadOnly | string | undefined | The ids of entities that were deleted during the Txn. | |
| inserted Accessor ReadOnly | string | undefined | The ids of entities that were inserted during the Txn. | |
| metadata Readonly | Metadata[] | ||
| updated Accessor ReadOnly | string | undefined | The ids of entities that were modified during the Txn, including any Elements for which one of their ElementAspects was changed. |
Defined in
Last Updated: 03 September, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.