ReadonlyisFor runtime type checking.
ReadonlyisFor runtime type checking.
OptionalacceptThe flip this content takes when asked to mirror as flip states.
Defined by content that can be mirrored, such as a shape or a picture; absent, the content cannot: a frame dragged through its opposite edge is moved there but not mirrored, as Excel does with a chart. Must be pure, as acceptRotation is. A connector may accept each axis on its own.
OptionalacceptThe rotation this content takes when asked to turn by degrees, clockwise.
Add Listeners.
Batches all 'transactional' changes until they have all be committed or rolled back.
Optionaloptions: string | ITransaction.OperationOptions
Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Any changes that are made to this object will be reflected in the local record but not committed to the transactional store until the batch is popped.
Useful for operations that are longer running but generally not recommended as it keeps a transaction open. doBatch is the preferred option.
Close the record and cleans resources. Can't be undone.
Deletes the group and its members, and with them the movable that places the group.
Optionaloptions: ITransaction.OperationOptionsProvides a mechanism to perform a set of operations in a batch.
A callback that performs multiple operations all within the same transaction.
Optionaloptions: string | ITransaction.OperationOptions
Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Returns the alternative text used by assistive technologies, or null if none has been set.
A unique identifier for the record. This will never change.
This enables the record to be identified across transactions and users in a collaborative environment. The id is store-issued (IStore.create); the store keys all state by it.
Returns the movable that places the content on the sheet, or null if it is not placed by
one.
Returns the name of the group.
Returns the text written on the members, in z-order.
null when no member has a text body at all.
Returns an immutable type string.
Returns a label for the kind of content, such as Chart or Picture.
Every committed update gives the record a new, strictly increasing version id.
Used with getId to uniquely identify a version of the record.
The id is an identity, not a per-record count: ids are drawn from a single store-wide sequence bumped once per commit, so all records written in the same commit share an id and a given record's ids increase but are not sequential.
Records are immutable so a restore/revert doesn't change them — it repoints, and the version id reported is the one for the snapshot the store is currently at. Version ids are never reused: a write after an undo receives an id higher than any previously issued, so a stale reader can always detect the change.
Returns true if no more operations are allowed.
If the model unable to be modified.
If the model unable to be modified.
Set the alternative text used by assistive technologies.
OptionalsetSet the name.
The name of the content.
Dissolves the group: each member is placed in the group's container where it is drawn, and the group is deleted.
Optionaloptions: ITransaction.OperationOptionsThe freed movables, in z-order.
A group: a movable that holds movables.
Remarks
A group is the content of an IMovable —
movable.getContent<IGroup>()for a movable whose content type is'group'. Its members are ordinary movables, each with its own content (a shape, a picture, a chart, another group), held by the group's movable in z-order (IMovable.getMovables). A member's IMovable.getParent is the group's movable.A member is read and edited where it is drawn, like any movable; the group keeps its placement in the child space the file states (IGroup.JSON.childBounds) and maps it through its own frame. Resizing the group changes its frame only: the members keep what they store, and are drawn at the new scale, as Excel's Size pane shows it.
Example