Class PivotGroup

PivotGroup

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 étiquettes sont affichées comme répétées.
clearGroupingRule()PivotGroupSupprime toutes 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 et heure du groupe de tableaux croisés dynamiques, ou null si aucune règle de regroupement par date et heure n'est définie.
getDimension()DimensionIndique s'il s'agit d'un groupe de lignes ou de colonnes.
getGroupLimit()PivotGroupLimitRenvoie 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 du groupe actuel.
getPivotTable()PivotTableRenvoie la valeur PivotTable à laquelle ce regroupement appartient.
getSourceDataColumn()IntegerRenvoie le numéro de la colonne de données source résumée par ce groupe.
getSourceDataSourceColumn()DataSourceColumnRenvoie la colonne de source de données sur laquelle le groupe de tableaux croisés dynamiques agit.
hideRepeatedLabels()PivotGroupMasque les libellés répétés pour ce regroupement.
isSortAscending()BooleanRenvoie true si le tri est croissant, false si l'ordre de tri 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 associée au groupName spécifié.
resetDisplayName()PivotGroupRéinitialise le nom à afficher par défaut de ce groupe dans le tableau croisé dynamique.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupDéfinit la règle de regroupement date-heure du 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 de tableaux croisés dynamiques.
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)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 selon le PivotValue spécifié pour les valeurs issues 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 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 de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 étiquettes sont affichées comme répétées.

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 associée à 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 de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 l'enchaînement.

Autorisation

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

Renvois

DateTimeGroupingRule : règle de regroupement date-heure.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 associée à 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 de tableaux croisés dynamiques. Renvoie null si aucune limite pour les groupes de tableaux croisés dynamiques n'est définie.

Renvois

PivotGroupLimit : limite pour les groupes de tableaux croisés dynamiques.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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.

Renvois

Integer : index du groupe de tableaux croisés dynamiques

Autorisation

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

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

getPivotTable()

Renvoie la valeur PivotTable à laquelle ce regroupement appartient.

Renvois

PivotTable : tableau croisé dynamique auquel appartient ce groupe.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 résumée par ce groupe. 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 associée à 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 agit. 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 de tableaux croisés dynamiques agit.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 génère une opération no-op. Si cette méthode est appelée avant 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 de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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, false si l'ordre de 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 associée à 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é 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 de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

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

Paramètres

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

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 par défaut de ce groupe dans le tableau croisé dynamique.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 date-heure du 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 associée à 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 l'enchaînement

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 d'une colonne de données source en 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 seul bucket, tout comme toutes les valeurs supérieures à maxValue.

Paramètres

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

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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, cela entraîne une opération no-op. Si cette méthode est appelée avant plusieurs regroupements de lignes ou de colonnes, lorsqu'un regroupement supplémentaire est ajouté, des étiquettes répétées sont affichées.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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
showTotalsBooleanIndique si les totaux doivent être affichés.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 selon le PivotValue spécifié pour les valeurs issues 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 du tableau croisé dynamique à utiliser pour le tri.
oppositeGroupValuesObject[]Valeurs d'un groupe de tableaux croisés dynamiques opposés (groupe de colonnes si vous triez un groupe de lignes, ou groupe de lignes si vous triez un groupe de colonnes) utilisées pour le tri. L'ordre de ces valeurs détermine la priorité de la rupture d'égalité.

Renvois

PivotGroup : groupe de tableaux croisés dynamiques pour l'enchaînement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 l'enchaînement.

Autorisation

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

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