Class PivotGroup

CroiserGroupe

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

Méthodes

MéthodeType renvoyéBrève description
addManualGroupingRule(groupName, groupMembers)PivotGroupAjoute une règle de regroupement manuel pour ce groupe de tableaux croisés dynamiques.
areLabelsRepeated()BooleanIndique si les libellés sont affichés de manière répétée.
clearGroupingRule()PivotGroupSupprime toutes les règles de regroupement de ce groupe de tableaux croisés dynamiques.
clearSort()PivotGroupSupprime tout tri appliqué à ce groupe.
getDateTimeGroupingRule()DateTimeGroupingRule|nullRenvoie la règle de regroupement par date/heure sur le groupe de tableau croisé dynamique, ou null si aucune règle de regroupement par date/heure n'est définie.
getDimension()DimensionIndique s'il s'agit d'un groupe de lignes ou de colonnes.
getGroupLimit()PivotGroupLimit|nullRenvoie la limite de regroupement d'éléments de tableaux croisés dynamiques pour le groupe de tableaux croisés dynamiques.
getIndex()IntegerRenvoie l'index de ce groupe de tableaux croisés dynamiques dans l'ordre actuel des groupes.
getPivotTable()PivotTableRenvoie le PivotTable auquel appartient ce regroupement.
getSourceDataColumn()IntegerRenvoie le numéro de la colonne de données source que ce groupe résume.
getSourceDataSourceColumn()DataSourceColumn|nullRenvoie 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 s'il est décroissant.
moveToIndex(index)PivotGroupDéplace ce groupe à la position spécifiée dans la liste actuelle des 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 l'groupName spécifié.
resetDisplayName()PivotGroupRétablit la valeur par défaut du nom à afficher de ce groupe dans le tableau croisé dynamique.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupDéfinit la règle de regroupement par date/heure sur le groupe 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 croisé.
showRepeatedLabels()PivotGroupLorsqu'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)PivotGroupIndique s'il faut afficher les valeurs totales de ce groupe de tableaux croisés dynamiques dans le tableau.
sortAscending()PivotGroupDéfinit l'ordre de tri sur croissant.
sortBy(value, oppositeGroupValues)PivotGroupTrie ce groupe selon le PivotValue spécifié pour les valeurs de oppositeGroupValues.
sortDescending()PivotGroupDéfinit l'ordre de tri sur 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 groupe 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 pivot pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 scopes 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 l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getDateTimeGroupingRule()

Renvoie la règle de regroupement par date/heure sur le groupe de tableau croisé dynamique, ou null si aucune règle de regroupement par date/heure n'est définie.

Renvois

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

Autorisation

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

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

getGroupLimit()

Renvoie la limite de regroupement d'éléments de tableaux croisés dynamiques pour le groupe de tableaux croisés dynamiques. Renvoie null si aucune limite de groupe de tableaux croisés dynamiques n'est définie.

Renvois

PivotGroupLimit|null : limite du groupe de tableaux croisés dynamiques.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 des groupes.

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 scopes suivants :

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

getPivotTable()

Renvoie le 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 scopes 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 index est basé sur 1. Si ce groupe récapitule les données sources de 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 scopes 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 n'est pas un {DataSourcePivotTableApi}.

Renvois

DataSourceColumn|null : colonne de la source de données sur laquelle opère le groupe de tableau croisé dynamique.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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, cette méthode n'a aucun effet. 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 l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

isSortAscending()

Renvoie true si le tri est croissant et false s'il 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 scopes 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 index sont basés sur zéro. Par exemple, si ce groupe doit être déplacé en première position, cette méthode doit être appelée avec 0.

Paramètres

NomTypeDescription
indexIntegerIndex vers lequel déplacer ce regroupement.

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 scopes 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 avec un ou plusieurs des scopes suivants :

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

removeManualGroupingRule(groupName)

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

Paramètres

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

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 scopes suivants :

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

resetDisplayName()

Rétablit la valeur par défaut du nom à afficher de ce groupe dans le tableau croisé dynamique.

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 scopes 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 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 l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 tableau croisé dynamique pour l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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. L'opération n'est acceptée que pour DataSourcePivotTable.

Paramètres

NomTypeDescription
countLimitIntegerLimite du nombre 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 avec un ou plusieurs des scopes 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é. Une règle d'histogramme organise les valeurs d'une colonne de données sources dans des 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ées dans un bucket, tout comme celles supérieures à maxValue.

Paramètres

NomTypeDescription
minValueIntegerValeur minimale des articles à placer dans les groupes. Les valeurs inférieures à celle-ci sont regroupées dans un même bucket.
maxValueIntegerValeur maximale des éléments à placer dans les buckets. Les valeurs supérieures à celle-ci sont regroupées dans un même bucket.
intervalSizeInteger

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 scopes 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, cela n'a aucun effet. Si cette méthode est appelée avant qu'il n'y ait plusieurs regroupements de lignes ou de colonnes, lorsque des regroupements supplémentaires sont ajoutés, les libellés répétés sont affichés.

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 scopes suivants :

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

showTotals(showTotals)

Indique s'il faut afficher les valeurs totales de ce groupe de tableaux croisés dynamiques dans le tableau.

Paramètres

NomTypeDescription
showTotalsBooleanIndique si les totaux doivent être affichés ou non.

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 scopes 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 l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

sortBy(value, oppositeGroupValues)

Trie ce groupe selon le 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

NomTypeDescription
valuePivotValueValeur du tableau croisé dynamique selon laquelle trier.
oppositeGroupValuesObject[]Valeurs d'un groupe croisé 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 l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 l'enchaînement.

Autorisation

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

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