excol
Options
All
  • Public
  • Public/Protected
  • All
Menu

Sheet class.

Hierarchy

  • Sheet

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_name

_name: string

_numColumns

_numColumns: number

_numRows

_numRows: number

Accessors

config

config:

id

id:

mergedRanges

mergedRanges:

range

range:

Methods

appendRow

  • appendRow(rowContents: Object[]): Sheet

  • Appends a row to the spreadsheet. This operation is atomic; it prevents issues where a user asks for the last row, and then writes to that row, and an intervening mutation occurs between getting the last row and writing to it.

    Parameters

    • rowContents: Object[]

    Returns Sheet

autoResizeColumn

  • autoResizeColumn(columnPosition: number): Sheet

  • Sets the width of the given column to fit its contents.

    Parameters

    • columnPosition: number

    Returns Sheet

clear

  • clear(options?: Object): Sheet

  • Clears the sheet of content and formatting information. or Clears the sheet of contents and/or format, as specified with the given advanced options.

    Parameters

    • Optional options: Object

    Returns Sheet

clearContents

clearFormats

clearNotes

deleteColumn

  • deleteColumn(columnPosition: number, howMany?: undefined | number): this

  • Deletes the column at the given column position.

    Parameters

    • columnPosition: number
    • Optional howMany: undefined | number

    Returns this

deleteColumns

  • deleteColumns(columnPosition: number, howMany: number): this

  • Deletes a number of columns starting at the given column position. or Deletes a number of columns starting at the given column position.

    Parameters

    • columnPosition: number
    • howMany: number

    Returns this

deleteRow

  • deleteRow(rowPosition: number, howMany?: undefined | number): this

  • Deletes the row at the given column position.

    Parameters

    • rowPosition: number
    • Optional howMany: undefined | number

    Returns this

deleteRows

  • deleteRows(rowPosition: number, howMany: number): this

  • Deletes a number of rows starting at the given column position.

    Parameters

    • rowPosition: number
    • howMany: number

    Returns this

getActiveRange

  • getActiveRange(): Range

getLastColumn

  • getLastColumn(): number

getLastRow

  • getLastRow(): number

getName

  • getName(): string

getParent

getRange

  • getRange(__namedParameters: object): Range

  • Get specific range by A1 or matrix.

    Parameters

    • __namedParameters: object
      • A1: undefined | string

        A1 notation

      • column: undefined | number

        Column index

      • numColumns: undefined | number

        Number of columns

      • numRows: undefined | number

        Number of rows

      • row: undefined | number

        Row index

    Returns Range

    Range object

getRanges

  • getRanges(__namedParameters: object): Range[]

  • Get specific range by A1 or matrix.

    Parameters

    • __namedParameters: object
      • A1: undefined | string

        A1 notation

      • column: undefined | number

        Column index

      • numColumns: undefined | number

        Number of columns

      • numRows: undefined | number

        Number of rows

      • row: undefined | number

        Row index

    Returns Range[]

    Range object

getSheetValues

  • getSheetValues(startRow: any, startColumn: any, numRows: any, numColumns: any): any[]

  • Returns the rectangular grid of values for this range starting at the given coordinates.

    Parameters

    • startRow: any
    • startColumn: any
    • numRows: any
    • numColumns: any

    Returns any[]

init

  • init(__namedParameters: object): void

  • Initialize Sheet.

    Parameters

    • __namedParameters: object
      • cellValue: undefined | CellValue
      • id: number
      • name: string
      • numColumns: number

        Column dimension size

      • numRows: number

        Row dimension size

    Returns void

initRange

insertColumnAfter

  • insertColumnAfter(afterPosition: number, howMany?: undefined | number): Sheet

  • Inserts a column after the given column position.

    Parameters

    • afterPosition: number
    • Optional howMany: undefined | number

    Returns Sheet

insertColumnBefore

  • insertColumnBefore(beforePosition: number, howMany?: undefined | number): Sheet

  • Inserts a column before the given column position.

    Parameters

    • beforePosition: number
    • Optional howMany: undefined | number

    Returns Sheet

insertColumnsAfter

  • insertColumnsAfter(afterPosition: number, howMany: number): Sheet

  • Inserts a number of columns after the given column position.

    Parameters

    • afterPosition: number
    • howMany: number

    Returns Sheet

insertColumnsBefore

  • insertColumnsBefore(beforePosition: number, howMany: number): Sheet

  • Inserts a number of columns before the given column position.

    Parameters

    • beforePosition: number
    • howMany: number

    Returns Sheet

insertRowAfter

  • insertRowAfter(afterPosition: number, howMany?: undefined | number): Sheet

  • Inserts a row after the given column position.

    Parameters

    • afterPosition: number
    • Optional howMany: undefined | number

    Returns Sheet

insertRowBefore

  • insertRowBefore(beforePosition: number, howMany?: undefined | number): Sheet

  • Inserts a row before the given column position.

    Parameters

    • beforePosition: number
    • Optional howMany: undefined | number

    Returns Sheet

insertRowsAfter

  • insertRowsAfter(afterPosition: number, howMany: number): Sheet

  • Inserts a number of rows after the given column position.

    Parameters

    • afterPosition: number
    • howMany: number

    Returns Sheet

insertRowsBefore

  • insertRowsBefore(beforePosition: number, howMany: number): Sheet

  • Inserts a number of rows before the given column position.

    Parameters

    • beforePosition: number
    • howMany: number

    Returns Sheet

setActiveRange

  • setActiveRange(range: any): Range

setLastColumn

  • setLastColumn(column: number): void

setLastRow

  • setLastRow(row: number): void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc