API reference / Common / Engine types / GraphicsObject

Interface: GraphicsObject

A single addressable item in the document's editing model.

Combines the universal addressing/positioning header (id, transform, clips, marked content) with a [GraphicsObjectContent] describing what the object paints. Edits target either the header fields directly (move, re-clip, retag) or fields inside content (change a fill, edit path geometry, …).

Properties

Property	Description
id? string	Stable id for this object. May be left unset (the all-zero UNSET_ID) in the InsertObjects wire form, in which case execution mints a fresh id in its place — so a host can omit id and let the editor allocate one. The editing model never stores the sentinel; every object it holds carries a real, minted id.
transform Affine	Transform from this object's local coordinate space into its parent's coordinate space. Top-level objects use whatever coordinate space the containing document layer defines; objects inside a GroupObject.children are local to that group; objects inside a Form.body are local to that form.
clips Clip[]	Clips applied to this object's rendering, stored in this object's local coordinate space (pre-transform). Multiple clips are intersected.
markedContent MarkedContent | null	The marked-content sequence around exactly this object, or None. The sequences enclosing it are those of its ancestors; a sequence around several objects is on the [GroupObject] holding them. An object shows only if every /OC sequence around it is visible.
content GraphicsObjectContent	-