findCellsByValue

await crafttechApi.findCellsByValue(fileHandler, sheetName, value, flag);

Описание

Находит все ячейки листа, соответствующие указанному значению.

Параметры

• fileHandler (number) — ссылка на файл; ссылку предоставляет метод openFile;
• sheetName (string) — название листа;
• value (string) — значение, которому должна соответствовать ячейка.
• flag (string/object) (Необязательный параметр) - строковое значение в котором указан диапазон ‘A1:C5’, или объект с ключами {range: ‘A1:C5’, resType: ‘new’}. При этом в объекте может присутствовать и только один из ключей. Если есть ключ range - то поиск будет происходить в конкретном диапазоне, если есть ключ resType - то будет будет изменен тип возвращаемой информации.

Возвращает

Возврат без ключа resType (Поведение по умолчанию)

• addressRange (string[]) — массив строк с адресами найденных ячеек.
• Возврат с ключом resType
• addressRangeNew (object[]) - массив объектов с адресами, номерами строк и колонок и значением ячейки. Пример [{address: ‘A1’, col: 1, row: 1, value: ‘testValue’},{address: ‘C2’, col: 3, row: 2, value: ‘testValue’}]. Значения address и value - типа string, а col и row - типа number

Пример

const fileHandler = await crafttechApi.openFile("book.xlsx");
const range = await crafttechApi.findCellsByValue(
  fileHandler,
  "Лист1",
  "testValue"
);
console.log("testValue найден в следующих ячейках: ", range);

const fileHandler = await crafttechApi.openFile("book.xlsx");
const range = await crafttechApi.findCellsByValue(
  fileHandler,
  "Лист1",
  "testValue",
  { range: "A15:D20", resType: "new" }
);
console.log("testValue найден в следующих ячейках: ", range);

const fileHandler = await crafttechApi.openFile("book.xlsx");
const range = await crafttechApi.findCellsByValue(
  fileHandler,
  "Лист1",
  "testValue",
  "A15:D20"
);
console.log("testValue найден в следующих ячейках: ", range);