Class PivotGroup

PivotGroup

Доступ к группам разбиений сводных таблиц и их изменение.

Методы

Метод Тип возвращаемого значения Краткое описание
add Manual Grouping Rule(groupName, groupMembers) Pivot Group Добавляет правило ручной группировки для этой сводной группы.
are Labels Repeated() Boolean Возвращает значение, указывающее, отображаются ли метки как повторяющиеся.
clear Grouping Rule() Pivot Group Удаляет все правила группировки из этой сводной группы.
clear Sort() Pivot Group Отменяет любую сортировку, примененную к этой группе.
get Date Time Grouping Rule() Date Time Grouping Rule |null Возвращает правило группировки по дате и времени для сводной группы или null , если правило группировки по дате и времени не задано.
get Dimension() Dimension Возвращает значение, указывающее, является ли это группа строк или столбцов.
get Group Limit() Pivot Group Limit |null Возвращает ограничение на количество элементов в группе сводных таблиц.
get Index() Integer Возвращает индекс этой опорной группы в текущем порядке группировки.
get Pivot Table() Pivot Table Возвращает Pivot Table , к которой относится данная группа.
get Source Data Column() Integer Возвращает номер столбца исходных данных, который суммирует эта группа.
get Source Data Source Column() Data Source Column |null Возвращает столбец источника данных, с которым работает сводная группа.
hide Repeated Labels() Pivot Group Скрывает повторяющиеся метки для этой группы.
is Sort Ascending() Boolean Возвращает true , если сортировка выполняется по возрастанию, и false если сортировка выполняется по убыванию.
move To Index(index) Pivot Group Перемещает эту группу в указанное место в текущем списке групп строк или столбцов.
remove() void Удаляет эту группу сводных таблиц из таблицы.
remove Manual Grouping Rule(groupName) Pivot Group Удаляет правило ручной группировки с указанным group Name .
reset Display Name() Pivot Group Сбрасывает отображаемое имя этой группы в сводной таблице до значения по умолчанию.
set Date Time Grouping Rule(dateTimeGroupingRuleType) Pivot Group Устанавливает правило группировки по дате и времени для сводной группы.
set Display Name(name) Pivot Group Задает отображаемое имя этой группы в сводной таблице.
set Group Limit(countLimit) Pivot Group Устанавливает ограничение на количество элементов в группе сводных таблиц.
set Histogram Grouping Rule(minValue, maxValue, intervalSize) Pivot Group Задает правило группировки гистограммы для данной группы сводных таблиц.
show Repeated Labels() Pivot Group Если имеется более одной группировки строк или столбцов, этот метод отображает метку данной группировки для каждой записи последующей группировки.
show Totals(showTotals) Pivot Group Определяет, следует ли отображать итоговые значения для этой сводной группы в таблице.
sort Ascending() Pivot Group Устанавливает порядок сортировки по возрастанию.
sort By(value, oppositeGroupValues) Pivot Group Сортирует эту группу по указанному Pivot Value для значений из opposite Group Values .
sort Descending() Pivot Group Устанавливает порядок сортировки по убыванию.
totals Are Shown() Boolean Возвращает значение, указывающее, отображаются ли в данный момент итоговые значения для данной сводной группы.

Подробная документация

addManualGroupingRule(groupName, groupMembers)

Добавляет правило ручной группировки для этой сводной группы.

Параметры

Имя Тип Описание
group Name String Название этого правила группировки.
group Members Object[] Значения, включенные в это правило группировки.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

areLabelsRepeated()

Возвращает значение, указывающее, отображаются ли метки как повторяющиеся.

Возвращаться

Boolean — true , если метки повторяются; в противном случае возвращает false .

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearGroupingRule()

Удаляет все правила группировки из этой сводной группы.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

clearSort()

Отменяет любую сортировку, примененную к этой группе.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDateTimeGroupingRule()

Возвращает правило группировки по дате и времени для сводной группы или null , если правило группировки по дате и времени не задано.

Возвращаться

DateTimeGroupingRule |null — Правило группировки по дате и времени.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDimension()

Возвращает значение, указывающее, является ли это группа строк или столбцов.

Возвращаться

Dimension — измерение, представляющее тип данной группы.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getGroupLimit()

Возвращает ограничение на количество элементов в группе сводных таблиц. Возвращает null если ограничение на количество элементов в группе сводных таблиц не установлено.

Возвращаться

PivotGroupLimit |null — Ограничение на количество групп сводных таблиц.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getIndex()

Возвращает индекс этой опорной группы в текущем порядке группировки.

Возвращаться

Integer — индекс опорной группы

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getPivotTable()

Возвращает PivotTable , к которой относится данная группа.

Возвращаться

PivotTable — сводная таблица, к которой относится эта группа.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSourceDataColumn()

Возвращает номер столбца исходных данных, который суммирует эта группа. Индекс начинается с 1; если эта группа суммирует исходные данные в столбце «A» электронной таблицы, этот метод возвращает 1 .

Возвращаться

Integer — номер столбца исходных данных

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSourceDataSourceColumn()

Возвращает столбец источника данных, с которым работает группа сводных таблиц. Возвращает null если сводная таблица не является {DataSourcePivotTableApi}.

Возвращаться

DataSourceColumn |null — Столбец источника данных, с которым работает сводная группа.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

hideRepeatedLabels()

Скрывает повторяющиеся метки для этой группы. Если метки уже скрыты, это действие не выполняется. Если этот метод вызывается до добавления нескольких групп строк или столбцов, при добавлении дополнительной группы повторяющиеся метки скрываются.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isSortAscending()

Возвращает true , если сортировка выполняется по возрастанию, и false если сортировка выполняется по убыванию.

Возвращаться

Boolean — true если порядок сортировки восходящий.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveToIndex(index)

Перемещает эту группу в указанную позицию в текущем списке групп строк или столбцов. Индексы начинаются с 0. Например, если эту группу следует переместить на первую позицию, этот метод следует вызвать с значением 0 .

Параметры

Имя Тип Описание
index Integer Индекс, в который следует переместить эту группу.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

Удаляет эту группу сводных таблиц из таблицы.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeManualGroupingRule(groupName)

Удаляет правило ручной группировки с указанным groupName .

Параметры

Имя Тип Описание
group Name String Название правила группировки, которое нужно удалить.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

resetDisplayName()

Сбрасывает отображаемое имя этой группы в сводной таблице до значения по умолчанию.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setDateTimeGroupingRule(dateTimeGroupingRuleType)

Устанавливает правило группировки по дате и времени для сводной группы.

Для удаления правила используйте clearGroupingRule() .

Параметры

Имя Тип Описание
date Time Grouping Rule Type Date Time Grouping Rule Type Тип правила, который необходимо установить.

Возвращаться

PivotGroup — группа сводных таблиц для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setDisplayName(name)

Задает отображаемое имя этой группы в сводной таблице.

Параметры

Имя Тип Описание
name String Отображаемое имя для установки.

Возвращаться

PivotGroup — группа PivotGroup для построения цепочек вызовов.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setGroupLimit(countLimit)

Устанавливает ограничение на количество сводных групп. Эта операция поддерживается только для DataSourcePivotTable .

Параметры

Имя Тип Описание
count Limit Integer Ограничение на количество строк или столбцов для установки. Должно быть положительным.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setHistogramGroupingRule(minValue, maxValue, intervalSize)

Задает правило группировки гистограммы для этой сводной группы. Правило гистограммы организует значения в столбце исходных данных в группы постоянного размера. Все значения от minValue до maxValue помещаются в группы размером interval . Все значения меньше minValue помещаются в одну группу, как и все значения больше maxValue .

Параметры

Имя Тип Описание
min Value Integer Минимальное значение, при котором предметы помещаются в корзины. Значения меньше этого значения объединяются в одну корзину.
max Value Integer Максимальное значение для элементов, помещаемых в корзины. Значения, превышающие это значение, объединяются в одну корзину.
interval Size Integer

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

showRepeatedLabels()

Если имеется более одной группировки строк или столбцов, этот метод отображает метку этой группировки для каждой записи последующей группировки. Если метки уже повторяются, это не приводит к каким-либо действиям. Если этот метод вызывается до того, как появится несколько групп строк или столбцов, при добавлении дополнительной группировки будут отображаться повторяющиеся метки.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

showTotals(showTotals)

Определяет, следует ли отображать итоговые значения для этой сводной группы в таблице.

Параметры

Имя Тип Описание
show Totals Boolean Показывать ли итоговые суммы или нет.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sortAscending()

Устанавливает порядок сортировки по возрастанию.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sortBy(value, oppositeGroupValues)

Сортирует эту группу по указанному значению PivotValue для значений из oppositeGroupValues .

// Sorts the item group by the "SUM of Quantity" pivot value for the specified
// salespersons.
const sheet = SpreadsheetApp.getActiveSheet();
const pivotTable = sheet.getPivotTables()[0];
const itemGroup = pivotTable.getRowGroups()[0];
const sumQuantityValue = pivotTable.getPivotValues()[0];
itemGroup.sortBy(sumQuantityValue, ['Beth', 'Amir', 'Devyn']);

Параметры

Имя Тип Описание
value Pivot Value Опорное значение для сортировки.
opposite Group Values Object[] Значения противоположной опорной группы (группы столбцов при сортировке групп строк или группы строк при сортировке групп столбцов), используемые для сортировки. Порядок этих значений определяет приоритет при разрешении неоднозначностей.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sortDescending()

Устанавливает порядок сортировки по убыванию.

Возвращаться

PivotGroup — группа опорных точек для построения цепочек.

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

totalsAreShown()

Возвращает значение, указывающее, отображаются ли в данный момент итоговые значения для данной сводной группы.

Возвращаться

Boolean — true если для данной сводной группы отображаются итоговые значения; в противном случае возвращает false .

Авторизация

Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets