Function hideWorksheet

  • hideWorksheet(workbook, identifier): void

  • Parameters

    • workbook: Workbook

      Workbook

    • identifier: string | number | RegExp

      string | number | RegExp - The identifier of the worksheet to hide. If a string, it will be matched against the worksheet name. If a number, it will be treated as a 1-based index. If a RegExp, it will be used to test the worksheet name. If no matching worksheet is found, nothing will happen. If the last visible worksheet is hidden, nothing will happen. If there are no visible worksheets left, nothing will happen. If the identifier is 0, a warning will be logged.

    Returns void

    void *

    Example

    •
    • hideWorksheet(workbook, 'Sheet1');
    • hideWorksheet(workbook, 2);
    • hideWorksheet(workbook, /Sheet\d/);
    •

Settings