Class PivotGroup

Grupo de pivot

Accede a los grupos de desglose de la tabla dinámica y modifícalos.

Métodos

MétodoTipo de datos que se muestraDescripción breve
addManualGroupingRule(groupName, groupMembers)PivotGroupAgrega una regla de agrupación manual para este grupo de elementos de tabla dinámica.
areLabelsRepeated()BooleanDevuelve si las etiquetas se muestran como repetidas.
clearGroupingRule()PivotGroupQuita todas las reglas de agrupación de este grupo de elementos de tabla dinámica.
clearSort()PivotGroupQuita cualquier orden aplicado a este grupo.
getDateTimeGroupingRule()DateTimeGroupingRuleMuestra la regla de agrupación de fecha y hora en el grupo de datos dinámicos, o null si no se configuró ninguna regla de agrupación de fecha y hora.
getDimension()DimensionMuestra si se trata de un grupo de filas o columnas.
getGroupLimit()PivotGroupLimitMuestra el límite del grupo de elementos de tabla dinámica.
getIndex()IntegerMuestra el índice de este grupo de ejes en el orden de grupos actual.
getPivotTable()PivotTableMuestra el PivotTable al que pertenece esta agrupación.
getSourceDataColumn()IntegerDevuelve el número de la columna de datos de origen que resume este grupo.
getSourceDataSourceColumn()DataSourceColumnDevuelve la columna de la fuente de datos en la que opera el grupo de ejes.
hideRepeatedLabels()PivotGroupOculta las etiquetas repetidas para esta agrupación.
isSortAscending()BooleanMuestra true si la clasificación es ascendente y false si el orden de clasificación es descendente.
moveToIndex(index)PivotGroupMueve este grupo a la posición especificada en la lista actual de grupos de filas o columnas.
remove()voidQuita este grupo de ejes de la tabla.
removeManualGroupingRule(groupName)PivotGroupQuita la regla de agrupación manual con el groupName especificado.
resetDisplayName()PivotGroupRestablece el nombre visible de este grupo en la tabla dinámica a su valor predeterminado.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupEstablece la regla de agrupación de fecha y hora en el grupo de elementos de tabla dinámica.
setDisplayName(name)PivotGroupEstablece el nombre visible de este grupo en la tabla dinámica.
setGroupLimit(countLimit)PivotGroupEstablece el límite del grupo de elementos de tabla dinámica en el grupo de elementos de tabla dinámica.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupEstablece una regla de agrupación de histogramas para este grupo de elementos de tabla dinámica.
showRepeatedLabels()PivotGroupCuando hay más de una agrupación de filas o columnas, este método muestra la etiqueta de esta agrupación para cada entrada de la agrupación posterior.
showTotals(showTotals)PivotGroupEstablece si se mostrarán los valores totales de este grupo de tablas dinámicas en la tabla.
sortAscending()PivotGroupEstablece el orden de clasificación como ascendente.
sortBy(value, oppositeGroupValues)PivotGroupOrdena este grupo por el PivotValue especificado para los valores de oppositeGroupValues.
sortDescending()PivotGroupEstablece el orden de clasificación como descendente.
totalsAreShown()BooleanMuestra si los valores totales se muestran actualmente para este grupo de ejes.

Documentación detallada

addManualGroupingRule(groupName, groupMembers)

Agrega una regla de agrupación manual para este grupo de elementos de tabla dinámica.

Parámetros

NombreTipoDescripción
groupNameStringEs el nombre de esta regla de agrupación.
groupMembersObject[]Son los valores que se incluyen en esta regla de agrupación.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

areLabelsRepeated()

Devuelve si las etiquetas se muestran como repetidas.

Volver

Boolean: Muestra true si se repiten las etiquetas; de lo contrario, muestra false.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

clearGroupingRule()

Quita todas las reglas de agrupación de este grupo de elementos de tabla dinámica.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

clearSort()

Quita cualquier orden aplicado a este grupo.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getDateTimeGroupingRule()

Muestra la regla de agrupación de fecha y hora en el grupo de datos dinámicos, o null si no se configuró ninguna regla de agrupación de fecha y hora.

Volver

DateTimeGroupingRule: Es la regla de agrupación de fecha y hora.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getDimension()

Muestra si se trata de un grupo de filas o columnas.

Volver

Dimension: Es la dimensión que representa el tipo de este grupo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getGroupLimit()

Muestra el límite del grupo de elementos de tabla dinámica. Muestra null si no se establece un límite de grupo de elementos de tabla dinámica.

Volver

PivotGroupLimit: Es el límite del grupo de elementos de tabla dinámica.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getIndex()

Muestra el índice de este grupo de ejes en el orden de grupos actual.

Volver

Integer: Es el índice del grupo de tabla dinámica.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getPivotTable()

Muestra el PivotTable al que pertenece esta agrupación.

Volver

PivotTable: Es la tabla dinámica a la que pertenece este grupo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getSourceDataColumn()

Devuelve el número de la columna de datos de origen que resume este grupo. Este índice se basa en 1. Si este grupo resume los datos de origen en la columna "A" de la hoja de cálculo, este método muestra 1.

Volver

Integer: Es el número de la columna de datos de origen.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getSourceDataSourceColumn()

Devuelve la columna de la fuente de datos en la que opera el grupo de ejes. Muestra null si la tabla dinámica no es una {DataSourcePivotTableApi}.

Volver

DataSourceColumn: Es la columna de la fuente de datos en la que opera el grupo de ejes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

hideRepeatedLabels()

Oculta las etiquetas repetidas para esta agrupación. Si las etiquetas ya están ocultas, no se realizará ninguna acción. Si se llama a este método antes de que haya varias agrupaciones de filas o columnas, cuando se agregue una agrupación adicional, se ocultarán las etiquetas repetidas.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

isSortAscending()

Muestra true si la clasificación es ascendente y false si el orden de clasificación es descendente.

Volver

Boolean: true si el orden de clasificación es ascendente.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

moveToIndex(index)

Mueve este grupo a la posición especificada en la lista actual de grupos de filas o columnas. Estos índices se basan en 0. Por ejemplo, si este grupo se debe mover a la primera posición, se debe llamar a este método con 0.

Parámetros

NombreTipoDescripción
indexIntegerEl índice al que se moverá esta agrupación.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

remove()

Quita este grupo de ejes de la tabla.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

removeManualGroupingRule(groupName)

Quita la regla de agrupación manual con el groupName especificado.

Parámetros

NombreTipoDescripción
groupNameStringEs el nombre de la regla de agrupación que se quitará.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

resetDisplayName()

Restablece el nombre visible de este grupo en la tabla dinámica a su valor predeterminado.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setDateTimeGroupingRule(dateTimeGroupingRuleType)

Establece la regla de agrupación de fecha y hora en el grupo de elementos de tabla dinámica.

Para quitar la regla, usa clearGroupingRule().

Parámetros

NombreTipoDescripción
dateTimeGroupingRuleTypeDateTimeGroupingRuleTypeEs el tipo de regla que se establecerá.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setDisplayName(name)

Establece el nombre visible de este grupo en la tabla dinámica.

Parámetros

NombreTipoDescripción
nameStringEs el nombre visible que se establecerá.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setGroupLimit(countLimit)

Establece el límite del grupo de elementos de tabla dinámica en el grupo de elementos de tabla dinámica. La operación solo se admite para DataSourcePivotTable.

Parámetros

NombreTipoDescripción
countLimitIntegerEs el límite de recuento de filas o columnas que se establecerá. Debe ser positivo.

Volver

PivotGroup: Es el grupo de ejes para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setHistogramGroupingRule(minValue, maxValue, intervalSize)

Establece una regla de agrupación de histogramas para este grupo de elementos de tabla dinámica. Una regla de histograma organiza los valores de una columna de datos de origen en buckets de un tamaño constante. Todos los valores de minValue a maxValue se colocan en grupos de tamaño interval. Todos los valores por debajo de minValue se colocan en un bucket, al igual que todos los valores superiores a maxValue.

Parámetros

NombreTipoDescripción
minValueIntegerEs el valor mínimo para los elementos que se colocarán en los buckets. Los valores menores que este se combinan en un solo bucket.
maxValueIntegerEs el valor máximo de los elementos que se colocarán en los buckets. Los valores mayores que este se combinan en un solo bucket.
intervalSizeInteger

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

showRepeatedLabels()

Cuando hay más de una agrupación de filas o columnas, este método muestra la etiqueta de esta agrupación para cada entrada de la agrupación posterior. Si las etiquetas ya se repiten, no se realiza ninguna acción. Si se llama a este método antes de que haya varias agrupaciones de filas o columnas, cuando se agrega una agrupación adicional, se muestran etiquetas repetidas.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

showTotals(showTotals)

Establece si se mostrarán los valores totales de este grupo de tablas dinámicas en la tabla.

Parámetros

NombreTipoDescripción
showTotalsBooleanSi se mostrarán los totales o no.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

sortAscending()

Establece el orden de clasificación como ascendente.

Volver

PivotGroup: Es el grupo de pivote para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

sortBy(value, oppositeGroupValues)

Ordena este grupo por el PivotValue especificado para los 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

NombreTipoDescripción
valuePivotValueEs el valor de la tabla dinámica por el que se ordenará la tabla.
oppositeGroupValuesObject[]Los valores de un grupo de pivote opuesto (un grupo de columnas si se ordena un grupo de filas o un grupo de filas si se ordena un grupo de columnas) que se usan para ordenar. El orden de estos valores determina la precedencia para desempatar.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

sortDescending()

Establece el orden de clasificación como descendente.

Volver

PivotGroup: Es el grupo de ejes para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

totalsAreShown()

Muestra si los valores totales se muestran actualmente para este grupo de ejes.

Volver

Boolean: Es true si se muestran los valores totales para este grupo de ejes. De lo contrario, muestra false.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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