Class GoogleSheet

Hierarchy

Common
- GoogleSheet

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GoogleSheet(authClass: IAuthClass, spreadsheetId: string, sheetId?: number): GoogleSheet

Overrides Common.constructor
- Defined in sheets/google-sheet.ts:13
Parameters
- authClass: IAuthClass
- spreadsheetId: string
- Default value sheetId: number = 0
Returns GoogleSheet

Properties

api

api: API

colIndex

colIndex: NonStrict<number>

dimension

dimension: NonStrict<"ROW" | "COLUMN">

Optional rowIndex

rowIndex: undefined | number

sheetId

sheetId: number

spreadsheetId

spreadsheetId: string

Methods

getBatchData

getBatchData(options?: ISheetBatchDataOptions | Callback<string[][][]>, callback?: Callback<string[][][]>): void

- Defined in sheets/google-sheet.ts:18
Parameters
- Default value options: ISheetBatchDataOptions | Callback<string[][][]> = {}
- Default value callback: Callback<string[][][]> = utils.noop
Returns void

getData

getData(options?: ISheetDataOptions | Callback<string[][]>, callback?: Callback<string[][]>): void

- Defined in sheets/google-sheet.ts:67
Parameters
- Default value options: ISheetDataOptions | Callback<string[][]> = {}
- Default value callback: Callback<string[][]> = utils.noop
Returns void

getInfo

getInfo(callback?: Callback<ISpreadsheetInfo>): void

Inherited from Common.getInfo
- Defined in common.ts:69
Parameters
- Default value callback: Callback<ISpreadsheetInfo> = utils.noop
Returns void

getSheetTitle

getSheetTitle(callback?: Callback<OrArray<ISheetIdentifiers>>): void

Inherited from Common.getSheetTitle
- Defined in common.ts:44
Parameters
- Default value callback: Callback<OrArray<ISheetIdentifiers>> = utils.noop
Returns void

setBatchData

setBatchData(data: NonStrict<string>[][][], options?: ISheetBatchDataOptions | Callback<any>, callback?: Callback<any>): void

- Defined in sheets/google-sheet.ts:108
Parameters
- data: NonStrict<string>[][][]
- Default value options: ISheetBatchDataOptions | Callback<any> = {}
- Default value callback: Callback<any> = utils.noop
Returns void

setData

setData(data: NonStrict<string>[][], options?: ISheetDataOptions | Callback<any>, callback?: Callback<any>): void

- Defined in sheets/google-sheet.ts:164
Parameters
- data: NonStrict<string>[][]
- Default value options: ISheetDataOptions | Callback<any> = {}
- Default value callback: Callback<any> = utils.noop
Returns void