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

    Class Slide

    One slide of a deck. Its handle is the 0-based slide index. Shapes are addressed by their scene-node id and returned as cached Shape wrappers (=== identity). Authoring mutators return the new shape's wrapper.

    Hierarchy (View Summary)

    Index
    isValid _index nodeCount notes name
    equals toString shape getShapes addTextBox addShape addTable setNotes setName
    • 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

    • get nodeCount(): number

      The number of drawable objects on this slide (groups flattened).

      Returns number

    • get notes(): string

      Speaker notes (plain text), or "" if none.

      Returns string

    • get name(): string

      The slide's name (empty by default).

      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

    • The index-th object on this slide, or null if out of range.

      Parameters

      • index: number

      Returns Shape | null

    • Collect this slide's objects into out (or a fresh array).

      Parameters

      Returns Shape[]

    • Add a text box at (x, y, width, height) design px with text, fontSizePixels, and a packed 0xRRGGBBAA colour. Returns the new shape's wrapper.

      Parameters

      • x: number
      • y: number
      • width: number
      • height: number
      • text: string
      • fontSizePixels: number
      • rgba: number

      Returns Shape

    • Add a shape of ShapeKind kind at (x, y, width, height) design px with a packed 0xRRGGBBAA fill. Returns the new shape's wrapper.

      Parameters

      • kind: number
      • x: number
      • y: number
      • width: number
      • height: number
      • rgba: number

      Returns Shape

    • Add a rows x columns table at (x, y, width, height) design px. Returns the new shape's wrapper.

      Parameters

      • x: number
      • y: number
      • width: number
      • height: number
      • rows: number
      • columns: number

      Returns Shape

    • Set the slide's speaker notes (plain text); chainable.

      Parameters

      • text: string

      Returns this

    • Set the slide's name; chainable.

      Parameters

      • name: string

      Returns this

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods