getActiveFilePivotTableParams

await crafttechApi.getActiveFilePivotTableParams(pivotTableSheetName, pivotTableCell);

Описание

Позволяет получить сведения о полях сводной таблицы в активном файле.

‼️Данный метод работает через интерфейс‼️

Требуется, чтобы лист, на котором находится сводная таблица НЕ был скрытым.

Параметры

• pivotTableSheetName (string) — лист, на котором находится сводная таблица, параметры которой требуется получить;
• pivotTableCell (string) — адрес ячейки в формате “A1”, в которой находится сводная таблица;

Возвращает

(Object | false) — объект с параметрами сводной таблицы либо false, если таблица не найдена или недоступна.

• isFieldChecked: (null | Record<string, boolean>) - объект с именами всех существующих полей и значением boolean (true — если поле добавленно в какую-то ось);
• fields: (null | string[]) - массив с именами всех существующих полей;
• filters: (null | string[]) - массив с именами полей, добавленных в ось “Фильтры”;
• columns: (null | string[]) - массив с именами полей, добавленных в ось “Столбцы”;
• rows: (null | string[]) - массив с именами полей, добавленных в ось “Строки”;
• values: (null | string[]) - массив с именами полей, добавленных в ось “Значения”;
• isRowHeadersEnabled: (null | boolean) - флаг отображения заголовков строк (true — если включены);
• isColumnHeadersEnabled: (null | boolean) - флаг отображения заголовков столбцов (true — если включены);
• isRowStripesEnabled: (null | boolean) - флаг чередования полос в строках (зебра);
• isColumnStripesEnabled: (null | boolean) - флаг чередования полос в столбцах;
• style: (null | string) - имя или идентификатор применённого стиля оформления сводной таблицы;
• range: (null | string) - адрес диапазона ячеек, к которому привязана сводная таблица (например, “Лист1!A1:D20” или “Лист1!$A$1:$D$20”);

Пример

    await crafttechApi.getActiveFilePivotTableParams('Лист1', 'B52')