Esta página foi traduzida pela API Cloud Translation.

Class PivotGroup

Acessar e modificar grupos temáticas de tabelas dinâmicas.

Métodos

Método	Tipo de retorno	Breve descrição
`addManualGroupingRule(groupName, groupMembers)`	`PivotGroup`	Adiciona uma regra de agrupamento manual para este grupo dinâmico.
`areLabelsRepeated()`	`Boolean`	Retorna se os rótulos são exibidos como repetidos.
`clearGroupingRule()`	`PivotGroup`	Remove todas as regras de agrupamento deste grupo dinâmico.
`clearSort()`	`PivotGroup`	Remove qualquer classificação aplicada ao grupo.
`getDateTimeGroupingRule()`	`DateTimeGroupingRule`	Retorna a regra de agrupamento de data/hora no grupo dinâmico ou `null` se não houver data-hora é definida.
`getDimension()`	`Dimension`	Retorna indicando se é um grupo de linhas ou de colunas.
`getGroupLimit()`	`PivotGroupLimit`	Retorna o limite do grupo dinâmico no grupo dinâmico.
`getIndex()`	`Integer`	Retorna o índice deste grupo dinâmico na ordem do grupo atual.
`getPivotTable()`	`PivotTable`	Retorna o `PivotTable` ao qual esse agrupamento pertence.
`getSourceDataColumn()`	`Integer`	Retorna o número da coluna de dados de origem que este grupo resume.
`getSourceDataSourceColumn()`	`DataSourceColumn`	Retorna a coluna da fonte de dados em que o grupo dinâmico opera.
`hideRepeatedLabels()`	`PivotGroup`	Oculta rótulos repetidos para este agrupamento.
`isSortAscending()`	`Boolean`	Retorna `true` se a classificação for crescente, retorna `false` se a ordem de classificação for decrescente.
`moveToIndex(index)`	`PivotGroup`	Move este grupo para a posição especificada na lista atual de grupos de linhas ou colunas.
`remove()`	`void`	Remove este grupo dinâmico da tabela.
`removeManualGroupingRule(groupName)`	`PivotGroup`	Remove a regra de agrupamento manual com o `groupName` especificado.
`resetDisplayName()`	`PivotGroup`	Redefine o nome de exibição do grupo na tabela dinâmica com o valor padrão.
`setDateTimeGroupingRule(dateTimeGroupingRuleType)`	`PivotGroup`	Define a regra de agrupamento de data e hora no grupo dinâmico.
`setDisplayName(name)`	`PivotGroup`	Define o nome de exibição deste grupo na tabela dinâmica.
`setGroupLimit(countLimit)`	`PivotGroup`	Define o limite do grupo dinâmico no grupo dinâmico.
`setHistogramGroupingRule(minValue, maxValue, intervalSize)`	`PivotGroup`	Define uma regra de agrupamento de histograma para este grupo dinâmico.
`showRepeatedLabels()`	`PivotGroup`	Quando há mais de um agrupamento de linhas ou colunas, este método exibe o rótulo desse agrupamento para cada entrada do agrupamento subsequente.
`showTotals(showTotals)`	`PivotGroup`	Define se os valores totais para este grupo dinâmico serão mostrados na tabela.
`sortAscending()`	`PivotGroup`	Define a ordem de classificação como crescente.
`sortBy(value, oppositeGroupValues)`	`PivotGroup`	Classifica esse grupo pelo `PivotValue` especificado para os valores de `oppositeGroupValues`.
`sortDescending()`	`PivotGroup`	Define a ordem de classificação como decrescente.
`totalsAreShown()`	`Boolean`	Retorna se os valores totais estão sendo mostrados para este grupo dinâmico.

Documentação detalhada

`addManualGroupingRule(groupName, groupMembers)`

Adiciona uma regra de agrupamento manual para este grupo dinâmico.

Parâmetros

Nome	Tipo	Descrição
`groupName`	`String`	O nome desta regra de agrupamento.
`groupMembers`	`Object[]`	Os valores incluídos nessa regra de agrupamento.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`areLabelsRepeated()`

Retorna se os rótulos são exibidos como repetidos.

Retornar

Boolean — true se os rótulos forem repetidos. caso contrário, retorna false.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`clearGroupingRule()`

Remove todas as regras de agrupamento deste grupo dinâmico.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`clearSort()`

Remove qualquer classificação aplicada ao grupo.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getDateTimeGroupingRule()`

Retorna a regra de agrupamento de data/hora no grupo dinâmico ou null se não houver data-hora é definida.

Retornar

DateTimeGroupingRule: a regra de agrupamento de data e hora.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getDimension()`

Retorna indicando se é um grupo de linhas ou de colunas.

Retornar

Dimension: a dimensão que representa o tipo desse grupo

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getGroupLimit()`

Retorna o limite do grupo dinâmico no grupo dinâmico. Retorna null se não houver limite de grupos dinâmicos está definido.

Retornar

PivotGroupLimit: o limite do grupo dinâmico.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getIndex()`

Retorna o índice deste grupo dinâmico na ordem do grupo atual.

Retornar

Integer: o índice do grupo dinâmico

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getPivotTable()`

Retorna o PivotTable ao qual esse agrupamento pertence.

Retornar

PivotTable: a tabela dinâmica a que este grupo pertence.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getSourceDataColumn()`

Retorna o número da coluna de dados de origem que este grupo resume. Esse índice tem base 1, se este grupo resume os dados de origem na coluna "A" da planilha, esse método retorna 1.

Retornar

Integer: o número da coluna de dados de origem

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`getSourceDataSourceColumn()`

Retorna a coluna da fonte de dados em que o grupo dinâmico opera. Retorna null se a tabela dinâmica tabela não é uma {DataSourcePivotTableApi}.

Retornar

DataSourceColumn: a coluna da fonte de dados em que o grupo dinâmico opera.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`hideRepeatedLabels()`

Oculta rótulos repetidos para este agrupamento. Se os rótulos já estiverem ocultos, isso resultará em um ambiente autônomo. Se esse método for chamado antes que haja vários agrupamentos de linhas ou colunas, quando uma agrupamento adicionado, rótulos repetidos ficam ocultos.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`isSortAscending()`

Retorna true se a classificação for crescente, retorna false se a ordem de classificação for decrescente.

Retornar

Boolean: true se a ordem de classificação for crescente.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`moveToIndex(index)`

Move este grupo para a posição especificada na lista atual de grupos de linhas ou colunas. Esses índices são baseados em 0. Por exemplo, se este grupo deve ser movido para a primeira posição, método deve ser chamado com 0.

Parâmetros

Nome	Tipo	Descrição
`index`	`Integer`	O índice para mover este agrupamento.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`remove()`

Remove este grupo dinâmico da tabela.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`removeManualGroupingRule(groupName)`

Remove a regra de agrupamento manual com o groupName especificado.

Parâmetros

Nome	Tipo	Descrição
`groupName`	`String`	O nome da regra de agrupamento a ser removida.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`resetDisplayName()`

Redefine o nome de exibição do grupo na tabela dinâmica com o valor padrão.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`setDateTimeGroupingRule(dateTimeGroupingRuleType)`

Define a regra de agrupamento de data e hora no grupo dinâmico.

Para remover a regra, use clearGroupingRule().

Parâmetros

Nome	Tipo	Descrição
`dateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	O tipo de regra a ser definida.

Retornar

PivotGroup: o grupo dinâmico para encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`setDisplayName(name)`

Define o nome de exibição deste grupo na tabela dinâmica.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome de exibição a ser definido.

Retornar

PivotGroup: o grupo dinâmico para encadeamento

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`setGroupLimit(countLimit)`

Define o limite do grupo dinâmico no grupo dinâmico. A operação só tem suporte para DataSourcePivotTable.

Parâmetros

Nome	Tipo	Descrição
`countLimit`	`Integer`	O limite de contagem de linhas ou colunas a serem definidas. Precisa ser positivo.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`setHistogramGroupingRule(minValue, maxValue, intervalSize)`

Define uma regra de agrupamento de histograma para este grupo dinâmico. Uma regra de histograma organiza valores em uma coluna de dados de origem em buckets de tamanho constante. Todos os valores de minValue a maxValue são colocados em grupos de tamanho interval. Todos os valores abaixo de minValue são colocados em um só bucket, assim como todos os valores maiores que maxValue.

Parâmetros

Nome	Tipo	Descrição
`minValue`	`Integer`	O valor mínimo para itens a serem colocados em buckets. Valores menores que isso são combinados em um só bucket.
`maxValue`	`Integer`	O valor máximo para itens a serem colocados em buckets. Valores maiores que esse são combinados em um só bucket.
`intervalSize`	`Integer`

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`showRepeatedLabels()`

Quando há mais de um agrupamento de linhas ou colunas, este método exibe o rótulo desse agrupamento para cada entrada do agrupamento subsequente. Se os rótulos já estiverem repetidos, o resultado será uma ambiente autônomo. Se esse método for chamado antes que haja vários agrupamentos de linhas ou colunas, quando uma e o agrupamento adicional é adicionado.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`showTotals(showTotals)`

Define se os valores totais para este grupo dinâmico serão mostrados na tabela.

Parâmetros

Nome	Tipo	Descrição
`showTotals`	`Boolean`	Mostrar ou não os totais.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`sortAscending()`

Define a ordem de classificação como crescente.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`sortBy(value, oppositeGroupValues)`

Classifica esse grupo pelo PivotValue especificado para os valores de 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']);

Parâmetros

Nome	Tipo	Descrição
`value`	`PivotValue`	O valor dinâmico para classificação.
`oppositeGroupValues`	`Object[]`	Os valores de um grupo dinâmico oposto (um grupo de colunas, se classificar um grupo de linhas ou um grupo de linhas se estiver classificando um grupo de colunas) que são usados para classificar. A ordem de esses valores determinam a precedência para quebra de empate.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`sortDescending()`

Define a ordem de classificação como decrescente.

Retornar

PivotGroup: o grupo dinâmico do encadeamento.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

`totalsAreShown()`

Retorna se os valores totais estão sendo mostrados para este grupo dinâmico.

Retornar

Boolean: true se os valores totais forem exibidos para este grupo dinâmico. caso contrário, retorna false

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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