Class PivotGroup

PivotGroup

Accédez aux groupes de discussion dans les tableaux croisés dynamiques et modifiez-les.

Méthodes

MéthodeType renvoyéBrève description
addManualGroupingRule(groupName, groupMembers)PivotGroupAjoute une règle de regroupement manuel pour ce regroupement de tableaux croisés dynamiques.
areLabelsRepeated()BooleanIndique si les libellés sont affichés comme répétés.
clearGroupingRule()PivotGroupSupprime toutes les règles de regroupement de ce tableau croisé dynamique.
clearSort()PivotGroupSupprime tout tri appliqué à ce groupe.
getDateTimeGroupingRule()DateTimeGroupingRuleRenvoie la règle de regroupement date/heure du groupe de tableaux croisés dynamiques, ou null si aucune date/heure n'est définie. est définie.
getDimension()DimensionIndique s'il s'agit d'un groupe de lignes ou de colonnes.
getGroupLimit()PivotGroupLimitAffiche la limite de regroupement d'éléments de tableaux croisés dynamiques.
getIndex()IntegerRenvoie l'index de ce groupe de tableaux croisés dynamiques dans l'ordre actuel du groupe.
getPivotTable()PivotTableRenvoie l'élément PivotTable auquel ce regroupement appartient.
getSourceDataColumn()IntegerRenvoie le nombre de la colonne de données source que ce groupe résume.
getSourceDataSourceColumn()DataSourceColumnRenvoie la colonne de la source de données sur laquelle le groupe de tableaux croisés dynamiques opère.
hideRepeatedLabels()PivotGroupMasque les libellés répétés pour ce regroupement.
isSortAscending()BooleanRenvoie true si le tri est croissant et false si l'ordre de tri est dans l'ordre décroissant.
moveToIndex(index)PivotGroupDéplace ce groupe à la position spécifiée dans la liste actuelle de groupes de lignes ou de colonnes.
remove()voidSupprime ce groupe de tableaux croisés dynamiques du tableau.
removeManualGroupingRule(groupName)PivotGroupSupprime la règle de regroupement manuel avec le groupName spécifié.
resetDisplayName()PivotGroupRéinitialise le nom à afficher de ce groupe dans le tableau croisé dynamique sur sa valeur par défaut.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupDéfinit la règle de regroupement par date et heure du regroupement de tableaux croisés dynamiques.
setDisplayName(name)PivotGroupDéfinit le nom à afficher de ce groupe dans le tableau croisé dynamique.
setGroupLimit(countLimit)PivotGroupDéfinit la limite de regroupement d'éléments de tableaux croisés dynamiques.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupDéfinit une règle de regroupement d'histogrammes pour ce groupe de tableaux croisés dynamiques.
showRepeatedLabels()PivotGroupLorsqu'il existe plusieurs groupes de lignes ou de colonnes, cette méthode affiche le libellé de ce regroupement. pour chaque entrée du regroupement suivant.
showTotals(showTotals)PivotGroupDétermine si les valeurs totales de ce groupe de tableaux croisés dynamiques doivent être affichées dans le tableau.
sortAscending()PivotGroupDéfinit l'ordre de tri croissant.
sortBy(value, oppositeGroupValues)PivotGroupTrie ce groupe en fonction du PivotValue spécifié pour les valeurs de oppositeGroupValues.
sortDescending()PivotGroupDéfinit l'ordre de tri décroissant.
totalsAreShown()BooleanIndique si les valeurs totales sont actuellement affichées pour ce groupe de tableaux croisés dynamiques.

Documentation détaillée

addManualGroupingRule(groupName, groupMembers)

Ajoute une règle de regroupement manuel pour ce regroupement de tableaux croisés dynamiques.

Paramètres

NomTypeDescription
groupNameStringNom de cette règle de regroupement.
groupMembersObject[]Valeurs incluses dans cette règle de regroupement.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

areLabelsRepeated()

Indique si les libellés sont affichés comme répétés.

Renvois

Boolean : true si les étiquettes sont répétées Sinon, renvoie false.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

clearGroupingRule()

Supprime toutes les règles de regroupement de ce tableau croisé dynamique.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

clearSort()

Supprime tout tri appliqué à ce groupe.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getDateTimeGroupingRule()

Renvoie la règle de regroupement date/heure du groupe de tableaux croisés dynamiques, ou null si aucune date/heure n'est définie. est définie.

Renvois

DateTimeGroupingRule : règle de regroupement par date/heure.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getDimension()

Indique s'il s'agit d'un groupe de lignes ou de colonnes.

Renvois

Dimension : dimension représentant le type de ce groupe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getGroupLimit()

Affiche la limite de regroupement d'éléments de tableaux croisés dynamiques. Renvoie null si la limite du regroupement de tableaux croisés dynamiques n'est pas limitée est définie.

Renvois

PivotGroupLimit : limite de regroupement d'éléments de tableaux croisés dynamiques.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getIndex()

Renvoie l'index de ce groupe de tableaux croisés dynamiques dans l'ordre actuel du groupe.

Renvois

Integer : index du groupe de tableaux croisés dynamiques

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getPivotTable()

Renvoie l'élément PivotTable auquel ce regroupement appartient.

Renvois

PivotTable : tableau croisé dynamique auquel appartient ce groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getSourceDataColumn()

Renvoie le nombre de la colonne de données source que ce groupe résume. Cet index est de base 1, si ce groupe résume les données sources dans la colonne "A" de la feuille de calcul, cette méthode renvoie 1.

Renvois

Integer : numéro de la colonne des données sources

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

getSourceDataSourceColumn()

Renvoie la colonne de la source de données sur laquelle le groupe de tableaux croisés dynamiques opère. Renvoie null si le tableau croisé dynamique La table n'est pas de type {DataSourcePivotTableApi}.

Renvois

DataSourceColumn : colonne de la source de données sur laquelle le groupe de tableaux croisés dynamiques agit.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

hideRepeatedLabels()

Masque les libellés répétés pour ce regroupement. Si les libellés sont déjà masqués, cela entraîne une no-op. Si cette méthode est appelée avant qu'il n'y ait plusieurs regroupements de lignes ou de colonnes, lorsqu'une regroupement est ajouté, les étiquettes répétées sont masquées.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

isSortAscending()

Renvoie true si le tri est croissant et false si l'ordre de tri est dans l'ordre décroissant.

Renvois

Boolean : true si l'ordre de tri est croissant.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

moveToIndex(index)

Déplace ce groupe à la position spécifiée dans la liste actuelle de groupes de lignes ou de colonnes. Ces les indices sont basés sur 0. Par exemple, si ce groupe doit être déplacé en première position, doit être appelée avec 0.

Paramètres

NomTypeDescription
indexIntegerIndex vers lequel déplacer ce regroupement

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

remove()

Supprime ce groupe de tableaux croisés dynamiques du tableau.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

removeManualGroupingRule(groupName)

Supprime la règle de regroupement manuel avec le groupName spécifié.

Paramètres

NomTypeDescription
groupNameStringNom de la règle de regroupement à supprimer.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

resetDisplayName()

Réinitialise le nom à afficher de ce groupe dans le tableau croisé dynamique sur sa valeur par défaut.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setDateTimeGroupingRule(dateTimeGroupingRuleType)

Définit la règle de regroupement par date et heure du regroupement de tableaux croisés dynamiques.

Pour supprimer la règle, utilisez clearGroupingRule().

Paramètres

NomTypeDescription
dateTimeGroupingRuleTypeDateTimeGroupingRuleTypeType de règle à définir.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setDisplayName(name)

Définit le nom à afficher de ce groupe dans le tableau croisé dynamique.

Paramètres

NomTypeDescription
nameStringNom à afficher à définir.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setGroupLimit(countLimit)

Définit la limite de regroupement d'éléments de tableaux croisés dynamiques. Cette opération n'est possible que pour DataSourcePivotTable.

Paramètres

NomTypeDescription
countLimitIntegerNombre maximal de lignes ou de colonnes à définir. Doit être positive.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

setHistogramGroupingRule(minValue, maxValue, intervalSize)

Définit une règle de regroupement d'histogrammes pour ce groupe de tableaux croisés dynamiques. Une règle d'histogramme organise les valeurs dans un colonne de données sources en buckets de taille constante. Toutes les valeurs comprises entre minValue et maxValue sont placées dans des groupes de taille interval. Toutes les valeurs inférieures à minValue sont placés dans un seul bucket, tout comme toutes les valeurs supérieures à maxValue.

Paramètres

NomTypeDescription
minValueIntegerValeur minimale des éléments à placer dans des buckets. Valeurs inférieures à celle-ci sont combinés en un seul bucket.
maxValueIntegerValeur maximale des éléments à placer dans des buckets. Valeurs supérieures à celle-ci sont combinés en un seul bucket.
intervalSizeInteger

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

showRepeatedLabels()

Lorsqu'il existe plusieurs groupes de lignes ou de colonnes, cette méthode affiche le libellé de ce regroupement. pour chaque entrée du regroupement suivant. Si les étiquettes sont déjà répétées, une no-op. Si cette méthode est appelée avant qu'il n'y ait plusieurs regroupements de lignes ou de colonnes, lorsqu'une un regroupement supplémentaire est ajouté, les étiquettes répétées sont affichées.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

showTotals(showTotals)

Détermine si les valeurs totales de ce groupe de tableaux croisés dynamiques doivent être affichées dans le tableau.

Paramètres

NomTypeDescription
showTotalsBooleanPermet d'afficher ou non les totaux.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

sortAscending()

Définit l'ordre de tri croissant.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

sortBy(value, oppositeGroupValues)

Trie ce groupe en fonction du PivotValue spécifié pour les valeurs 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']);

Paramètres

NomTypeDescription
valuePivotValueValeur de tableau croisé dynamique selon laquelle le tri doit être effectué.
oppositeGroupValuesObject[]Les valeurs d'un groupe de tableaux croisés dynamiques opposé (un groupe de colonnes si le tri d'un groupe de lignes ou un groupe de lignes si vous triez un groupe de colonnes) utilisés pour le tri. L'ordre des ces valeurs déterminent la priorité des règles de départage.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

sortDescending()

Définit l'ordre de tri décroissant.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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

totalsAreShown()

Indique si les valeurs totales sont actuellement affichées pour ce groupe de tableaux croisés dynamiques.

Renvois

Boolean : true si les valeurs totales sont affichées pour ce groupe de tableaux croisés dynamiques ; Sinon, renvoie false

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:

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