Class PivotGroup

PivotGroup

Acceder a los grupos de desglose de la tabla dinámica y modificarlos

Métodos

MétodoTipo de datos que se muestraDescripción breve
addManualGroupingRule(groupName, groupMembers)PivotGroupAgrega una regla de agrupamiento 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()DateTimeGroupingRule|nullDevuelve la regla de agrupación de fecha y hora en el grupo de segmentación o null si no se configuró ninguna regla de agrupación de fecha y hora.
getDimension()DimensionDevuelve un valor que indica si se trata de un grupo de filas o columnas.
getGroupLimit()PivotGroupLimit|nullDevuelve el límite del grupo de elementos de tabla dinámica en el grupo de elementos de tabla dinámica.
getIndex()IntegerDevuelve el índice de este grupo de segmentación en el orden actual del grupo.
getPivotTable()PivotTableDevuelve el PivotTable al que pertenece esta agrupación.
getSourceDataColumn()IntegerDevuelve el número de la columna de datos fuente que resume este grupo.
getSourceDataSourceColumn()DataSourceColumn|nullDevuelve la columna de la fuente de datos en la que opera el grupo de la tabla dinámica.
hideRepeatedLabels()PivotGroupOculta las etiquetas repetidas para este agrupamiento.
isSortAscending()BooleanDevuelve true si la clasificación es ascendente y false si 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 segmentación 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 deben mostrar los valores totales de este grupo de tabla dinámica en la tabla.
sortAscending()PivotGroupEstablece el orden de clasificación como ascendente.
sortBy(value, oppositeGroupValues)PivotGroupOrdena este grupo según el PivotValue especificado para los valores del oppositeGroupValues.
sortDescending()PivotGroupEstablece el orden de clasificación como descendente.
totalsAreShown()BooleanDevuelve un valor que indica si actualmente se muestran los valores totales de este grupo de tabla dinámica.

Documentación detallada

addManualGroupingRule(groupName, groupMembers)

Agrega una regla de agrupamiento 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 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 alcances:

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

areLabelsRepeated()

Devuelve si las etiquetas se muestran como repetidas.

Volver

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

Autorización

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

  • 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 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 alcances:

  • 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 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 alcances:

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

getDateTimeGroupingRule()

Devuelve la regla de agrupación de fecha y hora en el grupo de segmentación o null si no se configuró ninguna regla de agrupación de fecha y hora.

Volver

DateTimeGroupingRule|null: 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 alcances:

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

getDimension()

Devuelve un valor que indica 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 alcances:

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

getGroupLimit()

Devuelve el límite del grupo de elementos de tabla dinámica en el grupo de elementos de tabla dinámica. Devuelve null si no se establece ningún límite de grupo de elementos de tabla dinámica.

Volver

PivotGroupLimit|null: 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 alcances:

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

getIndex()

Devuelve el índice de este grupo de segmentación en el orden actual del grupo.

Volver

Integer: Í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 alcances:

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

getPivotTable()

Devuelve 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 alcances:

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

getSourceDataColumn()

Devuelve el número de la columna de datos fuente 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 devuelve 1.

Volver

Integer: Es el número de columna de los 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 alcances:

  • 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 la tabla dinámica. Devuelve null si la tabla dinámica no es un objeto {DataSourcePivotTableApi}.

Volver

DataSourceColumn|null: Es la columna de la fuente de datos en la que opera el grupo de dinamización.

Autorización

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

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

hideRepeatedLabels()

Oculta las etiquetas repetidas para este agrupamiento. Si las etiquetas ya están ocultas, el resultado es una operación sin efecto. Si se llama a este método antes de que haya varios agrupamientos de filas o columnas, cuando se agrega un agrupamiento adicional, se ocultan las etiquetas repetidas.

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 alcances:

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

isSortAscending()

Devuelve true si la clasificación es ascendente y false si 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 alcances:

  • 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
indexIntegerÍndice al que se moverá esta agrupación.

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 alcances:

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

remove()

Quita este grupo de segmentación 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 alcances:

  • 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 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 alcances:

  • 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 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 alcances:

  • 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 configurará.

Volver

PivotGroup: Es el grupo de pivote, para encadenar.

Autorización

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

  • 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 configurará.

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 alcances:

  • 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 segmentación 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 alcances:

  • 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 fuente en discretizaciones de 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 que los elementos se coloquen en discretizaciones. Los valores inferiores a este se combinan en un solo bucket.
maxValueIntegerEs el valor máximo para los elementos que se colocarán en buckets. Los valores mayores que este se combinan en un solo intervalo.
intervalSizeInteger

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 alcances:

  • 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, el resultado es una operación nula. Si se llama a este método antes de que haya varios agrupamientos de filas o columnas, cuando se agrega un agrupamiento adicional, se muestran las etiquetas repetidas.

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 alcances:

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

showTotals(showTotals)

Establece si se deben mostrar los valores totales de este grupo de tabla dinámica en la tabla.

Parámetros

NombreTipoDescripción
showTotalsBooleanIndica si se deben mostrar los totales.

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 alcances:

  • 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 alcances:

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

sortBy(value, oppositeGroupValues)

Ordena este grupo según el PivotValue especificado para los valores del 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 tabla dinámica según el cual se ordenará.
oppositeGroupValuesObject[]Son los valores de un grupo de segmentación 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 prioridad para resolver los empates.

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 alcances:

  • 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 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 alcances:

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

totalsAreShown()

Devuelve un valor que indica si actualmente se muestran los valores totales de este grupo de tabla dinámica.

Volver

Boolean: true si se muestran los valores totales para este grupo de tabla dinámica; de lo contrario, devuelve false.

Autorización

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

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