Cette page a été traduite par l'API Cloud Translation.

Class PivotGroup

Accéder aux groupes de répartition des tableaux croisés dynamiques et les modifier.

Méthodes

Méthode	Type renvoyé	Brève description
`addManualGroupingRule(groupName, groupMembers)`	`PivotGroup`	Ajoute une règle de regroupement manuel pour ce groupe de tableaux croisés dynamiques.
`areLabelsRepeated()`	`Boolean`	Indique si les libellés sont affichés de manière répétée.
`clearGroupingRule()`	`PivotGroup`	Supprime toutes les règles de regroupement de ce groupe de tableaux croisés dynamiques.
`clearSort()`	`PivotGroup`	Supprime tout tri appliqué à ce groupe.
`getDateTimeGroupingRule()`	`DateTimeGroupingRule`	Renvoie la règle de regroupement par date/heure du groupe croisé dynamique, ou `null` si aucune règle de regroupement par date/heure n'est définie.
`getDimension()`	`Dimension`	Indique s'il s'agit d'un groupe de lignes ou de colonnes.
`getGroupLimit()`	`PivotGroupLimit`	Renvoie la limite de regroupement d'éléments du tableau croisé dynamique.
`getIndex()`	`Integer`	Renvoie l'index de ce groupe de pivot dans l'ordre de groupe actuel.
`getPivotTable()`	`PivotTable`	Renvoie l'`PivotTable` auquel appartient ce regroupement.
`getSourceDataColumn()`	`Integer`	Renvoie le numéro de la colonne de données source que ce groupe résume.
`getSourceDataSourceColumn()`	`DataSourceColumn`	Renvoie la colonne de la source de données sur laquelle le groupe croisé dynamique s'applique.
`hideRepeatedLabels()`	`PivotGroup`	Masque les libellés répétés pour ce regroupement.
`isSortAscending()`	`Boolean`	Renvoie `true` si le tri est croissant, et `false` si le tri est décroissant.
`moveToIndex(index)`	`PivotGroup`	Déplace ce groupe à la position spécifiée dans la liste actuelle des groupes de lignes ou de colonnes.
`remove()`	`void`	Supprime ce groupe de pivot du tableau.
`removeManualGroupingRule(groupName)`	`PivotGroup`	Supprime la règle de regroupement manuel avec la `groupName` spécifiée.
`resetDisplayName()`	`PivotGroup`	Réinitialise le nom à afficher de ce groupe dans le tableau croisé dynamique à sa valeur par défaut.
`setDateTimeGroupingRule(dateTimeGroupingRuleType)`	`PivotGroup`	Définit la règle de regroupement par date/heure sur le groupe croisé dynamique.
`setDisplayName(name)`	`PivotGroup`	Définit le nom à afficher pour ce groupe dans le tableau croisé dynamique.
`setGroupLimit(countLimit)`	`PivotGroup`	Définit la limite de regroupement d'éléments de tableaux croisés dynamiques sur le groupe de tableaux croisés dynamiques.
`setHistogramGroupingRule(minValue, maxValue, intervalSize)`	`PivotGroup`	Définit une règle de regroupement d'histogrammes pour ce groupe croisé dynamique.
`showRepeatedLabels()`	`PivotGroup`	Lorsqu'il existe plusieurs regroupements de lignes ou de colonnes, cette méthode affiche le libellé de ce regroupement pour chaque entrée du regroupement suivant.
`showTotals(showTotals)`	`PivotGroup`	Indique si les valeurs totales de ce groupe de tableaux croisés dynamiques doivent être affichées dans le tableau.
`sortAscending()`	`PivotGroup`	Définit l'ordre de tri sur croissant.
`sortBy(value, oppositeGroupValues)`	`PivotGroup`	Trie ce groupe par `PivotValue` spécifié pour les valeurs de `oppositeGroupValues`.
`sortDescending()`	`PivotGroup`	Définit l'ordre de tri sur décroissant.
`totalsAreShown()`	`Boolean`	Indique 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 groupe de tableaux croisés dynamiques.

Paramètres

Nom	Type	Description
`groupName`	`String`	Nom de cette règle de regroupement.
`groupMembers`	`Object[]`	Valeurs incluses dans cette règle de regroupement.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 de manière répétée.

Renvois

Boolean : true si les libellés sont répétés, sinon false.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 groupe de tableaux croisés dynamiques.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 par date/heure du groupe croisé dynamique, ou null si aucune règle de regroupement par date/heure n'est définie.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 avec un ou plusieurs des champs d'application suivants:

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

`getGroupLimit()`

Renvoie la limite de regroupement d'éléments du tableau croisé dynamique. Renvoie null si aucune limite de regroupement d'éléments de tableaux croisés dynamiques n'est définie.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 pivot dans l'ordre de groupe actuel.

Renvois

Integer : index du groupe de tableaux croisés dynamiques

Autorisation

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

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

`getPivotTable()`

Renvoie l'PivotTable auquel appartient ce regroupement.

Renvois

PivotTable : tableau croisé dynamique auquel appartient ce groupe.

Autorisation

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

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

`getSourceDataColumn()`

Renvoie le numéro de la colonne de données source que ce groupe résume. Cet indice est basé sur 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 de données source

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 croisé dynamique s'applique. Renvoie null si le tableau croisé dynamique n'est pas un {DataSourcePivotTableApi}.

Renvois

DataSourceColumn : colonne de la source de données sur laquelle le groupe croisé dynamique s'applique.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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, aucune action n'est effectuée. Si cette méthode est appelée avant qu'il n'y ait plusieurs regroupements de lignes ou de colonnes, les libellés répétés sont masqués lorsqu'un regroupement supplémentaire est ajouté.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 le tri est décroissant.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 des groupes de lignes ou de colonnes. Ces indices sont basés sur 0. Par exemple, si ce groupe doit être déplacé à la première position, cette méthode doit être appelée avec 0.

Paramètres

Nom	Type	Description
`index`	`Integer`	Index vers lequel déplacer ce regroupement.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 pivot du tableau.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 la groupName spécifiée.

Paramètres

Nom	Type	Description
`groupName`	`String`	Nom de la règle de regroupement à supprimer.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 à sa valeur par défaut.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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/heure sur le groupe croisé dynamique.

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

Paramètres

Nom	Type	Description
`dateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	Type de règle à définir.

Renvois

PivotGroup : groupe pivot, pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 pour ce groupe dans le tableau croisé dynamique.

Paramètres

Nom	Type	Description
`name`	`String`	Nom à afficher à définir.

Renvois

PivotGroup : groupe pivot pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 sur le groupe de tableaux croisés dynamiques. Cette opération n'est possible que pour DataSourcePivotTable.

Paramètres

Nom	Type	Description
`countLimit`	`Integer`	Limite de nombre de lignes ou de colonnes à définir. Doit être positive.

Renvois

PivotGroup : groupe de pivot pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 croisé dynamique. Une règle d'histogramme organise les valeurs d'une colonne de données source dans des buckets de taille constante. Toutes les valeurs de minValue à maxValue sont placées dans des groupes de taille interval. Toutes les valeurs inférieures à minValue sont placées dans un même bucket, tout comme toutes les valeurs supérieures à maxValue.

Paramètres

Nom	Type	Description
`minValue`	`Integer`	Valeur minimale pour les éléments à placer dans des buckets. Les valeurs inférieures à cette valeur sont combinées dans un même bucket.
`maxValue`	`Integer`	Valeur maximale pour les éléments à placer dans des buckets. Les valeurs supérieures à cette valeur sont combinées dans un même bucket.
`intervalSize`	`Integer`

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 regroupements de lignes ou de colonnes, cette méthode affiche le libellé de ce regroupement pour chaque entrée du regroupement suivant. Si les libellés sont déjà répétés, aucune opération n'est effectuée. Si cette méthode est appelée avant qu'il n'y ait plusieurs regroupements de lignes ou de colonnes, des libellés répétés s'affichent lorsqu'un regroupement supplémentaire est ajouté.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

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

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

`showTotals(showTotals)`

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

Paramètres

Nom	Type	Description
`showTotals`	`Boolean`	Indique si les totaux doivent être affichés ou non.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 sur croissant.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 par PivotValue spécifié pour les valeurs 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']);

Paramètres

Nom	Type	Description
`value`	`PivotValue`	Valeur dynamique à utiliser pour le tri.
`oppositeGroupValues`	`Object[]`	Valeurs d'un groupe croisé dynamique opposé (un groupe de colonnes si vous triez un groupe de lignes, ou un groupe de lignes si vous triez un groupe de colonnes) utilisées pour le tri. L'ordre de ces valeurs détermine la priorité en cas d'égalité.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 sur décroissant.

Renvois

PivotGroup : groupe pivot pour la chaîne.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 des valeurs totales sont affichées pour ce groupe de pivot, sinon renvoie false.

Autorisation

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

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