Class PivotGroup

Сводная группа

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

Методы

Метод Тип возврата Краткое описание
addManualGroupingRule(groupName, groupMembers) PivotGroup Добавляет правило группировки вручную для этой сводной группы.
areLabelsRepeated() Boolean Возвращает, отображаются ли метки как повторяющиеся.
clearGroupingRule() PivotGroup Удаляет все правила группировки из этой сводной группы.
clearSort() PivotGroup Удаляет любую сортировку, примененную к этой группе.
getDateTimeGroupingRule() DateTimeGroupingRule Возвращает правило группировки по дате и времени для сводной группы или null , если правило группировки по дате и времени не установлено.
getDimension() Dimension Возвращает, является ли это строкой или группой столбцов.
getGroupLimit() PivotGroupLimit Возвращает ограничение сводной группы для сводной группы.
getIndex() Integer Возвращает индекс этой сводной группы в текущем порядке групп.
getPivotTable() PivotTable Возвращает PivotTable , к которой принадлежит эта группа.
getSourceDataColumn() Integer Возвращает номер столбца исходных данных, суммируемого этой группой.
getSourceDataSourceColumn() DataSourceColumn Возвращает столбец источника данных, с которым работает сводная группа.
hideRepeatedLabels() PivotGroup Скрывает повторяющиеся метки для этой группы.
isSortAscending() Boolean Возвращает true если сортировка происходит по возрастанию, и возвращает false если порядок сортировки по убыванию.
moveToIndex(index) PivotGroup Перемещает эту группу в указанную позицию в текущем списке групп строк или столбцов.
remove() void Удаляет эту сводную группу из таблицы.
removeManualGroupingRule(groupName) PivotGroup Удаляет правило ручной группировки с указанным groupName .
resetDisplayName() PivotGroup Сбрасывает отображаемое имя этой группы в сводной таблице до значения по умолчанию.
setDateTimeGroupingRule(dateTimeGroupingRuleType) PivotGroup Устанавливает правило группировки по дате и времени в сводной группе.
setDisplayName(name) PivotGroup Задает отображаемое имя этой группы в сводной таблице.
setGroupLimit(countLimit) PivotGroup Устанавливает ограничение сводной группы для сводной группы.
setHistogramGroupingRule(minValue, maxValue, intervalSize) PivotGroup Устанавливает правило группировки гистограмм для этой сводной группы.
showRepeatedLabels() PivotGroup Если существует более одной группировки строк или столбцов, этот метод отображает метку этой группировки для каждой записи последующей группировки.
showTotals(showTotals) PivotGroup Определяет, отображать ли общие значения для этой сводной группы в таблице.
sortAscending() PivotGroup Устанавливает порядок сортировки по возрастанию.
sortBy(value, oppositeGroupValues) PivotGroup Сортирует эту группу по указанному PivotValue для значений из oppositeGroupValues ​​.
sortDescending() PivotGroup Устанавливает порядок сортировки по убыванию.
totalsAreShown() Boolean Возвращает, отображаются ли в данный момент общие значения для этой сводной группы.

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

addManualGroupingRule(groupName, groupMembers)

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

Параметры

Имя Тип Описание
groupName String Имя этого правила группировки.
groupMembers 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 — Правило группировки по дате и времени.

Авторизация

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

  • 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 — Ограничение сводной группы.

Авторизация

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

  • 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 — Столбец источника данных, с которым работает сводная группа.

Авторизация

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

  • 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 .

Параметры

Имя Тип Описание
groupName 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 clearGroupingRule() .

Параметры

Имя Тип Описание
dateTimeGroupingRuleType DateTimeGroupingRuleType Тип правила, который необходимо установить.

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

PivotGroup — сводная группа для объединения.

Авторизация

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

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

setDisplayName(name)

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

Параметры

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

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

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

Авторизация

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

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

setGroupLimit(countLimit)

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

Параметры

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

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

PivotGroup — сводная группа для объединения.

Авторизация

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

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

setHistogramGroupingRule(minValue, maxValue, intervalSize)

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

Параметры

Имя Тип Описание
minValue Integer Минимальное значение для элементов, помещаемых в корзины. Значения меньше этого значения объединяются в один сегмент.
maxValue Integer Максимальное значение элементов, помещаемых в корзины. Значения, превышающие это значение, объединяются в один сегмент.
intervalSize 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)

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

Параметры

Имя Тип Описание
showTotals 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.
var sheet = SpreadsheetApp.getActiveSheet();
var pivotTable = sheet.getPivotTables()[0];
var itemGroup = pivotTable.getRowGroups()[0];
var sumQuantityValue = pivotTable.getPivotValues()[0];
itemGroup.sortBy(sumQuantityValue, ['Beth', 'Amir', 'Devyn']);

Параметры

Имя Тип Описание
value PivotValue Сводное значение для сортировки.
oppositeGroupValues 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