Class DataSourcePivotTable

DataSourcePivotTable

Accéder au tableau croisé dynamique d'une source de données existante et le modifier Pour créer un tableau croisé dynamique de source de données, utilisez Range.createDataSourcePivotTable(dataSource).

N'utilisez cette classe qu'avec des données connectées à une base de données.

Méthodes

MéthodeType renvoyéBrève description
addColumnGroup(columnName)PivotGroupAjoute un nouveau groupe de colonnes de tableau croisé dynamique en fonction de la colonne de source de données spécifiée.
addFilter(columnName, filterCriteria)PivotFilterAjoute un filtre basé sur la colonne de source de données spécifiée avec les critères de filtrage spécifiés.
addPivotValue(columnName, summarizeFunction)PivotValueAjoute une nouvelle valeur de tableau croisé dynamique en fonction de la colonne de source de données spécifiée avec la fonction summarize spécifiée.
addRowGroup(columnName)PivotGroupAjoute un nouveau groupe de lignes de tableaux croisés dynamiques en fonction de la colonne de source de données spécifiée.
asPivotTable()PivotTableRenvoie le tableau croisé dynamique de la source de données en tant qu'objet de tableau croisé dynamique standard.
cancelDataRefresh()DataSourcePivotTableAnnule l'actualisation des données associées à cet objet s'il est en cours d'exécution.
forceRefreshData()DataSourcePivotTableActualise les données de cet objet, quel que soit l'état actuel.
getDataSource()DataSourceRécupère la source de données à laquelle l'objet est associé.
getStatus()DataExecutionStatusRécupère l'état d'exécution des données de l'objet.
refreshData()DataSourcePivotTableActualise les données de l'objet.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAttend la fin de l'exécution en cours, qui expire après le nombre de secondes spécifié.

Documentation détaillée

addColumnGroup(columnName)

Ajoute un nouveau groupe de colonnes de tableau croisé dynamique en fonction de la colonne de source de données spécifiée.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de source de données sur laquelle se base le groupe de tableaux croisés dynamiques.

Renvois

PivotGroup : nouveau 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

addFilter(columnName, filterCriteria)

Ajoute un filtre basé sur la colonne de source de données spécifiée avec les critères de filtrage spécifiés.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne "Source de données" sur laquelle se base le filtre.
filterCriteriaFilterCriteriaCritères utilisés par le filtre.

Renvois

PivotFilter : nouveau filtre.

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

addPivotValue(columnName, summarizeFunction)

Ajoute une nouvelle valeur de tableau croisé dynamique en fonction de la colonne de source de données spécifiée avec la fonction summarize spécifiée.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de source de données sur laquelle la valeur du tableau croisé dynamique est basée.
summarizeFunctionPivotTableSummarizeFunctionFonction de synthèse utilisée par la valeur de tableau croisé dynamique.

Renvois

PivotValue : nouvelle valeur de tableau croisé dynamique.

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

addRowGroup(columnName)

Ajoute un nouveau groupe de lignes de tableaux croisés dynamiques en fonction de la colonne de source de données spécifiée.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de source de données sur laquelle se base le groupe de tableaux croisés dynamiques.

Renvois

PivotGroup : nouveau 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

asPivotTable()

Renvoie le tableau croisé dynamique de la source de données en tant qu'objet de tableau croisé dynamique standard.

Renvois

PivotTable : tableau croisé dynamique.

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

cancelDataRefresh()

Annule l'actualisation des données associées à cet objet s'il est en cours d'exécution.

Cet exemple montre comment annuler l'actualisation d'une formule.

const spreadsheet = SpreadsheetApp.getActive();
const formula = spreadsheet.getDataSourceFormulas()[0];
// Cancel the ongoing refresh on the formula.
formula.cancelDataRefresh();

Une exception est générée si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() afin d'activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourcePivotTable : objet de données

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

forceRefreshData()

Actualise les données de cet objet, quel que soit l'état actuel. Pour en savoir plus, consultez refreshData(). Si vous souhaitez annuler une actualisation en cours de cet objet, consultez cancelDataRefresh().

Une exception est générée si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() afin d'activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourcePivotTable : objet de données

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

getDataSource()

Récupère la source de données à laquelle l'objet est associé.

Renvois

DataSource : source de données.

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

getStatus()

Récupère l'état d'exécution des données de l'objet.

Renvois

DataExecutionStatus : état d'exécution des données.

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

refreshData()

Actualise les données de l'objet.

Génère une exception si l'état actuel est error. Utilisez DataSource#updateSpec() pour mettre à jour la spécification. Cette méthode est préférable à forceRefreshData() pour éviter les modifications inattendues de la source de données.

Une exception est générée si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() afin d'activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourcePivotTable : objet de données

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

waitForCompletion(timeoutInSeconds)

Attend la fin de l'exécution en cours, qui expire après le nombre de secondes spécifié. Elle génère une exception si l'exécution n'est pas terminée lorsque le délai a expiré, mais n'annule pas l'exécution des données.

Paramètres

NomTypeDescription
timeoutInSecondsIntegerDélai d'attente de l'exécution des données, en secondes. La valeur maximale est de 300 secondes.

Renvois

DataExecutionStatus : état d'exécution des données.

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