editCellRange

await crafttechApi.editCellRange(
  fileHandler,
  sheetName,
  cellRange,
  data,
  (flag = "value")
);

Описание

Вносит изменения в значения диапазона ячеек.

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

Параметры

• fileHandler (number) — ссылка на файл; ссылку предоставляет метод openFile;
• sheetName (string) — название листа;
• cellRange (string) — диапазон ячеек;
• data (string | number | null)[][] | string — двумерный массив с числовыми или строковыми данными ячеек; если необходимо очистить значения диапазона ячеек, то передаётся пустая строка;
• flag (string) — необязательный параметр, указывающий, что именно пользователь хочет изменить:

  • value — в поле data передаются значения в виде строк (по умолчанию);

  • formula — флаг для изменения формулы ячейки, в поле data передаются формулы в виде строк;

  • value, formula — флаг для изменения значения и формулы, в поле data передаются объекты в следующем формате:

    {
      value: 'Строка', // значение, которое будет заменено
      formula: 'C1+A5', // формула ячейки
    }

Передаются данные в виде одного большого массива, в нём — другие массивы, которые соответствуют порядковому номеру ряда в документе. Элементы внутри второго массива соответствуют порядку столбцов в введённом диапазоне. Если мы пишем ” (пустая строка) — это означает, что мы хотим пропустить ячейку.

Возвращает

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

Пример

const result = await crafttechApi.editCellRange(
  fileHandler,
  "Лист1",
  "F102:G103",
  [
    ["TEST", "METHOD"],
    ["", 123],
  ]
);

console.log("Значения изменены: ", result);

Очищение

const result = await crafttechApi.editCellRange(
  fileHandler,
  "Лист1",
  "F102:G103",
  ""
);