WorkSheet

Constructors

Constructor

new WorkSheet(jsf: Worksheet, wb: Workbook): WorkSheet;

Parameters

Parameter	Type
jsf	Worksheet
wb	Workbook

Returns

WorkSheet

Properties

Property	Type
_size	[number, number]
cells	Map<number, Cell>
columns	GridSize[]
colWidths	Record<number, number> | null
comments?	ThreadedComment[]
defaults	WorksheetDefaults
drawings?	Drawing[]
hidden	0 | 1 | 2
merged_cells	string[]
name	string
notes?	Note[]
rows	GridSize[]
views?	WorksheetView[]
workbook	Workbook

Methods

getCellByCoords()

getCellByCoords(row: number, col: number): Cell | null;

Parameters

Parameter	Type
row	number
col	number

Returns

Cell | null

---

getComments()

getComments(options?: {
  excludeReplies?: boolean;
  excludeResolved?: boolean;
}): ThreadedComment[];

Gets the worksheet’s threaded comments with optional filtering.

Parameters

Parameter	Type	Description
options	{ excludeReplies?: boolean; excludeResolved?: boolean; }	Filtering options for the comments. Can be combined.
options.excludeReplies?	boolean	When true, excludes any comments that are replies to other comments. Defaults to false.
options.excludeResolved?	boolean	When true, excludes comments marked as resolved. Defaults to false.

Returns

ThreadedComment[]

---

getNotes()

getNotes(): Note[];

Gets the worksheet’s notes.

Returns

Note[]

---

getSize()

getSize(): [number, number];

Returns

[number, number]

---

nextValueCellByCoords()

nextValueCellByCoords(
   row: number,
   col: number,
   dir: "left" | "right" | "up" | "down"): Cell | null;

Parameters

Parameter	Type
row	number
col	number
dir	"left" | "right" | "up" | "down"

Returns

Cell | null