Class 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 , если правило группировки по дате и времени не установлено.
get Dimension() Dimension Возвращает, является ли это строкой или группой столбцов.
get Group Limit() Pivot Group Limit Возвращает ограничение сводной группы для сводной группы.
get Index() Integer Возвращает индекс этой сводной группы в текущем порядке групп.
get Pivot Table() Pivot Table Возвращает Pivot Table , к которой принадлежит данная группа.
get Source Data Column() Integer Возвращает номер столбца исходных данных, суммируемого этой группой.
get Source Data Source Column() Data Source Column Возвращает столбец источника данных, с которым работает сводная группа.
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 Возвращает, отображаются ли в данный момент общие значения для этой сводной группы.

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

add Manual Grouping Rule(groupName, groupMembers)

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

Параметры

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

are Labels Repeated()

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

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

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

Авторизация

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

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

clear Grouping Rule()

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

clear Sort()

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

get Date Time Grouping Rule()

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

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

Date Time Grouping Rule — правило группировки даты и времени.

Авторизация

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

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

get Dimension()

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

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

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

Авторизация

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

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

get Group Limit()

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

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

Pivot Group Limit — ограничение сводной группы.

Авторизация

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

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

get Index()

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

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

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

Авторизация

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

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

get Pivot Table()

Возвращает Pivot Table , к которой принадлежит данная группа.

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

Pivot Table — сводная таблица, к которой принадлежит данная группа.

Авторизация

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

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

get Source Data Column()

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

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

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

Авторизация

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

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

get Source Data Source Column()

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

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

Data Source Column — столбец источника данных, с которым работает сводная группа.

Авторизация

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

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

hide Repeated Labels()

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

is Sort Ascending()

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

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

Boolean — true , если порядок сортировки является возрастающим.

Авторизация

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

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

move To Index(index)

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

Параметры

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

  • 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

remove Manual Grouping Rule(groupName)

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

Параметры

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

reset Display Name()

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

set Date Time Grouping Rule(dateTimeGroupingRuleType)

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

Чтобы удалить правило, используйте clear Grouping Rule() .

Параметры

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

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

Pivot Group — Сводная группа для объединения.

Авторизация

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

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

set Display Name(name)

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

Параметры

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

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

Pivot Group — сводная группа для цепочки

Авторизация

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

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

set Group Limit(countLimit)

Устанавливает ограничение сводной группы для сводной группы. Эта операция поддерживается только для Data Source Pivot Table .

Параметры

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

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

Pivot Group — Сводная группа для цепочки.

Авторизация

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

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

set Histogram Grouping Rule(minValue, maxValue, intervalSize)

Устанавливает правило группировки гистограмм для этой сводной группы. Правило гистограммы упорядочивает значения в столбце исходных данных в сегменты постоянного размера. Все значения от min Value до max Value помещаются в группы interval размера. Все значения ниже min Value помещаются в одну корзину, как и все значения, превышающие max Value .

Параметры

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

show Repeated Labels()

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

show Totals(showTotals)

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

Параметры

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

sort Ascending()

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

sort By(value, oppositeGroupValues)

Сортирует эту группу по указанному Pivot Value для значений из opposite Group Values .

// 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[] Значения противоположной сводной группы (группы столбцов при сортировке группы строк или группы строк при сортировке группы столбцов), которые используются для сортировки. Порядок этих значений определяет приоритет разрешения конфликтов.

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

sort Descending()

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

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

Pivot Group — сводная группа для цепочки.

Авторизация

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

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

totals Are Shown()

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

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

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

Авторизация

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

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