getSheetArray

await crafttechApi.getSheetArray(fileHandler, sheetName, (cellRange = ""));

Описание

Позволяет получить все строковые и числовые данные ячеек указанного диапазона на листе книги (при указании параметра cellRange, иначе вернет все данные на листе).

Параметры

• fileHandler (number) — ссылка на файл; ссылку предоставляет метод openFile.
• sheetName (string) — название листа.
• cellRange (string) — не обязательный параметр, указывающий диапазон ячеек в строковом формате (например: A1:C2), из которых нужно получить данные.

Возвращает

• sheetArray (string | number | null)[][]) — двумерный массив с данными ячеек указанного листа книги.

Пример

const isReceived = await crafttechApi.getSheetArray(
  fileHandler,
  "Лист1",
  "A1:B3"
);
console.log("Данные получены: ", isReceived);

Ниже представлен пример вывода:

[
  ['Word', 'Time', null],
  ['Water', 'Day', 'Part']
]

Пример без указания параметра cellRange

const isReceived = await crafttechApi.getSheetArray(fileHandler, "Лист1");
console.log("Данные получены: ", isReceived);

Ниже представлен пример вывода:

[
  ['Word', 'Time', null, null, 'Way'],
  ['Water', 'Day', 'Part', 'Sound', 'Work'],
  null,
  ['Place', 4444, 'Back', null, 'Thing', null, null, null, 'Name'],
  ['Sentence', 'Man', 'Line', 'Boy', 'Farm']
]

Массив содержит в себе данные рядов на листе «Лист 1». На примере видно, что на листе присутствуют пять рядов с данными. Если ряд пустой, то он содержит значение null. Порядковый номер массива в массиве соответствует номеру ряда в документе, то есть первый массив — это данные с первого ряда, второй массив — это данные со второго ряда и так далее.

Строковые данные ячеек хранятся аналогично: первое значение в массиве соответствует значению в первой колонке, второе значение в массиве соответствует значению во второй колонке и так далее.

Из полученных данных на примере выше, мы можем сделать несколько выводов:

1. Ячейка, которая находится во втором ряду в третьей колонке содержит значение «Part»;
2. Ячейка, которая находится в четвёртом ряду в четвёртой колонке не содержит в себе никакого строкового или числового значения (но она может быть не пустая, например, она может быть окрашена в синий цвет или может быть частью таблицы);
3. Третий ряд не содержит никаких строковых или числовых данных;
4. Лист с названием «Лист 1» не содержит строковых или числовых данных ниже 5-го ряда.