Esta página foi traduzida pela API Cloud Translation.

Class PivotGroup

Acessar e modificar grupos de detalhamento 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 a este grupo.
`getDateTimeGroupingRule()`	`DateTimeGroupingRule`	Retorna a regra de agrupamento de data e hora no grupo dinâmico ou `null` se nenhuma regra de agrupamento de data e hora estiver definida.
`getDimension()`	`Dimension`	Retorna se é um grupo de linhas ou colunas.
`getGroupLimit()`	`PivotGroupLimit`	Retorna o limite do grupo dinâmico.
`getIndex()`	`Integer`	Retorna o índice desse grupo dinâmico na ordem atual do grupo.
`getPivotTable()`	`PivotTable`	Retorna o `PivotTable` ao qual este 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 os rótulos repetidos para este agrupamento.
`isSortAscending()`	`Boolean`	Retornará `true` se a classificação estiver em ordem crescente. Retornará `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 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 deste 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 deste grupo na tabela dinâmica.
`setGroupLimit(countLimit)`	`PivotGroup`	Define o limite do 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, esse método exibe esse rótulo de agrupamento para cada entrada do agrupamento subsequente.
`showTotals(showTotals)`	`PivotGroup`	Define se os valores totais deste grupo dinâmico serão exibidos na tabela.
`sortAscending()`	`PivotGroup`	Define a ordem de classificação como crescente.
`sortBy(value, oppositeGroupValues)`	`PivotGroup`	Classifica este grupo pelo `PivotValue` especificado para os valores de `oppositeGroupValues`.
`sortDescending()`	`PivotGroup`	Define a ordem de classificação em ordem decrescente.
`totalsAreShown()`	`Boolean`	Retorna se os valores totais são 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 da regra de agrupamento.
`groupMembers`	`Object[]`	Os valores incluídos nesta regra de agrupamento.

Retornar

PivotGroup: o grupo dinâmico 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 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 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 dinâmico 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 este grupo.

Retornar

PivotGroup: o grupo dinâmico 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 dinâmico 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 é um grupo de linhas ou colunas.

Retornar

Dimension: a dimensão que representa este tipo de 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. Retornará null se nenhum limite de grupo dinâmico for 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 dinâmico na ordem atual do grupo.

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 este agrupamento pertence.

Retornar

PivotTable: a tabela dinâmica a que este 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 que este grupo resume. Esse índice é baseado em 1. Se esse grupo resumir os dados de origem na coluna "quot;A" da planilha, esse método retornará 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 dinâmico opera. Retornará null se a tabela dinâmica não for uma {DataSourcePivotTableApi}.

Retornar

DataSourceColumn: a coluna de fonte de dados em que o grupo dinâmico 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 os rótulos repetidos para este agrupamento. Se os rótulos já estiverem ocultos, isso resulta em um ambiente autônomo. Se esse método for chamado antes de ter vários agrupamentos de linhas ou colunas, quando um agrupamento adicional for adicionado, os rótulos repetidos ficarão ocultos.

Retornar

PivotGroup: o grupo dinâmico 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()`

Retornará true se a classificação estiver em ordem crescente. Retornará 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 zero. 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 onde o agrupamento será movido.

Retornar

PivotGroup: o grupo dinâmico 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 este grupo dinâmico 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 removida.

Retornar

PivotGroup: o grupo dinâmico 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 deste grupo na tabela dinâmica para o valor padrão.

Retornar

PivotGroup: o grupo dinâmico 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 definida.

Retornar

PivotGroup: o grupo dinâmico, para o 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 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 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. A operação é compatível apenas com DataSourcePivotTable.

Parâmetros

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

Retornar

PivotGroup: o grupo dinâmico 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 este grupo dinâmico. 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 do 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 inferiores a esse são combinados em um único bucket.
`maxValue`	`Integer`	Valor máximo para itens a serem colocados em buckets. Valores maiores que isso são combinados em um único bucket.
`intervalSize`	`Integer`

Retornar

PivotGroup: o grupo dinâmico 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 exibe esse rótulo de agrupamento para cada entrada do agrupamento subsequente. Se os rótulos já estiverem repetidos, isso resultará em um ambiente autônomo. Se esse método for chamado antes de ter vários agrupamentos de linhas ou colunas, quando um agrupamento adicional for adicionado, os rótulos repetidos serão exibidos.

Retornar

PivotGroup: o grupo dinâmico 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 deste grupo dinâmico serão exibidos na tabela.

Parâmetros

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

Retornar

PivotGroup: o grupo dinâmico 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 dinâmico 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)`

Classifica este 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 de tabela dinâmica 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 um grupo de colunas) for usado para classificar. A ordem desses valores determina a precedência para quebra de empate.

Retornar

PivotGroup: o grupo dinâmico 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 em ordem decrescente.

Retornar

PivotGroup: o grupo dinâmico 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 são mostrados para este grupo dinâmico.

Retornar

Boolean: true se os valores totais são exibidos para este grupo dinâmico. 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