consulter et créer des fichiers Google Sheets ; Cette classe est la classe parente du service Feuille de calcul.
Propriétés
Propriété | Type | Description |
---|---|---|
AutoFillSeries | AutoFillSeries | Énumération des types de séries utilisées pour calculer les valeurs remplies automatiquement. |
BandingTheme | BandingTheme | Énumération des thèmes de bandes possibles possibles. |
BooleanCriteria | BooleanCriteria | Énumération des critères booléens de mise en forme conditionnelle. |
BorderStyle | BorderStyle | Énumération des styles valides pour définir des bordures sur un élément Range . |
ColorType | ColorType | Énumération des types de couleurs possibles. |
CopyPasteType | CopyPasteType | Énumération des types de collage possibles. |
DataExecutionErrorCode | DataExecutionErrorCode | Énumération des codes d'erreur d'exécution des données possibles. |
DataExecutionState | DataExecutionState | Énumération des états d'exécution des données possibles. |
DataSourceParameterType | DataSourceParameterType | Énumération des types de paramètres de source de données possibles. |
DataSourceRefreshScope | DataSourceRefreshScope | Énumération des champs d'application possibles de l'actualisation de la source de données. |
DataSourceType | DataSourceType | Énumération des types de sources de données possibles. |
DataValidationCriteria | DataValidationCriteria | Énumération représentant les critères de validation des données pouvant être définis sur une plage. |
DateTimeGroupingRuleType | DateTimeGroupingRuleType | Énumération de la règle de regroupement de la date et de l'heure. |
DeveloperMetadataLocationType | DeveloperMetadataLocationType | Énumération des types d'emplacement des métadonnées de développeur possibles. |
DeveloperMetadataVisibility | DeveloperMetadataVisibility | Énumération des visibilités possibles des métadonnées pour les développeurs. |
Dimension | Dimension | Énumération des dimensions possibles d'une feuille de calcul. |
Direction | Direction | Énumération des directions possibles que l'on peut se déplacer dans une feuille de calcul à l'aide des touches fléchées. |
FrequencyType | FrequencyType | Énumération des types de fréquences possibles. |
GroupControlTogglePosition | GroupControlTogglePosition | Énumération des positions auxquelles le bouton d'activation des commandes de groupe peut se trouver. |
InterpolationType | InterpolationType | Énumération des types d'interpolation de gradient du format conditionnel. |
PivotTableSummarizeFunction | PivotTableSummarizeFunction | Énumération des fonctions pouvant être utilisées pour résumer les valeurs d'un tableau croisé dynamique. |
PivotValueDisplayType | PivotValueDisplayType | Énumération des façons dont une valeur de tableau croisé dynamique peut s'afficher. |
ProtectionType | ProtectionType | Énumération représentant les parties d'une feuille de calcul qui peuvent être protégées contre les modifications. |
RecalculationInterval | RecalculationInterval | Énumération des intervalles possibles pouvant être utilisés pour recalculer une feuille de calcul. |
RelativeDate | RelativeDate | Énumération des options de date relative permettant de calculer une valeur à utiliser dans un BooleanCriteria basé sur la date. |
SheetType | SheetType | Énumération des différents types de feuilles pouvant exister dans une feuille de calcul. |
SortOrder | SortOrder | Énumération de l'ordre de tri. |
TextDirection | TextDirection | Énumération des orientations de texte valides. |
TextToColumnsDelimiter | TextToColumnsDelimiter | Énumération des délimiteurs prédéfinis pour la division du texte en colonnes. |
ThemeColorType | ThemeColorType | Énumération des types de couleurs de thème possibles. |
ValueType | ValueType | Énumération des types de valeurs renvoyés par Range.getValue() et Range.getValues() à partir de la classe Range du service Feuille de calcul. Les valeurs d'énumération listées ci-dessous s'ajoutent à Number , Boolean , Date ou String . |
WrapStrategy | WrapStrategy | Énumération des stratégies utilisées pour encapsuler les cellules. |
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
create(name) | Spreadsheet | Crée une feuille de calcul portant le nom indiqué. |
create(name, rows, columns) | Spreadsheet | Crée une feuille de calcul avec le nom donné et le nombre de lignes et de colonnes spécifié. |
enableAllDataSourcesExecution() | void | Active l'exécution des données pour tous les types de sources de données. |
enableBigQueryExecution() | void | Active l'exécution des données pour les sources de données BigQuery. |
flush() | void | Applique toutes les modifications en attente de feuille de calcul. |
getActive() | Spreadsheet | Renvoie la feuille de calcul actuellement active ou null s'il n'y en a pas. |
getActiveRange() | Range | Renvoie la plage sélectionnée dans la feuille active, ou null s'il n'y a pas de plage active. |
getActiveRangeList() | RangeList | Renvoie la liste des plages actives dans la feuille active ou dans null si aucune plage n'est sélectionnée. |
getActiveSheet() | Sheet | Récupère la feuille active dans une feuille de calcul. |
getActiveSpreadsheet() | Spreadsheet | Renvoie la feuille de calcul actuellement active ou null s'il n'y en a pas. |
getCurrentCell() | Range | Renvoie la cellule actuelle (en surbrillance) sélectionnée dans l'une des plages actives de la feuille active ou null s'il n'y a pas de cellule active. |
getSelection() | Selection | Renvoie l'élément Selection actuel de la feuille de calcul. |
getUi() | Ui | Renvoie une instance de l'environnement d'interface utilisateur de la feuille de calcul qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales. |
newCellImage() | CellImageBuilder | Crée un compilateur pour un CellImage . |
newColor() | ColorBuilder | Crée un compilateur pour un Color . |
newConditionalFormatRule() | ConditionalFormatRuleBuilder | Crée un compilateur pour une règle de mise en forme conditionnelle. |
newDataSourceSpec() | DataSourceSpecBuilder | Crée un compilateur pour un DataSourceSpec . |
newDataValidation() | DataValidationBuilder | Crée un compilateur pour une règle de validation des données. |
newFilterCriteria() | FilterCriteriaBuilder | Crée un compilateur pour un FilterCriteria . |
newRichTextValue() | RichTextValueBuilder | Crée un compilateur pour une valeur de texte enrichi. |
newTextStyle() | TextStyleBuilder | Crée un compilateur pour un style de texte. |
open(file) | Spreadsheet | Ouvre la feuille de calcul correspondant à l'objet File indiqué. |
openById(id) | Spreadsheet | Ouvre la feuille de calcul associée à l'identifiant indiqué. |
openByUrl(url) | Spreadsheet | Ouvre la feuille de calcul contenant l'URL indiquée. |
setActiveRange(range) | Range | Définit la plage spécifiée en tant que active range , la cellule supérieure gauche de la plage étant current cell . |
setActiveRangeList(rangeList) | RangeList | Définit la liste de plages spécifiée en tant que active ranges . |
setActiveSheet(sheet) | Sheet | Définit la feuille active dans une feuille de calcul. |
setActiveSheet(sheet, restoreSelection) | Sheet | Définit la feuille active dans une feuille de calcul, avec la possibilité de restaurer la sélection la plus récente de cette feuille. |
setActiveSpreadsheet(newActiveSpreadsheet) | void | Définit la feuille de calcul active. |
setCurrentCell(cell) | Range | Définit la cellule spécifiée comme current cell . |
Documentation détaillée
create(name)
Crée une feuille de calcul portant le nom indiqué.
// The code below creates a new spreadsheet "Finances" and logs the URL for it var ssNew = SpreadsheetApp.create("Finances"); Logger.log(ssNew.getUrl());
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom de la feuille de calcul. |
Renvois
Spreadsheet
: nouvelle feuille de calcul
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
create(name, rows, columns)
Crée une feuille de calcul avec le nom donné et le nombre de lignes et de colonnes spécifié.
// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the // URL for it var ssNew = SpreadsheetApp.create("Finances", 50, 5); Logger.log(ssNew.getUrl());
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nom de la feuille de calcul. |
rows | Integer | Le nombre de lignes de la feuille de calcul. |
columns | Integer | Le nombre de colonnes de la feuille de calcul. |
Renvois
Spreadsheet
: nouvelle feuille de calcul
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
enableAllDataSourcesExecution()
Active l'exécution des données pour tous les types de sources de données.
L'exécution des données génère une exception si le type de source de données n'est pas activé. Utilisez cette méthode pour activer l'exécution des données pour tous les types de sources de données.
// Turns data execution on for all types of data sources. SpreadsheetApp.enableAllDataSourcesExecution(); // Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets the first data source sheet in the spreadsheet and refreshes the data. ss.getDataSourceSheets()[0].refreshData();
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/bigquery.readonly
enableBigQueryExecution()
Active l'exécution des données pour les sources de données BigQuery.
L'exécution des données pour la source de données BigQuery génère une exception si elle n'est pas activée.
// Turns data execution on for BigQuery data sources. SpreadsheetApp.enableBigQueryExecution(); // Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file, // use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets the first data source sheet in the spreadsheet and refreshes the BigQuery data. ss.getDataSourceSheets()[0].refreshData();
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/bigquery.readonly
flush()
Applique toutes les modifications en attente de feuille de calcul.
Les opérations des feuilles de calcul sont parfois regroupées pour améliorer les performances, par exemple lors de l'exécution de plusieurs appels à Range.getValue(). Cependant, il peut arriver que vous souhaitiez vous assurer que toutes les modifications en attente sont effectuées immédiatement, par exemple pour afficher les données des utilisateurs pendant l'exécution d'un script.
// The code below changes the background color of cells A1 and B1 twenty times. You should be // able to see the updates live in the spreadsheet. If flush() is not called, the updates may // be applied live or may all be applied at once when the script completes. function colors() { var sheet = SpreadsheetApp.getActiveSheet(); for (var i = 0; i < 20; i++) { if ((i % 2) == 0) { sheet.getRange('A1').setBackground('green'); sheet.getRange('B1').setBackground('red'); } else { sheet.getRange('A1').setBackground('red'); sheet.getRange('B1').setBackground('green'); } SpreadsheetApp.flush(); } }
getActive()
Renvoie la feuille de calcul actuellement active ou null
s'il n'y en a pas.
Les fonctions exécutées dans le contexte d'une feuille de calcul peuvent obtenir une référence à l'objet Feuille de calcul correspondant en appelant cette fonction.
// The code below logs the URL for the active spreadsheet. Logger.log(SpreadsheetApp.getActive().getUrl());
Renvois
Spreadsheet
: objet Feuille de calcul actif
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
getActiveRange()
Renvoie la plage sélectionnée dans la feuille active, ou null
s'il n'y a pas de plage active. Si vous sélectionnez plusieurs plages, cette méthode ne renvoie que la dernière plage sélectionnée.
Il s'agit généralement de la plage qu'un utilisateur a sélectionnée dans la feuille active, mais dans une fonction personnalisée, elle fait référence à la cellule en cours de recalcul.
// The code below logs the background color for the active range. var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject(); // Assume the color has ColorType.RGB. Logger.log(colorObject.asRgbColor().asHexString());
Renvois
Range
: plage active.
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
getActiveRangeList()
Renvoie la liste des plages actives dans la feuille active ou dans null
si aucune plage n'est sélectionnée. La plage active contenant la cellule actuellement sélectionnée est placée en dernier dans la liste.
Si une seule plage est sélectionnée, cela se comporte comme un appel getActiveRange()
.
// Returns the list of active ranges. var rangeList = SpreadsheetApp.getActiveRangeList();
Renvois
RangeList
: liste des plages actives
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
getActiveSheet()
Récupère la feuille active dans une feuille de calcul.
La feuille active est celle qui s'affiche dans l'interface utilisateur de la feuille de calcul.
// The code below logs the name of the active sheet. Logger.log(SpreadsheetApp.getActiveSheet().getName());
Renvois
Sheet
: objet Sheet actif
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
getActiveSpreadsheet()
Renvoie la feuille de calcul actuellement active ou null
s'il n'y en a pas.
Les fonctions exécutées dans le contexte d'une feuille de calcul peuvent obtenir une référence à l'objet Spreadsheet
correspondant en appelant cette fonction.
// The code below logs the URL for the active spreadsheet. Logger.log(SpreadsheetApp.getActiveSpreadsheet().getUrl());
Renvois
Spreadsheet
: objet Feuille de calcul actif
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
getCurrentCell()
Renvoie la cellule actuelle (en surbrillance) sélectionnée dans l'une des plages actives de la feuille active ou null
s'il n'y a pas de cellule active.
// Returns the current highlighted cell in the one of the active ranges. var currentCell = SpreadsheetApp.getCurrentCell();
Renvois
Range
: cellule actuelle
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
getSelection()
Renvoie l'élément Selection
actuel de la feuille de calcul.
var selection = SpreadsheetApp.getSelection(); var currentCell = selection.getCurrentCell();
Renvois
Selection
: sélection actuelle
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
getUi()
Renvoie une instance de l'environnement d'interface utilisateur de la feuille de calcul qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales. Un script ne peut interagir avec l'interface utilisateur que pour l'instance actuelle d'une feuille de calcul ouverte, et uniquement s'il est lié à la feuille de calcul. Pour en savoir plus, consultez les guides sur les menus et les boîtes de dialogue et barres latérales.
// Add a custom menu to the active spreadsheet, including a separator and a sub-menu. function onOpen(e) { SpreadsheetApp.getUi() .createMenu('My Menu') .addItem('My menu item', 'myFunction') .addSeparator() .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu') .addItem('One sub-menu item', 'mySecondFunction') .addItem('Another sub-menu item', 'myThirdFunction')) .addToUi(); }
Renvois
Ui
: instance de l'environnement d'interface utilisateur de cette feuille de calcul.
newCellImage()
Crée un compilateur pour un CellImage
.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets cell A1 on Sheet1. const range = sheet.getRange('A1'); // Builds an image using a source URL. const cellImage = SpreadsheetApp.newCellImage() .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png') .build(); // Sets the image in cell A1. range.setValue(cellImage);
Renvois
CellImageBuilder
: nouveau compilateur.
newColor()
Crée un compilateur pour un Color
.
var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();
Renvois
ColorBuilder
: nouveau compilateur.
newConditionalFormatRule()
Crée un compilateur pour une règle de mise en forme conditionnelle.
// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red // if they contain a number between 1 and 10. var sheet = SpreadsheetApp.getActive().getActiveSheet(); var range = sheet.getRange('A1:B3'); var rule = SpreadsheetApp.newConditionalFormatRule() .whenNumberBetween(1, 10) .setBackground("#FF0000") .setRanges([range]) .build() var rules = sheet.getConditionalFormatRules(); rules.push(rule); sheet.setConditionalFormatRules(rules);
Renvois
ConditionalFormatRuleBuilder
: nouveau compilateur.
newDataSourceSpec()
Crée un compilateur pour un DataSourceSpec
.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Enables BigQuery. SpreadsheetApp.enableBigQueryExecution(); // Builds a data source specification. // TODO (developer): Update the project ID to your own Google Cloud project ID. const dataSourceSpec = SpreadsheetApp.newDataSourceSpec() .asBigQuery() .setProjectId('project-id-1') .setTableProjectId('bigquery-public-data') .setDatasetId('ncaa_basketball') .setTableId('mbb_historical_teams_games') .build(); // Adds the data source and its data to the spreadsheet. ss.insertDataSourceSheet(dataSourceSpec);
Renvois
DataSourceSpecBuilder
: nouveau compilateur.
newDataValidation()
Crée un compilateur pour une règle de validation des données.
var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation() .requireNumberBetween(1, 100) .setAllowInvalid(false) .setHelpText('Number must be between 1 and 100.') .build(); cell.setDataValidation(rule);
Renvois
DataValidationBuilder
: nouveau compilateur.
newFilterCriteria()
Crée un compilateur pour un FilterCriteria
.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets the range to A1:D20. const range = sheet.getRange('A1:D20'); // Creates a filter and applies it to the specified range. range.createFilter(); // Gets the current filter for the range and creates filter criteria that only shows cells // that aren't empty. const filter = range.getFilter(); const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build(); // Sets the criteria to column C. filter.setColumnFilterCriteria(3, criteria);
Renvois
FilterCriteriaBuilder
: le nouveau compilateur
newRichTextValue()
Crée un compilateur pour une valeur de texte enrichi.
// Sets cell A1 to have the text "Hello world", with "Hello" bolded. var cell = SpreadsheetApp.getActive().getRange('A1'); var bold = SpreadsheetApp.newTextStyle().setBold(true).build(); var value = SpreadsheetApp.newRichTextValue() .setText("Hello world") .setTextStyle(0, 5, bold) .build(); cell.setRichTextValue(value);
Renvois
RichTextValueBuilder
: nouveau compilateur.
newTextStyle()
Crée un compilateur pour un style de texte.
// Sets range A1:B3 to have red, size 22, bolded, underlined text. var range = SpreadsheetApp.getActive().getRange('A1:B3'); var style = SpreadsheetApp.newTextStyle() .setForegroundColor("red") .setFontSize(22) .setBold(true) .setUnderline(true) .build(); range.setTextStyle(style);
Renvois
TextStyleBuilder
: nouveau compilateur.
open(file)
Ouvre la feuille de calcul correspondant à l'objet File indiqué.
// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name // of the first sheet within each spreadsheet. var files = DriveApp.searchFiles( 'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"'); while (files.hasNext()) { var spreadsheet = SpreadsheetApp.open(files.next()); var sheet = spreadsheet.getSheets()[0]; Logger.log(sheet.getName()); }
Paramètres
Nom | Type | Description |
---|---|---|
file | File | Fichier à ouvrir. |
Renvois
Spreadsheet
: feuille de calcul
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
openById(id)
Ouvre la feuille de calcul associée à l'identifiant indiqué. Un ID de feuille de calcul peut être extrait de son URL. Par exemple, l'ID de la feuille de calcul dans l'URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0
est "abc1234567".
// The code below opens a spreadsheet using its ID and logs the name for it. // Note that the spreadsheet is NOT physically opened on the client side. // It is opened on the server only (for modification by the script). var ss = SpreadsheetApp.openById("abc1234567"); Logger.log(ss.getName());
Paramètres
Nom | Type | Description |
---|---|---|
id | String | Identifiant unique de la feuille de calcul. |
Renvois
Spreadsheet
: objet Feuille de calcul avec l'ID donné
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
openByUrl(url)
Ouvre la feuille de calcul contenant l'URL indiquée. Génère une exception de script si l'URL n'existe pas ou si l'utilisateur n'est pas autorisé à y accéder.
// Opens a spreadsheet by its URL and logs its name. // Note that the spreadsheet doesn't physically open on the client side. // It opens on the server only (for modification by the script). var ss = SpreadsheetApp.openByUrl( 'https://docs.google.com/spreadsheets/d/abc1234567/edit'); console.log(ss.getName());
Paramètres
Nom | Type | Description |
---|---|---|
url | String | URL de la feuille de calcul. |
Renvois
Spreadsheet
: objet de feuille de calcul avec l'URL donnée.
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
setActiveRange(range)
Définit la plage spécifiée en tant que active range
, la cellule supérieure gauche de la plage étant current cell
.
L'interface utilisateur de la feuille de calcul affiche la feuille qui contient la plage choisie et sélectionne les cellules définies dans cette plage.
// The code below sets range C1:D4 in the first sheet as the active range. var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4'); SpreadsheetApp.setActiveRange(range); var selection = SpreadsheetApp.getSelection(); // Current cell: C1 var currentCell = selection.getCurrentCell(); // Active Range: C1:D4 var activeRange = selection.getActiveRange();
Paramètres
Nom | Type | Description |
---|---|---|
range | Range | Plage qui deviendra la plage active. |
Renvois
Range
: nouvelle plage active
setActiveRangeList(rangeList)
Définit la liste de plages spécifiée en tant que active ranges
. La dernière plage de la liste est définie en tant que active range
.
// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges. var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']); SpreadsheetApp.setActiveRangeList(rangeList); var selection = SpreadsheetApp.getSelection(); // Current cell: B2 var currentCell = selection.getCurrentCell(); // Active range: B2:C4 var activeRange = selection.getActiveRange(); // Active range list: [D4, B2:C4] var activeRangeList = selection.getActiveRangeList();
Paramètres
Nom | Type | Description |
---|---|---|
rangeList | RangeList | Liste des plages à sélectionner. |
Renvois
RangeList
: liste de plages nouvellement sélectionnée
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
setActiveSheet(sheet)
Définit la feuille active dans une feuille de calcul. L'interface utilisateur de Google Sheets affiche la feuille sélectionnée, sauf si elle appartient à une autre feuille de calcul.
// The code below makes the 2nd sheet active in the active spreadsheet. var spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); SpreadsheetApp.setActiveSheet(spreadsheet.getSheets()[1]);
Paramètres
Nom | Type | Description |
---|---|---|
sheet | Sheet | Nouvelle feuille active. |
Renvois
Sheet
: feuille qui est devenue la feuille active
setActiveSheet(sheet, restoreSelection)
Définit la feuille active dans une feuille de calcul, avec la possibilité de restaurer la sélection la plus récente de cette feuille. L'interface utilisateur de Google Sheets affiche la feuille sélectionnée, sauf si elle appartient à une autre feuille de calcul.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); var firstSheet = spreadsheet.getSheets()[0]; var secondSheet = spreadsheet.getSheets()[1]; // Set the first sheet as the active sheet and select the range D4:F4. spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate(); // Switch to the second sheet to do some work. spreadsheet.setActiveSheet(secondSheet); // Switch back to first sheet, and restore its selection. spreadsheet.setActiveSheet(firstSheet, true); // The selection of first sheet is restored, and it logs D4:F4 var range = spreadsheet.getActiveSheet().getSelection().getActiveRange(); Logger.log(range.getA1Notation());
Paramètres
Nom | Type | Description |
---|---|---|
sheet | Sheet | Nouvelle feuille active. |
restoreSelection | Boolean | Si la valeur est true , la sélection la plus récente de la nouvelle feuille active est de nouveau sélectionnée lorsque la nouvelle feuille devient active. Si la valeur est false , la nouvelle feuille s'active sans modifier la sélection actuelle. |
Renvois
Sheet
: nouvelle feuille active
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
setActiveSpreadsheet(newActiveSpreadsheet)
Définit la feuille de calcul active.
// The code below makes the spreadsheet with key "1234567890" the active spreadsheet var ss = SpreadsheetApp.openById("1234567890"); SpreadsheetApp.setActiveSpreadsheet(ss);
Paramètres
Nom | Type | Description |
---|---|---|
newActiveSpreadsheet | Spreadsheet | Feuille de calcul à transformer en feuille de calcul active. |
setCurrentCell(cell)
Définit la cellule spécifiée comme current cell
.
Si la cellule spécifiée est présente dans une plage déjà sélectionnée, cette plage devient la plage active avec la cellule en tant que cellule actuelle.
Si la cellule spécifiée n'est présente dans aucune plage sélectionnée, la sélection existante est supprimée, et la cellule devient la cellule actuelle et la plage active.
Remarque:L'élément Range
spécifié doit être constitué d'une cellule. Sinon, cette méthode génère une exception.
// The code below sets the cell B5 in the first sheet as the current cell. var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5'); SpreadsheetApp.setCurrentCell(cell); var selection = SpreadsheetApp.getSelection(); // Current cell: B5 var currentCell = selection.getCurrentCell();
Paramètres
Nom | Type | Description |
---|---|---|
cell | Range | Cellule à définir comme cellule actuelle. |
Renvois
Range
: cellule actuelle que vous venez de définir
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