Class PivotGroup

PivotGroup

Acessar e modificar grupos de detalhamento de tabelas dinâmicas.

Métodos

MétodoTipo de retornoBreve descrição
addManualGroupingRule(groupName, groupMembers)PivotGroupAdiciona uma regra de agrupamento manual a esse grupo dinâmico.
areLabelsRepeated()BooleanRetorna se os rótulos são mostrados como repetidos.
clearGroupingRule()PivotGroupRemove todas as regras de agrupamento desse grupo dinâmico.
clearSort()PivotGroupRemove qualquer classificação aplicada a esse grupo.
getDateTimeGroupingRule()DateTimeGroupingRule|nullRetorna a regra de agrupamento de data e hora no grupo de pivô ou null se nenhuma regra de agrupamento de data e hora estiver definida.
getDimension()DimensionRetorna se este é um grupo de linhas ou colunas.
getGroupLimit()PivotGroupLimit|nullRetorna o limite do grupo dinâmico no grupo dinâmico.
getIndex()IntegerRetorna o índice deste grupo de pivô na ordem atual.
getPivotTable()PivotTableRetorna o PivotTable a que este agrupamento pertence.
getSourceDataColumn()IntegerRetorna o número da coluna de dados de origem que este grupo resume.
getSourceDataSourceColumn()DataSourceColumn|nullRetorna a coluna da fonte de dados em que o grupo de pivô opera.
hideRepeatedLabels()PivotGroupOculta os rótulos repetidos para esse agrupamento.
isSortAscending()BooleanRetorna true se a classificação for crescente e false se for decrescente.
moveToIndex(index)PivotGroupMove esse grupo para a posição especificada na lista atual de grupos de linhas ou colunas.
remove()voidRemove esse grupo de pivô da tabela.
removeManualGroupingRule(groupName)PivotGroupRemove a regra de agrupamento manual com o groupName especificado.
resetDisplayName()PivotGroupRedefine o nome de exibição deste grupo na tabela dinâmica para o valor padrão.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupDefine a regra de agrupamento de data e hora no grupo dinâmico.
setDisplayName(name)PivotGroupDefine o nome de exibição desse grupo na tabela dinâmica.
setGroupLimit(countLimit)PivotGroupDefine o limite do grupo dinâmico no grupo dinâmico.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupDefine uma regra de agrupamento de histograma para este grupo dinâmico.
showRepeatedLabels()PivotGroupQuando há mais de um agrupamento de linhas ou colunas, esse método mostra o marcador do agrupamento para cada entrada do agrupamento subsequente.
showTotals(showTotals)PivotGroupDefine se os valores totais desse grupo dinâmico serão mostrados na tabela.
sortAscending()PivotGroupDefine a ordem de classificação como crescente.
sortBy(value, oppositeGroupValues)PivotGroupClassifica esse grupo pelo PivotValue especificado para os valores de oppositeGroupValues.
sortDescending()PivotGroupDefine a ordem de classificação como decrescente.
totalsAreShown()BooleanRetorna se os valores totais estão sendo mostrados para este grupo de pivô.

Documentação detalhada

addManualGroupingRule(groupName, groupMembers)

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

Parâmetros

NomeTipoDescrição
groupNameStringO nome desta regra de agrupamento.
groupMembersObject[]Os valores incluídos nessa regra de agrupamento.

Retornar

PivotGroup: o grupo de rotação 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 desse grupo dinâmico.

Retornar

PivotGroup: o grupo de rotação 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 rotação 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 pivô ou null se nenhuma regra de agrupamento de data e hora estiver definida.

Retornar

DateTimeGroupingRule|null: 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|null: 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 deste grupo de pivô 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 a que 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 este grupo resumir dados de origem na coluna "A" da planilha, esse método vai 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 de pivô opera. Retorna null se a tabela dinâmica não for um {DataSourcePivotTableApi}.

Retornar

DataSourceColumn|null: a coluna da 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 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 rotação 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 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 será chamado com 0.

Parâmetros

NomeTipoDescrição
indexIntegerO índice para mover esse agrupamento.

Retornar

PivotGroup: o grupo de rotação 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 pivô 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

NomeTipoDescrição
groupNameStringO nome da regra de agrupamento a ser removida.

Retornar

PivotGroup: o grupo de rotação 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 de rotação 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

NomeTipoDescrição
dateTimeGroupingRuleTypeDateTimeGroupingRuleTypeO 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

NomeTipoDescrição
nameStringO nome de exibição 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

setGroupLimit(countLimit)

Define o limite do grupo dinâmico no grupo dinâmico. A operação só é compatível com DataSourcePivotTable.

Parâmetros

NomeTipoDescrição
countLimitIntegerO limite de contagem de linhas ou colunas a ser definido. Precisa ser positivo.

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

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 bucket, assim como todos os valores maiores que maxValue.

Parâmetros

NomeTipoDescrição
minValueIntegerO valor mínimo para que os itens sejam colocados em intervalos. Valores menores que esse são combinados em um único bucket.
maxValueIntegerO valor máximo para itens serem colocados em intervalos. Valores maiores que esse são combinados em um único bucket.
intervalSizeInteger

Retornar

PivotGroup: o grupo de rotação 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 marcador do agrupamento para cada entrada do agrupamento subsequente. Se os rótulos já estiverem 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, os rótulos repetidos serão mostrados.

Retornar

PivotGroup: o grupo de rotação 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 serão mostrados na tabela.

Parâmetros

NomeTipoDescrição
showTotalsBooleanSe os totais serão mostrados ou não.

Retornar

PivotGroup: o grupo de rotação 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 rotação 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 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.
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

NomeTipoDescrição
valuePivotValueO valor dinâmico para classificação.
oppositeGroupValuesObject[]Os valores de um grupo dinâmico oposto (um grupo de colunas se a classificação for de um grupo de linhas ou um grupo de linhas se a classificação for de 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 rotação 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 rotação 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 este grupo de pivô.

Retornar

Boolean: true se os valores totais forem mostrados para esse grupo de indicadores. 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