ws.structure

WorksheetStructure

14 methods

insertRows

→ Promise<InsertRowsReceipt>

insertRows(index: number, count: number): Promise<InsertRowsReceipt>;

Parameter	Type	Required
index	number	required
count	number	required

Insert rows starting at the given 0-based index.

InsertRowsReceipt

deleteRows

→ Promise<DeleteRowsReceipt>

deleteRows(index: number, count: number): Promise<DeleteRowsReceipt>;

Parameter	Type	Required
index	number	required
count	number	required

Delete rows starting at the given 0-based index.

DeleteRowsReceipt

insertColumns

→ Promise<InsertColumnsReceipt>

insertColumns(index: number, count: number): Promise<InsertColumnsReceipt>;

Parameter	Type	Required
index	number	required
count	number	required

Insert columns starting at the given 0-based index.

InsertColumnsReceipt

deleteColumns

→ Promise<DeleteColumnsReceipt>

deleteColumns(index: number, count: number): Promise<DeleteColumnsReceipt>;

Parameter	Type	Required
index	number	required
count	number	required

Delete columns starting at the given 0-based index.

DeleteColumnsReceipt

insertCellsWithShift

→ Promise<InsertCellsReceipt>

insertCellsWithShift(
    startRow: number,
    startCol: number,
    endRow: number,
    endCol: number,
    direction: 'right' | 'down',
  ): Promise<InsertCellsReceipt>;

Parameter	Type	Required
startRow	number	required
startCol	number	required
endRow	number	required
endCol	number	required
direction	'right' \| 'down'	required

Insert cells by shifting existing cells in the specified direction.

InsertCellsReceipt

deleteCellsWithShift

→ Promise<DeleteCellsReceipt>

deleteCellsWithShift(
    startRow: number,
    startCol: number,
    endRow: number,
    endCol: number,
    direction: 'left' | 'up',
  ): Promise<DeleteCellsReceipt>;

Parameter	Type	Required
startRow	number	required
startCol	number	required
endRow	number	required
endCol	number	required
direction	'left' \| 'up'	required

Delete cells by shifting remaining cells in the specified direction.

DeleteCellsReceipt

getRowCount

→ Promise<number>

getRowCount(): Promise<number>;

Get the number of rows with data.

getColumnCount

→ Promise<number>

getColumnCount(): Promise<number>;

Get the number of columns with data.

textToColumns

→ Promise<void>

textToColumns(range: string, options: TextToColumnsOptions): Promise<void>;

Parameter	Type	Required
range	string	required
options	TextToColumnsOptions	required

Split text in a column into multiple columns.

TextToColumnsOptions

removeDuplicates

→ Promise<RemoveDuplicatesResult>

removeDuplicates(
    range: string,
    columns: number[],
    hasHeaders?: boolean,
  ): Promise<RemoveDuplicatesResult>;

Parameter	Type	Required
range	string	required
columns	number[]	required
hasHeaders	boolean	optional

Remove duplicate rows in a range.

RemoveDuplicatesResult

merge

→ Promise<MergeReceipt>

merge(range: string): Promise<MergeReceipt>;

Parameter	Type	Required
range	string	required

Merge cells by A1 range.

MergeReceipt

unmerge

→ Promise<UnmergeReceipt>

unmerge(range: string): Promise<UnmergeReceipt>;

Parameter	Type	Required
range	string	required

Unmerge cells by A1 range.

UnmergeReceipt

getMergedRegions

→ Promise<MergedRegion[]>

getMergedRegions(): Promise<MergedRegion[]>;

Get all merged regions in the sheet.

MergedRegion

getMergeAtCell

→ Promise<CellRange | null>

getMergeAtCell(address: string): Promise<CellRange | null>;

Parameter	Type	Required
address	string	required

Get the merge containing a cell by A1 address, or null if not merged.

CellRange