Home > @i2analyze/notebook-sdk > app > ITrackedMutations
app.ITrackedMutations interface
A set of methods for performing tracked mutations, which require an entry in the undo stack.
Signature:
interface ITrackedMutations extends IMutationsBase
Extends: IMutationsBase
Introduced: version 1.1
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| selection | readonly |
ISelectionEditor | Gets an object that provides methods for modifying chart selection. (Inherited from IMutationsBase) |
| status | readonly |
IStatus | Gets an object that provides methods for communicating progress information to users. (Inherited from IMutationsBase) |
| valueFactory | readonly |
IValueFactory | Gets a library of functions for creating objects to use in mutations. |
| view | readonly |
IViewEditor | Gets an object that provides methods for modifying the chart view. (Inherited from IMutationsBase) |
Methods
| Method | Description |
|---|---|
| addEntityRecord(recordTemplate) | Creates an entity record that is added to the chart on committal. |
| addEntityType(typeTemplate) | Creates a custom entity type that is added to the chart on committal. |
| addLinkRecord(recordTemplate) | Creates a link record that is added to the chart on committal. |
| addLinkType(typeTemplate) | Creates a custom link type that is added to the chart on committal. |
| addNodeGroup(nodes) | Creates a node group from the specified nodes. |
| addRecordGroup(recordGroupId, selectionOption) | Adds the records from a record group to the chart. |
| editEdge(edge) | Gets an object with methods for editing the appearance of an edge. |
| editItemType(itemType) | Gets an object with methods for editing a schema or custom item type. |
| editNode(node) | Gets an object with methods for editing the appearance of a node. |
| editNodeGroup(nodeGroup) | Gets an object with methods for editing a node group. |
| editRecord(record) | Gets an object with methods for editing a record. |
| moveSelectedNodesRelative(centerDelta) | Moves all the nodes that contain selected records by the same displacement. |
| removeElements(elements) | Removes elements from the chart. |
| removeFromNodeGroup(nodes) | Removes nodes from their node group. If the group is empty after the mutation is committed, the group itself is removed. |
| removeNodeGroups(nodeGroups) | Removes node groups from the chart. Removing a node group does not remove the nodes that were part of it. |
| removeRecords(records) | Removes records from the chart. |
| removeSelectedRecords() | Removes the currently selected records from the chart. |
| setNodeCenter(node, position) | Moves a node to a particular location on the chart. |