Class PivotGroup

Tableau croisé dynamique

Accéder aux groupes de 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 comme répétés.
clearGroupingRule()PivotGroupSupprime les règles de regroupement de ce groupe de tableaux croisés dynamiques.
clearSort()PivotGroupSupprime tout tri appliqué à ce groupe.
getDateTimeGroupingRule()DateTimeGroupingRuleRenvoie la règle de regroupement par date/heure sur le groupe de tableaux croisés dynamiques, 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()PivotGroupLimitAffiche la limite du groupe de tableaux croisés dynamiques sur le groupe de tableaux croisés dynamiques.
getIndex()IntegerRenvoie l'index de ce groupe de tableaux croisés dynamiques dans l'ordre du groupe actuel.
getPivotTable()PivotTableRenvoie le PivotTable auquel ce regroupement appartient.
getSourceDataColumn()IntegerRenvoie le nombre de colonnes de la source de données que ce groupe récapitule.
getSourceDataSourceColumn()DataSourceColumnRenvoie la colonne de source de données sur laquelle le groupe de tableaux croisés dynamiques est utilisé.
hideRepeatedLabels()PivotGroupMasque les libellés répétés pour ce regroupement.
isSortAscending()BooleanRenvoie true si le tri est croissant, renvoie false si l'ordre de tri est 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 manuelle avec l'élément 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 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 du groupe de tableaux croisés dynamiques sur le groupe de tableaux croisés dynamiques.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupDéfinit une règle de regroupement d'histogramme pour ce groupe de tableaux croisés dynamiques.
showRepeatedLabels()PivotGroupLorsque plusieurs lignes ou colonnes sont regroupées, cette méthode affiche le libellé correspondant pour chaque entrée du regroupement suivant.
showTotals(showTotals)PivotGroupDétermine si le tableau doit afficher les valeurs totales de ce groupe de tableaux croisés dynamiques.
sortAscending()PivotGroupDéfinit l'ordre de tri dans l'ordre croissant.
sortBy(value, oppositeGroupValues)PivotGroupTrie ce groupe par le PivotValue spécifié pour les valeurs de oppositeGroupValues.
sortDescending()PivotGroupDéfinit l'ordre de tri décroissant.
totalsAreShown()BooleanIndique si le total des valeurs est actuellement affiché 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.

Aller-retour

PivotGroup : groupe croisé dynamique 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

areLabelsRepeated()

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

Aller-retour

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 avec un ou plusieurs des champs d'application suivants:

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

clearGroupingRule()

Supprime les règles de regroupement de ce groupe de tableaux croisés dynamiques.

Aller-retour

PivotGroup : groupe croisé dynamique 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

clearSort()

Supprime tout tri appliqué à ce groupe.

Aller-retour

PivotGroup : groupe croisé dynamique 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

getDateTimeGroupingRule()

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

Aller-retour

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.

Aller-retour

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

Affiche la limite du groupe de tableaux croisés dynamiques sur le groupe de tableaux croisés dynamiques. Renvoie null si aucune limite de groupe de tableaux croisés dynamiques n'est définie.

Aller-retour

PivotGroupLimit : 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 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 du groupe actuel.

Aller-retour

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 le PivotTable auquel ce regroupement appartient.

Aller-retour

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 nombre de colonnes de la source de données que ce groupe récapitule. Cet index 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.

Aller-retour

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 source de données sur laquelle le groupe de tableaux croisés dynamiques est utilisé. Renvoie null si le tableau croisé dynamique n'est pas un {DataSourcePivotTableApi}.

Aller-retour

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

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 étiquettes sont déjà masquées, aucune opération n'est effectuée. Si cette méthode est appelée avant plusieurs groupes de lignes ou de colonnes, les libellés répétés sont masqués lorsqu'un regroupement supplémentaire est ajouté.

Aller-retour

PivotGroup : groupe croisé dynamique 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

isSortAscending()

Renvoie true si le tri est croissant, renvoie false si l'ordre de tri est décroissant.

Aller-retour

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 de groupes de lignes ou de colonnes. Ces index sont basés sur 0. 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 dans lequel déplacer ce regroupement.

Aller-retour

PivotGroup : groupe croisé dynamique 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

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 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 manuelle avec l'élément groupName spécifié.

Paramètres

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

Aller-retour

PivotGroup : groupe croisé dynamique 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

resetDisplayName()

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

Aller-retour

PivotGroup : groupe croisé dynamique 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

setDateTimeGroupingRule(dateTimeGroupingRuleType)

Définit la règle de regroupement par date et 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.

Aller-retour

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 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.

Aller-retour

PivotGroup : groupe croisé dynamique 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

setGroupLimit(countLimit)

Définit la limite du groupe de tableaux croisés dynamiques sur le groupe 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 positif.

Aller-retour

PivotGroup : groupe croisé dynamique 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'histogramme pour ce groupe de tableaux croisés dynamiques. Une règle d'histogramme organise les valeurs d'une 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ées dans un bucket, de même que toutes les valeurs supérieures à maxValue.

Paramètres

NomTypeDescription
minValueIntegerValeur minimale des éléments à placer dans les buckets. Les valeurs inférieures sont combinées dans un seul bucket.
maxValueIntegerValeur maximale des éléments à placer dans les buckets. Les valeurs supérieures sont combinées dans un seul bucket.
intervalSizeInteger

Aller-retour

PivotGroup : groupe croisé dynamique 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

showRepeatedLabels()

Lorsque plusieurs lignes ou colonnes sont regroupées, cette méthode affiche le libellé correspondant pour chaque entrée du regroupement suivant. Si des étiquettes sont déjà répétées, cela entraîne une opération no-op. Si cette méthode est appelée avant d'avoir plusieurs regroupements de lignes ou de colonnes, l'ajout d'un regroupement supplémentaire affiche des libellés répétés.

Aller-retour

PivotGroup : groupe croisé dynamique 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

showTotals(showTotals)

Détermine si le tableau doit afficher les valeurs totales de ce groupe de tableaux croisés dynamiques.

Paramètres

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

Aller-retour

PivotGroup : groupe croisé dynamique 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

sortAscending()

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

Aller-retour

PivotGroup : groupe croisé dynamique 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

sortBy(value, oppositeGroupValues)

Trie ce groupe par le 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 pour le tri.
oppositeGroupValuesObject[]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és pour le tri. L'ordre de ces valeurs détermine la priorité des cas d'égalité.

Aller-retour

PivotGroup : groupe croisé dynamique 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

sortDescending()

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

Aller-retour

PivotGroup : groupe croisé dynamique 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

totalsAreShown()

Indique si le total des valeurs est actuellement affiché pour ce groupe de tableaux croisés dynamiques.

Aller-retour

Boolean : true si le total de valeurs pour ce groupe de tableaux croisés dynamiques est affiché. 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