renameSheet

await crafttechApi.renameSheet(fileHandler, oldName, newName);

Описание

Переименовывает лист в книге.

Требует сохранения при помощи saveFile (для внешнего файла), либо applyActiveFileChanges (для текущего файла).

Параметры

• fileHandler (number) — ссылка на файл; ссылку предоставляет метод openFile;
• oldName (string) — прежнее название листа;
• newName (string) — новое название листа.

Возвращает

• true | false (boolean) — возвращает логическую истину true в случае успешного переименования листа, иначе false.

Пример

const fh = await crafttechApi.openFile("book.xlsx");
await crafttechApi.renameSheet(fh, "Лист 1", "Total");
await crafttechApi.saveFile(fh);