setActiveFilePivotTableParam

await crafttechApi.setActiveFilePivotTableParam(pivotTableSheetName, pivotTableCell, action, value);

Описание

Устанавливает свойство сводной таблицы.

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

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

Параметры

• pivotTableSheetName (string) — имя листа на котором находится сводная таблица, у которой надо изменить свойство;
• pivotTableCell (string) — ячейка на которой находится сводная таблица;
• action (‘addToFilters’ | ‘addToColumns’ | ‘addToRows’ | ‘addToValues’ | ‘rowHeaders’ | ‘columnHeaders’ | ‘rowStripes’ | ‘columnStripes’ | ‘style’ | ‘clearAxes’ | ‘rowsParam’ | ‘columnsParam’ | ‘filtersParam’ | ‘valuesParam’) — действие (какое свойство меняем);
• value (string | boolean | Object) — свойства (формат зависит от выбранного action);

Возможные значения параметра action и value:

• addToFilters — добавить поле в ось “фильтры” сводной таблицы (в value указываем имя поля);
• addToColumns — добавить поле в ось “столбцы” (в value указываем имя поля);
• addToRows — добавить поле в ось “строки” (в value указываем имя поля);
• addToValues — добавить поле в ось “значения” (в value указываем имя поля);
• rowHeaders — включить/отключить отображение заголовков строк (value - boolean);
• columnHeaders — включить/отключить отображение заголовков столбцов (value - boolean);
• rowStripes — включить/отключить чередование строк (value - boolean);
• columnStripes — включить/отключить чередование столбцов (value - boolean);
• clearAxes — удалить все поля из осей строк, столбцов, фильтров и значений (value не требуется);

---

• style — применить один из доступных стилей к сводной таблице
  в value указываем:
  • от ‘Light_0’ до ‘Light_27’ - светлые темы;
  • от ‘Middle_0’ до ‘Middle_27’ - средние темы;
  • от ‘Dark_0’ до ‘Dark_27’ - тёмные темы;
  • ‘None’ - без темы;

---

• rowsParam — редактирование параметров полей;

• columnsParam — редактирование параметров полей;

• filtersParam — редактирование параметров полей;
  в value (Object) - указываем свойства:

  • name (string) - имя редактируемого поля;
  • operation (Object) - (необязательный) какие функции промежуточных итогов надо включить;
    • sum: (boolean) - (необязательный) Сумма;
    • count: (boolean) - (необязательный) Количество;
    • average: (boolean) - (необязательный) Среднее;
    • max: (boolean) - (необязательный) Максимум;
    • min: (boolean) - (необязательный) Минимум;
    • product: (boolean) - (необязательный) Произведение;
    • countNumbers: (boolean) - (необязательный) Количество чисел;
    • stdDev: (boolean) - (необязательный) Стандартное отклонение (выборка);
    • stdDevP: (boolean) - (необязательный) Стандартное отклонение (по всей генеральной совокупности);
    • varS: (boolean) - (необязательный) Дисперсия (выборка);
    • varP: (boolean) - (необязательный) Дисперсия (по всей генеральной совокупности);
  • newName (string) - (необязательный) новое имя редактируемого поля;

Пример:

    await setActiveFilePivotTableParam('Лист1', 'B11', 'rowsParam', {
      name: 'Т2 С4',
      operation: {
        sum: true,
        count: true,
        average: false,
        max: false,
        min: false,
        product: false,
        countNumbers: true,
        stdDev: true,
        stdDevP: false,
        varS: true,
        varP: false,
      },
      newName: 'new name1',
    });

---

• valuesParam — редактирование параметров поля значений;
  в value (Object) - указываем свойства:

  • name - имя редактируемого поля;
  • operation (‘Sum’ | ‘Count’ | ‘Average’ | ‘Max’ | ‘Min’ | ‘Product’ | ‘Count Numbers’ | ‘StdDev’ | ‘StdDevP’ | ‘VarS’ | ‘VarP’) - операция;
  • showValuesAs - Дополнительные вычисления, возможные значения:
    • None - Без вычислений;
    • % of Grand Total - % от общей суммы;
    • % of Column Total - % от столбца;
    • % of Row Total - % от строки;
    • Parent Total - Доля;
    • % of Parent Row Total - % от суммы по родительской строке;
    • % of Parent Column Total - % от суммы по родительскому столбцу;
    • % of Parent Total - % от родительской суммы;
    • Difference - Отличие;
    • % Difference - Разница (%);
    • Running Total In - С нарастающим итогом в поле;
    • % Running Total In - % от суммы с нарастающим итогом в поле;
    • Rank Smallest to Largest - Сортировка от минимального к максимальному;
    • Rank Largest to Smallest - Сортировка от максимального к минимальному;
    • Index - Индекс;
  • baseField (string) - базовое поле (значение одного из заголовков столбцов таблицы - источника сводной таблицы), которое указывается только если showValuesAs имеет одно из значений: (’% of Parent Total’ | ‘Running Total In’ | ’% Running Total In’ | ‘Rank Smallest to Largest’ | ‘Rank Largest to Smallest’ | ‘Parent Total’ | ‘Difference’ | ’% Difference’);
  • baseItem (string) - базовый элемент (значение одной из строк под выбранным в baseField заголовком), которое указывается только если showValuesAs имеет одно из значений: (‘Parent Total’ | ‘Difference’ | ’% Difference’);
  • newName - (необязательный) новое имя редактируемого поля;

Пример:

    await setActiveFilePivotTableParam('Лист1', 'B11', 'valuesParam', {
      name: 'Среднее из Т2 С6',
      operation: 'Max',
      showValuesAs: 'Parent Total',
      newName: 'new name4',
      baseField: 'Т2 С8',
      baseItem: '2',
    });

    await setActiveFilePivotTableParam('Лист1', 'B11', 'valuesParam', {
      name: 'Среднее из Т2 С6',
      operation: 'Max',
      showValuesAs: '% of Parent Total',
      newName: 'new name4',
      baseField: 'Т2 С8',
    });

    await setActiveFilePivotTableParam('Лист1', 'B11', 'valuesParam', {
      name: 'Среднее из Т2 С6',
      operation: 'Max',
      showValuesAs: 'Index',
      newName: 'new name4',
    });

Возвращает

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

Примеры

    await crafttechApi.createActiveFilePivotTable('Лист1', 'B11', 'addToColumns', 'Цена');
    await crafttechApi.createActiveFilePivotTable('Лист1', 'B11', 'style', 'Middle_22');
    await crafttechApi.createActiveFilePivotTable('Лист1', 'B11', 'rowStripes', true);
    await setActiveFilePivotTableParam('Лист1', 'B11', 'rowsParam', {
      name: 'Т2 С4',
      operation: {
        sum: true,
        count: true,
        average: true,
        max: true,
        min: true,
        product: true,
        countNumbers: true,
        stdDev: true,
        stdDevP: true,
        varS: true,
        varP: true,
      },
      newName: 'new name1',
    });
    await setActiveFilePivotTableParam('Лист1', 'B11', 'filtersParam', {
      name: 'Т2 С1',
      operation: {
        sum: true,
        count: true,
        average: true,
        max: true,
        min: true,
        product: true,
        countNumbers: true,
        stdDev: true,
        stdDevP: true,
        varS: true,
        varP: true,
      },
      newName: 'new name2',
    });
    await setActiveFilePivotTableParam('Лист1', 'B11', 'columnsParam', {
      name: 'Т2 С2',
      operation: {
        sum: true,
        count: true,
        average: true,
        max: true,
        min: true,
        product: true,
        countNumbers: true,
        stdDev: true,
        stdDevP: true,
        varS: true,
        varP: true,
      },
      newName: 'new name3',
    });
    await setActiveFilePivotTableParam(
      'Лист1',
      'B11',
      'valuesParam',
      {
        name: 'Среднее из Т2 С6',
        operation: 'Max',
        showValuesAs: 'Parent Total',
        newName: 'new name4',
        baseField: 'Т2 С8',
        baseItem: '2',
      }
    );