Function: getWorksheetIndex()

function getWorksheetIndex(workbook: Workbook, query: string | RegExp): number;

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

Get the zero-based index of a worksheet by name or pattern.

Parameters

Parameter	Type	Description
workbook	Workbook	The ExcelJS workbook instance.
query	string | RegExp	The worksheet name or RegExp pattern.

Returns

number

The zero-based index, or -1 if not found.

Example

const idx = getWorksheetIndex(workbook, 'Invoices');
const idx2 = getWorksheetIndex(workbook, /^Data/);