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

    Class Range

    A rectangular block of cells addressed by its top-left corner and extent. A range is a light value object (not cached) — it carries no engine handle beyond the address it describes. Aggregates and selection-scoped operations route through the workbook's selection.

    Hierarchy (View Summary)

    Index
    row: number

    The top row.

    column: number

    The left column.

    rowCount: number

    Number of rows.

    columnCount: number

    Number of columns.

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

      The inclusive last row of the range.

      Returns number

    • get lastColumn(): number

      The inclusive last column of the range.

      Returns number

    • 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

    • Make this range the workbook's selection (also switches to its sheet).

      Returns this

    • Merge the range into a single cell.

      Returns this

    • Fill every cell of the range with rgb (packed 0xRRGGBB), preserving other attributes.

      Parameters

      • rgb: number

      Returns this

    • Apply a border preset (a WsBorderPreset) to the range via the selection.

      Parameters

      • preset: number

      Returns this

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

      Parameters

      • kind: number

      Returns number

    • Add a 2- or 3-colour scale over the range (colours packed 0xRRGGBB, low → high). Returns this for chaining.

      Parameters

      • colors: number[]

      Returns this

    • Add a proportional data bar over the range (bar colour packed 0xRRGGBB).

      Parameters

      • color: number

      Returns this

    • Add a cellIs highlight rule: when the cell compares against operand under operator (ComparisonOperator), apply the differential format.

      Parameters

      Returns this

    • Add a dropdown-list validation over the range from an explicit list of values.

      Parameters

      • values: string[]
      • allowBlank: boolean = true

      Returns this