Esta página foi traduzida pela API Cloud Translation.

Class PivotGroup

Acessar e modificar grupos de detalhamento da tabela dinâmica.

Métodos

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

Documentação detalhada

`addManualGroupingRule(groupName, groupMembers)`

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

Parâmetros

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

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 mostrados 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 exigem 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 de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 a esse grupo.

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 e hora no grupo de abas ou null se nenhuma regra de agrupamento de data e hora estiver definida.

Retornar

DateTimeGroupingRule: a regra de agrupamento de data e hora.

Autorização

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

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

`getDimension()`

Retorna se este é um grupo de linhas ou colunas.

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 nenhum limite de grupo dinâmico estiver definido.

Retornar

PivotGroupLimit: o limite do grupo dinâmico.

Autorização

Os scripts que usam esse método exigem 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 desse grupo de pivot na ordem atual.

Retornar

Integer: o índice do grupo dinâmico

Autorização

Os scripts que usam esse método exigem 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 o grupo pertence.

Autorização

Os scripts que usam esse método exigem 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 resumida por esse grupo. Esse índice é baseado em 1. Se esse 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 exigem 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 de abas opera. Retorna null se a tabela dinâmica não for uma {DataSourcePivotTableApi}.

Retornar

DataSourceColumn: a coluna da fonte de dados em que o grupo de abas opera.

Autorização

Os scripts que usam esse método exigem 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 esse agrupamento. Se os rótulos já estiverem ocultos, isso resultará em uma operação nula. Se esse método for chamado antes de haver vários agrupamentos de linhas ou colunas, quando um agrupamento adicional for adicionado, os rótulos repetidos serão ocultos.

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 e 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 exigem 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 esse 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 esse grupo precisar ser movido para a primeira posição, esse método precisará ser chamado com 0.

Parâmetros

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

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

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

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

`remove()`

Remove esse grupo de pivots da tabela.

Autorização

Os scripts que usam esse método exigem 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 removido.

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 desse grupo na tabela dinâmica para o valor padrão.

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 definido.

Retornar

PivotGroup: o grupo de pivô, para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 desse 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 de pivot para encadeamento

Autorização

Os scripts que usam esse método exigem 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ó é compatível com DataSourcePivotTable.

Parâmetros

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

Retornar

PivotGroup: o grupo de pivot para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 esse grupo de pivot. Uma regra de histograma organiza os 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 bucket, assim como todos os valores maiores que maxValue.

Parâmetros

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

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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, esse método mostra o rótulo desse agrupamento para cada entrada do agrupamento subsequente. Se os rótulos já forem repetidos, isso resultará em uma operação nula. Se esse método for chamado antes de haver vários agrupamentos de linhas ou colunas, quando um agrupamento adicional for adicionado, rótulos repetidos serão mostrados.

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 desse grupo dinâmico vão ser mostrados na tabela.

Parâmetros

Nome	Tipo	Descrição
`showTotals`	`Boolean`	Indica se os totais serão mostrados ou não.

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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)`

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

Parâmetros

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

Retornar

PivotGroup: o grupo de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 de pivô para encadeamento.

Autorização

Os scripts que usam esse método exigem 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 esse grupo de pivot.

Retornar

Boolean: true se os valores totais forem exibidos para esse grupo de pivots. Caso contrário, retorna false.

Autorização

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

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