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éthode | Type renvoyé | Brève description |
|---|---|---|
addFilter(columnName, filterCriteria) | DataSourceSheet | Ajoute un filtre appliqué à la feuille de source de données. |
asSheet() | Sheet | Renvoie la feuille de source de données en tant qu'objet de feuille standard. |
autoResizeColumn(columnName) | DataSourceSheet | Redimensionne automatiquement la largeur de la colonne spécifiée. |
autoResizeColumns(columnNames) | DataSourceSheet | Redimensionne automatiquement la largeur des colonnes spécifiées. |
cancelDataRefresh() | DataSourceSheet | Annule l'actualisation des données associée à cet objet s'il est en cours d'exécution. |
forceRefreshData() | DataSourceSheet | Actualise les données de cet objet quel que soit l'état actuel. |
getColumnWidth(columnName) | Integer | Renvoie la largeur de la colonne spécifiée. |
getDataSource() | DataSource | Ré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() | DataExecutionStatus | Récupère l'état d'exécution des données de l'objet. |
refreshData() | DataSourceSheet | Actualise les données de l'objet. |
removeFilters(columnName) | DataSourceSheet | Supprime tous les filtres appliqués à la colonne de la feuille de source de données. |
removeSortSpec(columnName) | DataSourceSheet | Supprime la spécification de tri d'une colonne dans la feuille de la source de données. |
setColumnWidth(columnName, width) | DataSourceSheet | Définit la largeur de la colonne spécifiée. |
setColumnWidths(columnNames, width) | DataSourceSheet | Définit la largeur des colonnes spécifiées. |
setSortSpec(columnName, ascending) | DataSourceSheet | Définit la spécification de tri sur une colonne de la feuille de la source de données. |
setSortSpec(columnName, sortOrder) | DataSourceSheet | Définit la spécification de tri sur une colonne de la feuille de la source de données. |
waitForCompletion(timeoutInSeconds) | DataExecutionStatus | Attend 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne à laquelle appliquer ce filtre. |
filterCriteria | FilterCriteria | Critè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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom 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
| Nom | Type | Description |
|---|---|---|
columnNames | String[] | 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne de la source de données pour laquelle récupérer les valeurs. |
startRow | Integer | Position de la ligne à partir de laquelle commencer à extraire les valeurs. |
numRows | Integer | Nombre 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne. |
width | Integer | Nouvelle 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
| Nom | Type | Description |
|---|---|---|
columnNames | String[] | Liste des noms de colonnes à mettre à jour. |
width | Integer | Nouvelle 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne à trier. |
ascending | Boolean | Si 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
| Nom | Type | Description |
|---|---|---|
columnName | String | Nom de la colonne à trier. |
sortOrder | SortOrder | Ordre 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
| Nom | Type | Description |
|---|---|---|
timeoutInSeconds | Integer | Temps 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