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

    Class InlineImage

    An inline image, addressed by the index of the paragraph that carries it. Its text-wrap mode and its resolved on-screen rect are read live from the model; wrap mode and floating position are set through the mutators. The image's encoded bytes are added with Document.importImage.

    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 paragraph(): number

      The index of the paragraph that carries this image.

      Returns number

    • get wrap(): number

      The image's text-wrap mode, read live from the model.

      Returns number

    • get isLaidOut(): boolean

      Whether the image has a laid-out rect (false in a layout-less / headless host).

      Returns boolean

    • 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 image's resolved on-screen rect [x, y, width, height] in CSS pixels, read live. Needs a layout (the live GPU path); a headless host fills zeros. Pass out to avoid the allocation.

      Returns Float32Array

    • The image's resolved on-screen rect [x, y, width, height] in CSS pixels, read live. Needs a layout (the live GPU path); a headless host fills zeros. Pass out to avoid the allocation.

      Type Parameters

      Parameters

      • out: T

      Returns T

    • Set the text-wrap mode for the image.

      Parameters

      • wrap: number

      Returns this

    • Float the image at the given position and size, in pixels.

      Parameters

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

      Returns this