@squareys/webdecks-sdk - v0.0.0
    Preparing search index...

    Class Shape

    One scene node on a slide (a text box, image, shape, or table). Its handle is the scene-node id. Geometry reads come straight off the engine model through a shared scratch view; the transform mutators chain and repaint any attached viewport.

    Hierarchy (View Summary)

    Index
    • get isValid(): boolean

      Whether this wrapper still refers to a live engine object.

      Returns boolean

    • set _index(value: number): void

      Parameters

      • value: number

      Returns void

    • get nodeType(): number

      The node's type (a NodeType ordinal).

      Returns number

    • get shapeKind(): number

      The ShapeKind ordinal when Shape.nodeType is a shape, else 0.

      Returns number

    • get isVisible(): boolean

      Whether the node is visible.

      Returns boolean

    • get rotation(): number

      The node's rotation in degrees, clockwise around the rect centre.

      Returns number

    • The node's click hyperlink URL, or "" if none.

      Returns string

    • get textFrame(): TextFrame | null

      The node's text frame when it carries text (a text box), else null.

      Returns TextFrame | null

    • Reference equality is the identity test — prefer a === b. This is retained only for the rare cross-realm case where two wrappers describe the same handle by value. Reads the raw index so comparing a stale wrapper never throws.

      Parameters

      • other: Handle<unknown> | null

      Returns boolean

    • A readable identity for logs and diagnostics, never [object Object].

      Returns string

    • The node's local rect [x, y, width, height] in design px, written into out (or a fresh Float32Array). Valid until the next call of the same kind.

      Returns Float32Array

    • The node's local rect [x, y, width, height] in design px, written into out (or a fresh Float32Array). Valid until the next call of the same kind.

      Type Parameters

      Parameters

      • out: T

      Returns T

    • Set the node's local rect (design px); chainable.

      Parameters

      • x: number
      • y: number
      • width: number
      • height: number

      Returns this

    • Set the node's rotation in degrees; chainable.

      Parameters

      • degrees: number

      Returns this

    • Show or hide the node; chainable.

      Parameters

      • visible: boolean

      Returns this

    • Move the node in paint order (see ZOrder); chainable.

      Parameters

      • mode: number

      Returns this

    • Bring the node to the front of its siblings; chainable.

      Returns this

    • Send the node to the back of its siblings; chainable.

      Returns this

    • Set (or clear, when url is empty) the node's click hyperlink; chainable. Only text boxes, shapes, and images carry a hyperlink.

      Parameters

      • url: string

      Returns this