Acessar e modificar grupos temáticos de tabelas dinâmicas.
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addManualGroupingRule(groupName, groupMembers) | PivotGroup | Adiciona uma regra de agrupamento manual a este grupo dinâmico. |
areLabelsRepeated() | Boolean | Retorna se os rótulos são exibidos como repetidos. |
clearGroupingRule() | PivotGroup | Remove todas as regras de agrupamento desse grupo dinâmico. |
clearSort() | PivotGroup | Remove qualquer classificação aplicada a este grupo. |
getDateTimeGroupingRule() | DateTimeGroupingRule | Retorna a regra de agrupamento de data-hora no grupo dinâmico ou null se nenhuma regra de agrupamento
de data-hora estiver definida. |
getDimension() | Dimension | Retorna indicando se é um grupo de linhas ou colunas. |
getGroupLimit() | PivotGroupLimit | Retorna o limite do grupo dinâmico. |
getIndex() | Integer | Retorna o índice do grupo dinâmico na ordem do grupo atual. |
getPivotTable() | PivotTable | Retorna o PivotTable ao qual este agrupamento pertence. |
getSourceDataColumn() | Integer | Retorna o número da coluna de dados de origem resumido por este grupo. |
getSourceDataSourceColumn() | DataSourceColumn | Retorna a coluna de fonte de dados em que o grupo dinâmico opera. |
hideRepeatedLabels() | PivotGroup | Oculta os rótulos repetidos deste agrupamento. |
isSortAscending() | Boolean | Retorna true se a classificação for crescente e false se a ordem 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 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. |
setHistogramGroupingRule(minValue, maxValue, intervalSize) | PivotGroup | Define uma regra de agrupamento por histograma para este grupo dinâmico. |
showRepeatedLabels() | PivotGroup | Quando há mais de uma linha ou agrupamento de colunas, esse método exibe o rótulo desse agrupamento para cada entrada do agrupamento seguinte. |
showTotals(showTotals) | PivotGroup | Define se os valores totais desse grupo dinâmico devem ser exibidos na tabela. |
sortAscending() | PivotGroup | Define a ordem de classificação para ser crescente. |
sortBy(value, oppositeGroupValues) | PivotGroup | Classifica este grupo pelo PivotValue especificado para os valores de oppositeGroupValues . |
sortDescending() | PivotGroup | Define a ordem de classificação para ser decrescente. |
totalsAreShown() | Boolean | Retorna se os valores totais são mostrados atualmente para este grupo dinâmico. |
Documentação detalhada
addManualGroupingRule(groupName, groupMembers)
Adiciona uma regra de agrupamento manual a 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. |
Retorno
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.
Retorno
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.
Retorno
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.
Retorno
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-hora no grupo dinâmico ou null
se nenhuma regra de agrupamento
de data-hora estiver definida.
Retorno
DateTimeGroupingRule
: a regra de agrupamento de data-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 indicando se é um grupo de linhas ou colunas.
Retorno
Dimension
: 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. Retornará null
se nenhum limite de grupo dinâmico estiver definido.
Retorno
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 do grupo dinâmico na ordem do grupo atual.
Retorno
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.
Retorno
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 resumido por este grupo. Esse índice é baseado em 1. Se esse grupo resumir os dados de origem na coluna "A" da planilha, o método retornará 1
.
Retorno
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 de fonte de dados em que o grupo dinâmico opera. Retorna null
se a tabela
dinâmica não for uma {DataSourcePivotTableApi}.
Retorno
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 deste agrupamento. Se os rótulos já estiverem ocultos, isso resultará em um ambiente autônomo. Se esse método for chamado antes de haver vários agrupamentos de linhas ou colunas, quando mais um agrupamento for adicionado, os rótulos repetidos serão ocultados.
Retorno
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()
Retorna true
se a classificação for crescente e false
se a ordem for decrescente.
Retorno
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 este grupo para a posição especificada na lista atual de grupos de linhas ou colunas. Esses
índices têm como base 0. Por exemplo, se esse grupo precisa ser movido para a primeira posição, esse
método precisa ser chamado com 0
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
index | Integer | O índice para onde este agrupamento será movido. |
Retorno
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 que será removida. |
Retorno
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 desse grupo na tabela dinâmica para o valor padrão.
Retorno
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. |
Retorno
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
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. |
Retorno
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 só é compatível com DataSourcePivotTable
.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
countLimit | Integer | O limite de contagem de linhas ou colunas a serem definidas. Precisa ser positivo. |
Retorno
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 por 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
Nome | Tipo | Descrição |
---|---|---|
minValue | Integer | O valor mínimo para itens a serem colocados em buckets. Valores inferiores a esse são combinados em um único bucket. |
maxValue | Integer | O valor máximo para itens a serem colocados em buckets. Valores maiores que isso são combinados em um único bucket. |
intervalSize | Integer |
Retorno
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 uma linha ou agrupamento de colunas, esse método exibe o rótulo desse agrupamento para cada entrada do agrupamento seguinte. Se os rótulos já estiverem repetidos, isso resultará em um ambiente autônomo. 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.
Retorno
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 desse grupo dinâmico devem ser exibidos na tabela.
Parâmetros
Nome | Tipo | Descrição |
---|---|---|
showTotals | Boolean | Se os totais serão exibidos ou não. |
Retorno
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 para ser crescente.
Retorno
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 dinâmico a ser classificado. |
oppositeGroupValues | Object[] | Os valores de um grupo dinâmico oposto (um grupo de colunas se estiver classificando um grupo de linhas ou um grupo de linhas se estiver classificando um grupo de colunas) usados para a classificação. A ordem desses valores determina a precedência para a divisão de empates. |
Retorno
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 para ser decrescente.
Retorno
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 atualmente para este grupo dinâmico.
Retorno
Boolean
: true
se os valores totais forem exibidos para o 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