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()

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

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

Booleantrue , если метки повторяются; в противном случае возвращает 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 , если сортировка по убыванию.

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

Booleantrue , если порядок сортировки восходящий.

Авторизация

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

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

Параметры

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

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

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

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

Авторизация

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

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