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

    Class TextFrame

    The text of a Shape that carries one (a text box). Its handle is the same scene-node id as the owning shape. getText(out) fills a caller buffer for hot loops; text allocates a JavaScript string. Setting the text resets the box to uniform (box-level) formatting.

    Hierarchy (View Summary)

    Index
    isValid _index text
    equals toString getText setText
    • get isValid(): boolean

      Whether this wrapper still refers to a live engine object.

      Returns boolean

    _index

    • set _index(value: number): void

      Parameters

      • value: number

      Returns void

    text

    • get text(): string

      The frame's text as a JavaScript string. Prefer TextFrame.getText in hot loops.

      Returns string

    • 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

    • Read the frame's text: as a string, or into out (UTF-8), returning the full byte length.

      Returns string

    • Read the frame's text: as a string, or into out (UTF-8), returning the full byte length.

      Type Parameters

      Parameters

      • out: T

      Returns number

    • Replace the frame's text (resets it to uniform box-level formatting); chainable.

      Parameters

      • text: string

      Returns this

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods