Class DataSourceSheet

FeuilleSourcede données

Accéder à une feuille de source de données existante et la modifier Pour créer une feuille de source de données, utilisez Spreadsheet.insertDataSourceSheet(spec).

N'utilisez cette classe que pour les données connectées à une base de données.

Méthodes

MéthodeType renvoyéBrève description
addFilter(columnName, filterCriteria)DataSourceSheetAjoute un filtre appliqué à la feuille de la source de données.
asSheet()SheetRenvoie la feuille de source de données en tant qu'objet de feuille standard.
autoResizeColumn(columnName)DataSourceSheetRedimensionne automatiquement la largeur de la colonne spécifiée.
autoResizeColumns(columnNames)DataSourceSheetRedimensionne automatiquement la largeur des colonnes spécifiées.
cancelDataRefresh()DataSourceSheetAnnule l'actualisation des données associée à cet objet si elle est en cours.
forceRefreshData()DataSourceSheetActualise les données de cet objet, quel que soit l'état actuel.
getColumnWidth(columnName)IntegerRenvoie la largeur de la colonne spécifiée.
getDataSource()DataSourceObtient la source de données à laquelle l'objet est associé.
getFilters()DataSourceSheetFilter[]Renvoie tous les filtres appliqués à la feuille de la source de données.
getSheetValues(columnName)Object[]Renvoie toutes les valeurs de la feuille de la source de données pour le nom de colonne fourni.
getSheetValues(columnName, startRow, numRows)Object[]Renvoie toutes les valeurs de la feuille de la source de données pour le nom de colonne fourni à partir de la ligne de départ (basée sur -1) jusqu'à l'numRows fournie.
getSortSpecs()SortSpec[]Récupère toutes les spécifications de tri dans la feuille de la source de données.
getStatus()DataExecutionStatusRécupère l'état d'exécution des données de l'objet.
refreshData()DataSourceSheetActualise les données de l'objet.
removeFilters(columnName)DataSourceSheetSupprime tous les filtres appliqués à la colonne de la feuille de la source de données.
removeSortSpec(columnName)DataSourceSheetSupprime la spécification de tri d'une colonne dans la feuille de la source de données.
setColumnWidth(columnName, width)DataSourceSheetDéfinit la largeur de la colonne spécifiée.
setColumnWidths(columnNames, width)DataSourceSheetDéfinit la largeur des colonnes spécifiées.
setSortSpec(columnName, ascending)DataSourceSheetDéfinit la spécification de tri sur une colonne de la feuille de la source de données.
setSortSpec(columnName, sortOrder)DataSourceSheetDéfinit la spécification de tri sur une colonne de la feuille de la source de données.
waitForCompletion(timeoutInSeconds)DataExecutionStatusAttend la fin de l'exécution en cours, avec un délai d'inactivité de 30 secondes.

Documentation détaillée

addFilter(columnName, filterCriteria)

Ajoute un filtre appliqué à la feuille de la source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne à laquelle appliquer ce filtre.
filterCriteriaFilterCriteriaCritères de filtrage à appliquer.

Renvois

DataSourceSheet : feuille de la source de données, pour l'enchaînement de méthodes.

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

asSheet()

Renvoie la feuille de source de données en tant qu'objet de feuille standard.

Renvois

Sheet : feuille standard.

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

autoResizeColumn(columnName)

Redimensionne automatiquement la largeur de la colonne spécifiée.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne.

Renvois

DataSourceSheet : cette feuille de source de données, pour la concaténation.

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

autoResizeColumns(columnNames)

Redimensionne automatiquement la largeur des colonnes spécifiées.

Paramètres

NomTypeDescription
columnNamesString[]Liste des noms de colonnes à mettre à jour.

Renvois

DataSourceSheet : cette feuille de source de données, pour la concaténation.

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

cancelDataRefresh()

Annule l'actualisation des données associée à cet objet si elle est en cours.

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

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourceSheet : objet de données.

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

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

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourceSheet : objet de données.

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

getColumnWidth(columnName)

Renvoie la largeur de la colonne spécifiée.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne.

Renvois

Integer : largeur de la colonne, ou null si la colonne utilise la largeur par défaut.

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

getDataSource()

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

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

getFilters()

Renvoie tous les filtres appliqués à la feuille de la source de données.

Renvois

DataSourceSheetFilter[] : tableau de tous les filtres appliqués à la feuille de la source de données.

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

getSheetValues(columnName)

Renvoie toutes les valeurs de la feuille de la source de données pour le nom de colonne fourni.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de la source de données pour laquelle récupérer les valeurs.

Renvois

Object[] : tableau unidimensionnel de valeurs.

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

getSheetValues(columnName, startRow, numRows)

Renvoie toutes les valeurs de la feuille de la source de données pour le nom de colonne fourni à partir de la ligne de départ (basée sur -1) jusqu'à l'numRows fournie.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne de la source de données pour laquelle récupérer les valeurs.
startRowIntegerPosition de la ligne à partir de laquelle la récupération des valeurs doit commencer.
numRowsIntegerNombre de lignes à extraire.

Renvois

Object[] : tableau unidimensionnel de valeurs.

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

getSortSpecs()

Récupère toutes les spécifications de tri dans la feuille de la source de données.

Renvois

SortSpec[] : liste des spécifications de tri.

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

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 avec 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. La méthode est préférable à forceRefreshData() pour éviter les modifications inattendues sur la source de données.

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour un type de source de données spécifique.

Renvois

DataSourceSheet : objet de données.

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

removeFilters(columnName)

Supprime tous les filtres appliqués à la colonne de la feuille de la source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne à partir de laquelle les filtres doivent être supprimés.

Renvois

DataSourceSheet : feuille de la source de données, pour l'enchaînement de méthodes.

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

removeSortSpec(columnName)

Supprime la spécification de tri d'une colonne dans la feuille de la source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne.

Renvois

DataSourceSheet : feuille de la source de données, pour la concaténation.

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

setColumnWidth(columnName, width)

Définit la largeur de la colonne spécifiée.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne.
widthIntegerNouvelle largeur de la colonne.

Renvois

DataSourceSheet : cette feuille de source de données, pour la concaténation.

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

setColumnWidths(columnNames, width)

Définit la largeur des colonnes spécifiées.

Paramètres

NomTypeDescription
columnNamesString[]Liste des noms de colonnes à mettre à jour.
widthIntegerNouvelle largeur des colonnes.

Renvois

DataSourceSheet : cette feuille de source de données, pour la concaténation.

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

setSortSpec(columnName, ascending)

Définit la spécification de tri sur une colonne de la feuille de la source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne à trier.
ascendingBooleanSi la valeur est true, la colonne est triée par ordre croissant. Si la valeur est false, la colonne est triée par ordre décroissant.

Renvois

DataSourceSheet : feuille de la source de données, pour la concaténation.

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

setSortSpec(columnName, sortOrder)

Définit la spécification de tri sur une colonne de la feuille de la source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne à trier.
sortOrderSortOrderOrdre de tri.

Renvois

DataSourceSheet : feuille de la source de données, pour la concaténation.

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

waitForCompletion(timeoutInSeconds)

Attend la fin de l'exécution en cours, avec un délai d'inactivité de 30 secondes. Génère une exception si l'exécution n'est pas terminée au moment de l'expiration du délai, mais n'annule pas l'exécution des données.

Paramètres

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

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