conditionalFormatting

await crafttechApi.conditionalFormatting(fileHandler, sheetName, config);

Описание

Добавляет условное форматирование для выбранных ячеек.

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

Параметры

• fileHandler (number) — ссылка на файл; ссылку предоставляет метод openFile;
• sheetName (string) — название листа;
• config (object) — объект с полями, которые необходимо поменять. Поля могу сильно розниться в зависимости от типа. Смотрите необходимый вам тип для заполнения конфига. Основные поля:
  • sqref (обязательный) (string) — ячейка или диапазон ячеек, к которому будет применено условное форматирование;
  • type (обязательный) (string) — тип условного форматирования, см. Типы условного форматирования ниже;
  • style (object) — объект стилей, для заполнения см. editCells;

Типы условного форматирования

containsText

срабатывает, если ячейка включает в себя текст. Для корректной работы необходимо добавить в config поле text.

Пример конфига:

{
   sqref: 'A1',
   text: '+',
   style: {
      font: {
         colorRgb: 'FFDADADA',
         patternType: 'solid',
      }
   },
   type: 'containsText',
}

cells

для работы необходимо указать в config поля operator, а также formula. В формулу передается число для сравнения со значением ячейки. Доступны следующие операторы:

1. greaterThan (больше чем),
2. greaterThanOrEqual (больше либо равно),
3. lessThan (меньше чем),
4. lessThanOrEqual (меньше либо равно),
5. equal (равно),
6. notEqual (не равно),
7. between (между, в поле formula необходимо передать массив с двумя числами),
8. notBetween (не между, в поле formula необходимо передать массив с двумя числами).

Пример конфига:

{
   sqref: 'A1',
   style: {
      font: {
         colorRgb: 'FFDADADA',
         patternType: 'solid',
      }
   },
   type: 'cellIs',
   operator: 'notEqual',
   formula: 0,
}

iconSet

изменяется в зависимости от значения ячейки. Для корректной работы необходимо добавить в config поля: values, iconSet, showValue(необязательный).

Пример конфига:

iconSet: 3Symbols (крест, воскл. знак, галочка в круге), 3Symbols2 (крест, воскл. знак, галочка без круга)

укажите showValue: false, если хотите, чтобы отображался только значок (без значения ячейки) порядок

элементов values (условий) важен при выборе значка, т.е. на примере 3Symbols2: первое относится к кресту, второе - к воскл. знаку, третье - к галочке.

указать gte: false в элементе массива values необходимо, если вы хотите использовать строгое сравнение (< вместо <=)

let config = {
  sqref: "A1",
  type: "iconSet",
  showValue: false,
  iconSet: "3Symbols2",
  values: [
    {
      type: "percent", // num, percent (численное, либо процентное значение)
      val: 0,
    },
    {
      type: "num",
      gte: false,
      val: 2,
    },
    {
      type: "num",
      gte: false,
      val: 3,
    },
  ],
};

expression

работает на версии 1.0.2.80.2 и выше.

срабатывает, если удовлетворяет значению формулы. Для корректной работы необходимо добавить в config поле formula (может быть массивом формул).

Пример конфига:

{
    style: {
        font: {
            colorRgb: 'FF9C5700'
        },
        fill: {
            fgRgb: 'FFFFEB9C',
            bgRgb: 'FFFFEB9C',
            patternType: 'solid',
        }
    },
    sqref: 'A1',
    type: 'expression',
    formula: 'E5 > 0'
}

Возвращает

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

Пример

const conf = {
  sqref: "A1",
  text: "+",
  style: {
    font: {
      colorRgb: "FFDADADA",
      patternType: "solid",
    },
  },
  type: "containsText",
};

const result = await crafttechApi.conditionalFormatting(
  fileHandler,
  "Лист1",
  conf
);
console.log("Результат выполнения: ", result);