Class DataSourceSheet

DataSourceSheet

Accédez à la feuille de source de données existante et modifiez-la. 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 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 s'il est en cours d'exécution.
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()DataSourceRécupère la source de données à laquelle l'objet est associé.
getFilters()DataSourceSheetFilter[]Renvoie tous les filtres appliqués à la feuille de source de données.
getSheetValues(columnName)Object[]Renvoie toutes les valeurs de la feuille de source de données pour le nom de colonne fourni.
getSheetValues(columnName, startRow, numRows)Object[]Renvoie toutes les valeurs de la feuille de source de données pour le nom de colonne fourni à partir de la ligne de début (based-1) et jusqu'à la numRows fournie.
getSortSpecs()SortSpec[]Récupère toutes les spécifications de tri dans la feuille de 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 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 et expire après le nombre de secondes indiqué.

Documentation détaillée

addFilter(columnName, filterCriteria)

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

Paramètres

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

Renvois

DataSourceSheet : feuille de source de données, pour le chaînage de méthodes.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 correspondant à 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 : feuille de source de données, 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

autoResizeColumns(columnNames)

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

Paramètres

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

Renvois

DataSourceSheet : feuille de source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 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();

Génère une exception si le type de source de données n'est pas activé. Utiliser les méthodes SpreadsheetApp#enable...Execution() afin d'autoriser l'exécution de données pour une source de données spécifique de mots clés.

Renvois

DataSourceSheet : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 l'actualisation de cet objet en cours, consultez cancelDataRefresh().

La fonction renvoie une exception si le type de source de données n'est pas activé. Utiliser les méthodes SpreadsheetApp#enable...Execution() afin d'autoriser l'exécution de données pour une source de données spécifique de mots clés.

Renvois

DataSourceSheet : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 correspondant à 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 correspondant à 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 contenant l'ensemble des filtres appliqués à la feuille de source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 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 de valeurs unidimensionnel.

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 commencer à extraire les valeurs.
numRowsIntegerNombre de lignes à récupérer.

Renvois

Object[] : tableau de valeurs unidimensionnel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 source de données.

Renvois

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

Autorisation

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

La fonction renvoie 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 des modifications inattendues de la source de données.

La fonction renvoie une exception si le type de source de données n'est pas activé. Utiliser les méthodes SpreadsheetApp#enable...Execution() afin d'autoriser l'exécution de données pour une source de données spécifique de mots clés.

Renvois

DataSourceSheet : objet de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne dans laquelle supprimer les filtres.

Renvois

DataSourceSheet : feuille de source de données, pour le chaînage de méthodes.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de la feuille de source de données.

Paramètres

NomTypeDescription
columnNameStringNom de la colonne.

Renvois

DataSourceSheet : feuille de source de données, 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

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 : feuille de source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 : feuille de source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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, trie la colonne dans l'ordre croissant. Si false, trier la colonne dans l’ordre décroissant.

Renvois

DataSourceSheet : feuille de source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 source de données, pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 et expire après le nombre de secondes indiqué. La fonction renvoie une exception si l'exécution n'est pas terminée à l'expiration du délai, mais n'annule pas la l'exécution des données.

Paramètres

NomTypeDescription
timeoutInSecondsIntegerTemps d'attente de l'exécution des données, en secondes. Le maximum 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 correspondant à un ou plusieurs des champs d'application suivants:

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