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

    Class Sheet

    One sheet of a workbook. Reads are property getters off the model; Sheet.cell, Sheet.chart, and Sheet.pivotTable return cached wrappers whose identity holds within an edit epoch (a structural edit — a sheet/row/column add or remove — invalidates it).

    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 name(): string

      The sheet name.

      Returns string

    • get usedRowCount(): number

      One past the last touched row (the used grid height).

      Returns number

    • get usedColumnCount(): number

      One past the last touched column (the used grid width).

      Returns number

    • get chartCount(): number

      Number of charts on this sheet.

      Returns number

    • get pivotTableCount(): number

      Number of pivot tables on this sheet.

      Returns number

    • get pictureCount(): number

      Number of embedded pictures anchored on this sheet.

      Returns number

    • get sparklineCount(): number

      Number of sparklines on this sheet.

      Returns number

    • get printArea(): string

      The print area definition text ("" if none).

      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

    • Rename the sheet.

      Parameters

      • name: string

      Returns this

    • The cell at (row, column), cached per address within the current edit epoch.

      Parameters

      • row: number
      • column: number

      Returns Cell

    • A rectangular range rowCount × columnCount with its top-left at (row, column).

      Parameters

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

      Returns Range

    • The index-th chart on this sheet, or null if out of range.

      Parameters

      • index: number

      Returns Chart | null

    • Add a chart of kind (ChartKind) anchored over the range (r0,c0)-(r1,c1); returns its wrapper. Feed categories + series through the returned Chart.

      Parameters

      • kind: number
      • r0: number
      • c0: number
      • r1: number
      • c1: number

      Returns Chart

    • The index-th pivot table on this sheet, or null if out of range.

      Parameters

      • index: number

      Returns PivotTable | null

    • Build a pivot table whose output lands on this sheet at (outputRow, outputColumn); returns its wrapper, or null on failure. The source range and fields come from spec.

      Parameters

      Returns PivotTable | null

    • Set a column's width in logical pixels.

      Parameters

      • column: number
      • width: number

      Returns this

    • Set a row's height in logical pixels.

      Parameters

      • row: number
      • height: number

      Returns this

    • Freeze rows rows and columns columns at the top-left (0 unfreezes that axis).

      Parameters

      • rows: number
      • columns: number

      Returns this

    • Hide or show a column.

      Parameters

      • column: number
      • hidden: boolean

      Returns this

    • Hide or show a row.

      Parameters

      • row: number
      • hidden: boolean

      Returns this

    • Whether a column is hidden.

      Parameters

      • column: number

      Returns boolean

    • Whether a row is hidden.

      Parameters

      • row: number

      Returns boolean

    • Group rows [first, last] into an outline (optionally collapsed).

      Parameters

      • first: number
      • last: number
      • collapsed: boolean = false

      Returns this

    • Group columns [first, last] into an outline (optionally collapsed).

      Parameters

      • first: number
      • last: number
      • collapsed: boolean = false

      Returns this

    • Arm an AutoFilter over (r0,c0)-(r1,c1) (row r0 is the header row).

      Parameters

      • r0: number
      • c0: number
      • r1: number
      • c1: number

      Returns this

    • Set (or clear, when empty) a per-column contains-criterion, recomputing hidden rows.

      Parameters

      • column: number
      • criterion: string

      Returns this

    • Insert an encoded image (PNG/JPEG bytes) anchored (fromRow,fromCol)-(toRow,toCol) with an explicit EMU extent; returns the image-store id (-1 on failure).

      Parameters

      • bytes: Uint8Array
      • fromRow: number
      • fromColumn: number
      • toRow: number
      • toColumn: number
      • extentWidth: number = 0
      • extentHeight: number = 0

      Returns number

    • Add a sparkline in cell (row, column) over the data range (r0,c0)-(r1,c1). kind is a SparklineKind; returns the sparkline index (-1 on failure).

      Parameters

      • row: number
      • column: number
      • r0: number
      • c0: number
      • r1: number
      • c1: number
      • kind: number
      • options: { groupId?: number; markers?: boolean; negative?: boolean } = {}

      Returns number

    • Configure the printed page.

      Parameters

      Returns this

    • Set the printed page margins (inches).

      Parameters

      Returns this

    • Set the print area (which 0) or print titles (which 1) definition, e.g. "$A$1:$D$20".

      Parameters

      • reference: string

      Returns this

    • Set the print-titles (repeat rows/columns) definition.

      Parameters

      • reference: string

      Returns this

    • Set the sheet-protection flag mask (see the engine's <sheetProtection> bit layout).

      Parameters

      • mask: number

      Returns this

    • Read a protection flag (bit 0 enabled, 1..15 the per-permission bits).

      Parameters

      • bit: number

      Returns boolean