Function: insertWorksheet()

function insertWorksheet(
   workbook: Workbook, 
   name: string, 
   position: {
  before?: string | number;
  after?: string | number;
  atIndex?: number;
}): Worksheet;

Defined in: src/excel/excel.tsx:515

Insert a new worksheet at a specific position.

Parameters

Parameter	Type	Description
workbook	Workbook	The ExcelJS workbook instance.
name	string	The name for the new worksheet.
position	{ before?: string | number; after?: string | number; atIndex?: number; }	Position config with before, after, or atIndex.
position.before?	string | number	-
position.after?	string | number	-
position.atIndex?	number	-

Returns

Worksheet

The newly created worksheet.

Example

const sheet = insertWorksheet(workbook, 'Cover Page', { atIndex: 0 });
insertWorksheet(workbook, 'Notes', { after: 'Data' });
insertWorksheet(workbook, 'Intro', { before: 'Summary' });