Class PivotGroup

PivotGroup

Accede a los grupos de sesiones separadas de tablas dinámicas 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()BooleanMuestra 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 que se haya aplicado a este grupo.
getDateTimeGroupingRule()DateTimeGroupingRuleMuestra la regla de agrupación de fecha y hora en el grupo de elementos dinámicos, o null si no se estableció ninguna regla de agrupación de fecha y hora.
getDimension()DimensionMuestra si es 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 elementos dinámicos en el orden de grupo actual.
getPivotTable()PivotTableMuestra el PivotTable al que pertenece esta agrupación.
getSourceDataColumn()IntegerMuestra el número de la columna de datos de origen que resume este grupo.
getSourceDataSourceColumn()DataSourceColumnMuestra la columna de la fuente de datos en la que opera el grupo de tabla dinámica.
hideRepeatedLabels()PivotGroupOculta las etiquetas repetidas para esta agrupación.
isSortAscending()BooleanMuestra true si el orden es ascendente y muestra false si el orden 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 elementos dinámicos 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)PivotGroupConfigura la regla de agrupación de fecha y hora en el grupo de elementos dinámicos.
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.
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 muestran los valores totales de este grupo de elementos dinámicos en la tabla.
sortAscending()PivotGroupEstablece que el orden de clasificación sea ascendente.
sortBy(value, oppositeGroupValues)PivotGroupOrdena este grupo según el PivotValue especificado para los valores de oppositeGroupValues.
sortDescending()PivotGroupEstablece el orden de clasificación descendente.
totalsAreShown()BooleanMuestra si los valores totales se muestran actualmente para este grupo de elementos de tabla dinámica.

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.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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()

Muestra si las etiquetas se muestran como repetidas.

Devolvedor

Boolean: Es true si las etiquetas se repiten; 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 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.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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 que se haya aplicado a este grupo.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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()

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

Devolvedor

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

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

getDimension()

Muestra si es un grupo de filas o columnas.

Devolvedor

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()

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 dinámicos.

Devolvedor

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

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

getIndex()

Muestra el índice de este grupo de elementos dinámicos en el orden de grupo actual.

Devolvedor

Integer: Es el índice 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

getPivotTable()

Muestra el PivotTable al que pertenece esta agrupación.

Devolvedor

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()

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

Devolvedor

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()

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

Devolvedor

DataSourceColumn: Es la columna de la fuente de datos en la que opera el 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

hideRepeatedLabels()

Oculta las etiquetas repetidas para esta agrupación. Si las etiquetas ya están ocultas, esto da como resultado una no-op. Si se llama a este método antes de que haya varias agrupaciones de filas o columnas, cuando se agrega una agrupación adicional, las etiquetas repetidas se ocultan.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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()

Muestra true si el orden es ascendente y muestra false si el orden es descendente.

Devolvedor

Boolean: Es 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 el 0. Por ejemplo, si este grupo debe moverse 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.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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 elementos dinámicos 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
groupNameStringEl nombre de la regla de agrupación que se quitará.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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)

Configura la regla de agrupación de fecha y hora en el grupo de elementos dinámicos.

Para quitar la regla, usa clearGroupingRule().

Parámetros

NombreTipoDescripción
dateTimeGroupingRuleTypeDateTimeGroupingRuleTypeEl tipo de regla que se establecerá.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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

setDisplayName(name)

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

Parámetros

NombreTipoDescripción
nameStringEl nombre visible que se establecerá.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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. La operación solo se admite para DataSourcePivotTable.

Parámetros

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

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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 en una columna de datos de origen en buckets de un tamaño constante. Todos los valores desde minValue hasta 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 mayores que maxValue.

Parámetros

NombreTipoDescripción
minValueIntegerEl valor mínimo para que los elementos se coloquen en buckets. Los valores menores que este se combinan en un solo bucket.
maxValueIntegerEl valor máximo para que los elementos se coloquen en buckets. Los valores superiores a este se combinan en un solo bucket.
intervalSizeInteger

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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 están repetidas, esto da como resultado una no-op. 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.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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 muestran los valores totales de este grupo de elementos dinámicos en la tabla.

Parámetros

NombreTipoDescripción
showTotalsBooleanIndica si se deben mostrar los totales o no.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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 que el orden de clasificación sea ascendente.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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 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

NombreTipoDescripción
valuePivotValueEs el valor de tabla dinámica que se usará para ordenar.
oppositeGroupValuesObject[]Los valores de un grupo de elementos dinámicos 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 el empate.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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 descendente.

Devolvedor

PivotGroup: Es el grupo de elementos dinámicos 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()

Muestra si los valores totales se muestran actualmente para este grupo de elementos de tabla dinámica.

Devolvedor

Boolean: Es true si se muestran los valores totales para este grupo de elementos de tabla dinámica; 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 alcances:

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