deleteDrawings

await crafttechApi.deleteDrawings(fileName, sheetName, flag);

Описание

Удаляет рисунки(фигуры) с листа.

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

Параметры

• fileHandler (number) — ссылка на файл; ссылку предоставляет метод openFile;
• sheetName (string) — название листа.
• flag (string) (необязательный) — флаг, указывающий на то, какие элементы нужно удалить. Флаги можно перечислять через запятую, если необходимо удалить несколько типов (например, button, chart). Если вы не передаете флаг, то будут удалены все фигуры на листе. Доступны следующие флаги:
  • button - удаляет кнопки (shape с макросом)
  • shape - удаляет фигуры (но не кнопки)
  • chart - удаляет графики
  • picture - удаляет изображения

Возвращает

• true | false (boolean) — логическая истина true в случае успешного удаления фигур с листа.

Пример

const fileHandler = await crafttechApi.openFile("test.xlsx");
const isDeleted = await crafttechApi.deleteDrawings(
  fileHandler,
  "Лист1",
  "button, shape"
);
console.log("Фигуры удалены: ", isDeleted);
await crafttechApi.saveFile(fileHandler);

Пусть у листа «Лист1» файла test.xlsx есть документ, который нужно распечатать, и над ним на листе есть кнопки (фигуры, прямоугольники, линии и т.д.), которые запускают определённые макросы. После выполнения данного кода эти кнопки, как и любые другие фигуры (за исключением графиков), будут удалены.