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

    Class SheetSelection

    The workbook's live selection: the active cell, its anchor, and the count of disjoint ranges. Inherits the uniform clipboard verbs (Selection.copy, Selection.cut, Selection.paste) and adds spreadsheet cursor/range navigation, paste-special, and aggregates.

    Hierarchy (View Summary)

    Index
    • get activeRow(): number

      The active cell's row.

      Returns number

    • get activeColumn(): number

      The active cell's column.

      Returns number

    • get anchorRow(): number

      The selection anchor's row.

      Returns number

    • get anchorColumn(): number

      The selection anchor's column.

      Returns number

    • get rangeCount(): number

      The number of disjoint ranges in the selection (>= 1).

      Returns number

    • get isEmpty(): boolean

      Whether the selection is a single collapsed cell.

      Returns boolean

    • Copy the selection into the engine's clipboard.

      Returns this

    • Copy the selection into the clipboard, then delete it.

      Returns this

    • Insert the clipboard contents at the caret, replacing any selection.

      Returns this

    • Collapse the selection to the active cell.

      Returns this

    • Collapse the selection to the single cell (row, column).

      Parameters

      • row: number
      • column: number

      Returns this

    • Select the rectangular range rowCount × columnCount anchored at (row, column).

      Parameters

      • row: number
      • column: number
      • rowCount: number
      • columnCount: number

      Returns this

    • The active range as [row, column, rowCount, columnCount] (the anchor→active rectangle), written into out (or a fresh array). Valid until the next call of the same kind.

      Type Parameters

      • T extends Uint32Array<ArrayBufferLike>

      Parameters

      • Optionalout: T

      Returns Uint32Array

    • Paste-special the internal clip at the cursor (see PasteSpecial); 1 if pasted.

      Parameters

      • mode: number

      Returns this

    • A selection-union aggregate: 0 count, 1 numeric count, 2 sum, 3 min, 4 max.

      Parameters

      • kind: number

      Returns number