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 qu'avec des données connectées à une base de données.
Méthodes
| Méthode | Type renvoyé | Brève description |
|---|---|---|
add | Data | Ajoute un filtre appliqué à la feuille de source de données. |
as | Sheet | Renvoie la feuille de source de données sous la forme d'une feuille standard. |
auto | Data | Redimensionne automatiquement la largeur de la colonne spécifiée. |
auto | Data | Redimensionne automatiquement la largeur des colonnes spécifiées. |
cancel | Data | Annule l'actualisation des données associée à cet objet si elle est en cours. |
force | Data | Actualise les données de cet objet, quel que soit l'état actuel. |
get | Integer|null | Renvoie la largeur de la colonne spécifiée. |
get | Data | Obtient la source de données à laquelle l'objet est associé. |
get | Data | Renvoie tous les filtres appliqués à la feuille de source de données. |
get | Object[] | Renvoie toutes les valeurs de la feuille de source de données pour le nom de colonne fourni. |
get | 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 fournie (sur la base 1) et jusqu'à la num fournie. |
get | Sort | Récupère toutes les spécifications de tri dans la feuille de la source de données. |
get | Data | Obtient l'état d'exécution des données de l'objet. |
refresh | Data | Actualise les données de l'objet. |
remove | Data | Supprime tous les filtres appliqués à la colonne de la feuille de source de données. |
remove | Data | Supprime la spécification de tri d'une colonne dans la feuille de source de données. |
set | Data | Définit la largeur de la colonne spécifiée. |
set | Data | Définit la largeur des colonnes spécifiées. |
set | Data | Définit la spécification de tri sur une colonne de la feuille de la source de données. |
set | Data | Définit la spécification de tri sur une colonne de la feuille de la source de données. |
wait | Data | Attend la fin de l'exécution actuelle, avec un délai d'inactivité 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 |
|---|---|---|
column | String | Nom de la colonne à laquelle appliquer ce filtre. |
filter | Filter | Critères de filtrage à appliquer. |
Renvois
DataSourceSheet : feuille de 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 scopes suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
asSheet()
Renvoie la feuille de source de données sous la forme d'une feuille standard.
Renvois
Sheet : feuille standard.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 |
|---|---|---|
column | String | Nom de la colonne. |
Renvois
DataSourceSheet : feuille de source de données pour l'enchaînement.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 |
|---|---|---|
column | String[] | Liste des noms de colonnes à mettre à jour. |
Renvois
DataSourceSheet : feuille de source de données pour l'enchaînement.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 scopes 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 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 scopes 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 |
|---|---|---|
column | String | Nom de la colonne. |
Renvois
Integer|null : 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 scopes 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 scopes suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getFilters()
Renvoie tous les filtres appliqués à la feuille de source de données.
Renvois
DataSourceSheetFilter[] : tableau de tous les filtres appliqués à la feuille de source de données.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 |
|---|---|---|
column | String | Nom de la colonne de 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 scopes 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 source de données pour le nom de colonne fourni à partir de la ligne de début fournie (sur la base 1) et jusqu'à la numRows fournie.
Paramètres
| Nom | Type | Description |
|---|---|---|
column | String | Nom de la colonne de source de données pour laquelle récupérer les valeurs. |
start | Integer | Position de la ligne à partir de laquelle les valeurs doivent être extraites. |
num | Integer | Nombre de lignes à récupérer. |
Renvois
Object[] : tableau unidimensionnel de valeurs.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 scopes suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
getStatus()
Obtient 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 scopes 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 toute modification inattendue de 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 scopes 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 |
|---|---|---|
column | String | Nom de la colonne dont les filtres doivent être supprimés. |
Renvois
DataSourceSheet : feuille de 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 scopes 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 source de données.
Paramètres
| Nom | Type | Description |
|---|---|---|
column | String | Nom de la colonne. |
Renvois
DataSourceSheet : feuille de la source de données, pour l'enchaînement.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 |
|---|---|---|
column | String | Nom de la colonne. |
width | Integer | Nouvelle largeur de la colonne. |
Renvois
DataSourceSheet : feuille de source de données pour l'enchaînement.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 |
|---|---|---|
column | String[] | Liste des noms de colonnes à mettre à jour. |
width | Integer | Nouvelle largeur des colonnes. |
Renvois
DataSourceSheet : feuille de source de données pour l'enchaînement.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 |
|---|---|---|
column | String | Nom de la colonne à trier. |
ascending | Boolean | Si la valeur est true, triez la colonne par ordre croissant. Si la valeur est false, triez la colonne par ordre décroissant. |
Renvois
DataSourceSheet : feuille de la source de données, pour l'enchaînement.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes 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 |
|---|---|---|
column | String | Nom de la colonne à trier. |
sort | Sort | Ordre de tri. |
Renvois
DataSourceSheet : feuille de la source de données, pour l'enchaînement.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets
waitForCompletion(timeoutInSeconds)
Attend la fin de l'exécution actuelle, avec un délai d'inactivité après le nombre de secondes indiqué. Génère une exception si l'exécution n'est pas terminée au moment du délai d'expiration, mais n'annule pas l'exécution des données.
Paramètres
| Nom | Type | Description |
|---|---|---|
timeout | Integer | Temps d'attente pour 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 scopes suivants :
-
https://www.googleapis.com/auth/spreadsheets.currentonly -
https://www.googleapis.com/auth/spreadsheets