Function insertWorksheet

  • insertWorksheet(workbook, name, position): Worksheet

  • Inserts a worksheet at a specific position relative to other sheets.

    Parameters

    • workbook: Workbook

      The ExcelJS workbook instance.

    • name: string

      The name for the new worksheet.

    • position: {
          after?: string | number;
          atIndex?: number;
          before?: string | number;
      }

      The position configuration object.

      • Optionalafter?: string | number
      • OptionalatIndex?: number
      • Optionalbefore?: string | number

    Returns Worksheet

    The newly created worksheet.

    Example

    insertWorksheet(workbook, 'NewSheet', { atIndex: 0 }); // Insert at the beginning
    insertWorksheet(workbook, 'AfterData', { after: 'Data' });
    insertWorksheet(workbook, 'BeforeSummary', { before: 'Summary' });

Settings