Spreadsheet | excol

Spreadsheet class.

Hierarchy

Spreadsheet

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Spreadsheet(cfg: SpreadsheetConfig): Spreadsheet

- Defined in lib/spreadsheet/Spreadsheet.ts:41
Constructor

Parameters
- cfg: SpreadsheetConfig
  
  Spreadsheet configuration
Returns Spreadsheet

Properties

_numColumns

_numColumns: number

_numRows

_numRows: number

Methods

addEditor

addEditor(user: User | string): Spreadsheet

- Defined in lib/spreadsheet/Spreadsheet.ts:80
- Adds the given user to the list of editors for the Spreadsheet. If the user was already on the list of viewers, this method promotes the user out of the list of viewers.
Adds the given user to the list of editors for the Spreadsheet.
Parameters
- user: User | string
Returns Spreadsheet

addEditors

addEditors(emailAddresses: string[]): Spreadsheet

- Defined in lib/spreadsheet/Spreadsheet.ts:98
Adds the given array of users to the list of editors for the Spreadsheet.

Parameters
- emailAddresses: string[]
Returns Spreadsheet

addMenu

addMenu(name: string, subMenus: Object[]): void

- Defined in lib/spreadsheet/Spreadsheet.ts:111
Creates a new menu in the Spreadsheet UI.

Parameters
- name: string
- subMenus: Object[]
Returns void

addNamedRanges

addNamedRanges(name: string, range: Range): NamedRange

- Defined in lib/spreadsheet/Spreadsheet.ts:148
Add named ranges in this spreadsheet.

Parameters
- name: string
- range: Range
Returns NamedRange

addViewer

addViewer(user: User | string): Spreadsheet

- Defined in lib/spreadsheet/Spreadsheet.ts:121
Adds the given user to the list of viewers for the Spreadsheet.

Parameters
- user: User | string
Returns Spreadsheet

addViewers

addViewers(emailAddresses: string[]): Spreadsheet

- Defined in lib/spreadsheet/Spreadsheet.ts:138
Adds the given array of users to the list of viewers for the Spreadsheet.

Parameters
- emailAddresses: string[]
Returns Spreadsheet

appendRow

appendRow(columns: Array<any>): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:162
Appends a row to the spreadsheet.

Parameters
- columns: Array<any>
Returns Sheet

deleteColumn

deleteColumn(columnPosition: number): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:172
Deletes the column at the given column position.

Parameters
- columnPosition: number
Returns Sheet

deleteColumns

deleteColumns(columnPosition: number, howMany: number): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:183
Deletes a number of columns starting at the given column position.

Parameters
- columnPosition: number
- howMany: number
Returns Sheet

deleteRow

deleteRow(rowPosition: number): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:193
Deletes the row at the given column position.

Parameters
- rowPosition: number
Returns Sheet

deleteRows

deleteRows(rowPosition: number, howMany: number): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:204
Deletes a number of rows starting at the given column position.

Parameters
- rowPosition: number
- howMany: number
Returns Sheet

deleteSheet

deleteSheet(sheet: Sheet): void

- Defined in lib/spreadsheet/Spreadsheet.ts:213
Deletes the specified sheet.

Parameters
- sheet: Sheet
Returns void

duplicateActiveSheet

duplicateActiveSheet(): void

- Defined in lib/spreadsheet/Spreadsheet.ts:221
Duplicates the active sheet and makes it the active sheet.

Returns void

getActiveCell

getActiveCell(): Range

- Defined in lib/spreadsheet/Spreadsheet.ts:230
Returns the active cell in this sheet.

Returns Range

getActiveRange

getActiveRange(): Range

- Defined in lib/spreadsheet/Spreadsheet.ts:239
Returns the active range for the active sheet.

Returns Range

getActiveSheet

getActiveSheet(): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:246
Gets the active sheet in a spreadsheet.

Returns Sheet

getDataRange

getDataRange(): Range

- Defined in lib/spreadsheet/Spreadsheet.ts:256
Returns a Range corresponding to the dimensions in which data is present. This is functionally equivalent to creating a Range bounded by A1 and (Range.getLastColumn(), Range.getLastRow()).

Returns Range

getEditors

getEditors(): User[]

- Defined in lib/spreadsheet/Spreadsheet.ts:265
Gets the list of editors for this Spreadsheet.

Returns User[]

getId

getId(): number

- Defined in lib/spreadsheet/Spreadsheet.ts:274
Gets a unique identifier for this spreadsheet.

Returns number

getLastColumn

getLastColumn(): number

- Defined in lib/spreadsheet/Spreadsheet.ts:281
Returns the position of the last column that has content.

Returns number

getLastRow

getLastRow(): number

- Defined in lib/spreadsheet/Spreadsheet.ts:288
Returns the position of the last row that has content.

Returns number

getName

getName(): string

- Defined in lib/spreadsheet/Spreadsheet.ts:297
Gets the name of the document.

Returns string

getNamedRanges

getNamedRanges(): NamedRange[]

- Defined in lib/spreadsheet/Spreadsheet.ts:306
Gets all the named ranges in this spreadsheet.

Returns NamedRange[]

getNumSheets

getNumSheets(): number

- Defined in lib/spreadsheet/Spreadsheet.ts:315
Returns the number of sheets in this spreadsheet.

Returns number

getRange

getRange(a1Notation: string): Range

- Defined in lib/spreadsheet/Spreadsheet.ts:325
Returns the range as specified in A1 notation or R1C1 notation.

Parameters
- a1Notation: string
Returns Range

getSheetByName

getSheetByName(name: string): Sheet | null

- Defined in lib/spreadsheet/Spreadsheet.ts:334
Returns a sheet with the given name.

Parameters
- name: string
Returns Sheet | null

getSheetValues

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

- Defined in lib/spreadsheet/Spreadsheet.ts:350
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[]

getSheets

getSheets(): Sheet[]

- Defined in lib/spreadsheet/Spreadsheet.ts:357
Gets all the sheets in this spreadsheet.

Returns Sheet[]

getViewers

getViewers(): User[]

- Defined in lib/spreadsheet/Spreadsheet.ts:366
Gets the list of viewers and commenters for this Spreadsheet.

Returns User[]

init

init(__namedParameters: object): void

- Defined in lib/spreadsheet/Spreadsheet.ts:61
Initialize Sheet.

Parameters
- __namedParameters: object
  - cellValue: undefined | CellValue
  - name: string
  - numColumns: number
    
    Column dimension size
  - numRows: number
    
    Row dimension size
Returns void

insertColumnAfter

insertColumnAfter(afterPosition: number): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:375
Inserts a column after the given column position.

Parameters
- afterPosition: number
Returns Sheet

insertColumnBefore

insertColumnBefore(beforePosition: number): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:383
Inserts a column before the given column position.

Parameters
- beforePosition: number
Returns Sheet

insertColumnsAfter

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

- Defined in lib/spreadsheet/Spreadsheet.ts:393
Inserts a number of columns after the given column position.

Parameters
- afterPosition: number
- howMany: number
Returns Sheet

insertColumnsBefore

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

- Defined in lib/spreadsheet/Spreadsheet.ts:403
Inserts a number of columns before the given column position.

Parameters
- beforePosition: number
- howMany: number
Returns Sheet

insertRowAfter

insertRowAfter(afterPosition: number): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:412
Inserts a row after the given row position.

Parameters
- afterPosition: number
Returns Sheet

insertRowBefore

insertRowBefore(beforePosition: number): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:421
Inserts a row before the given row position.

Parameters
- beforePosition: number
Returns Sheet

insertRowsAfter

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

- Defined in lib/spreadsheet/Spreadsheet.ts:431
Inserts a number of rows after the given row position.

Parameters
- afterPosition: number
- howMany: number
Returns Sheet

insertRowsBefore

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

- Defined in lib/spreadsheet/Spreadsheet.ts:441
Inserts a number of rows before the given row position.

Parameters
- beforePosition: number
- howMany: number
Returns Sheet

insertSheet

insertSheet(sheetIndex?: undefined | number, options?: any): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:450
Inserts a new sheet in the spreadsheet, with a default name. As a side effect, it makes it the active sheet.

Parameters
- Optional sheetIndex: undefined | number
- Optional options: any
Returns Sheet

removeNamedRanges

removeNamedRanges(name: NamedRange): void

- Defined in lib/spreadsheet/Spreadsheet.ts:472
Remove named ranges in this spreadsheet.

Parameters
- name: NamedRange
Returns void

setActiveRange

setActiveRange(range: any): Range

- Defined in lib/spreadsheet/Spreadsheet.ts:482
Sets the active range for the active sheet.

Parameters
- range: any
Returns Range

setActiveSheet

setActiveSheet(sheet: any): Sheet

- Defined in lib/spreadsheet/Spreadsheet.ts:491
Sets the active sheet in a spreadsheet.

Parameters
- sheet: any
Returns Sheet

Generated using TypeDoc