accéder aux feuilles de calcul et les modifier ; Les opérations courantes consistent à renommer une feuille et à accéder aux objets de plage de la feuille.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
activate() | Sheet | Active cette feuille. |
addDeveloperMetadata(key) | Sheet | Ajoute à la feuille les métadonnées de développement avec la clé spécifiée. |
addDeveloperMetadata(key, visibility) | Sheet | Ajoute à la feuille des métadonnées de développement avec la clé et la visibilité spécifiées. |
addDeveloperMetadata(key, value) | Sheet | Ajoute à la feuille les métadonnées de développement avec la clé et la valeur spécifiées. |
addDeveloperMetadata(key, value, visibility) | Sheet | Ajoute des métadonnées de développement avec la clé, la valeur et la visibilité spécifiées à la feuille. |
appendRow(rowContents) | Sheet | Ajoute une ligne en bas de la région de données actuelle dans la feuille. |
asDataSourceSheet() | DataSourceSheet | Renvoie la feuille en tant que DataSourceSheet si elle est de type SheetType.DATASOURCE , ou null dans les autres cas. |
autoResizeColumn(columnPosition) | Sheet | Définit la largeur de la colonne donnée en fonction de son contenu. |
autoResizeColumns(startColumn, numColumns) | Sheet | Définit la largeur de toutes les colonnes à partir de la position de colonne donnée en fonction de leur contenu. |
autoResizeRows(startRow, numRows) | Sheet | Définit la hauteur de toutes les lignes à partir de la position de ligne donnée en fonction de leur contenu. |
clear() | Sheet | Efface le contenu et les informations de mise en forme de la feuille. |
clear(options) | Sheet | Efface la feuille des matières et/ou le format, selon les spécifications des options avancées fournies. |
clearConditionalFormatRules() | void | Supprime toutes les règles de mise en forme conditionnelle de la feuille. |
clearContents() | Sheet | Efface la feuille de contenu tout en conservant les informations de mise en forme. |
clearFormats() | Sheet | Efface la mise en forme de la feuille tout en conservant le contenu. |
clearNotes() | Sheet | Efface toutes les notes de la feuille. |
collapseAllColumnGroups() | Sheet | Réduit tous les groupes de colonnes de la feuille. |
collapseAllRowGroups() | Sheet | Réduit tous les groupes de lignes de la feuille. |
copyTo(spreadsheet) | Sheet | Copie la feuille dans une feuille de calcul donnée, qui peut correspondre à la feuille de calcul source. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Renvoie un DeveloperMetadataFinder pour rechercher des métadonnées de développeur dans le champ d'application de cette feuille. |
createTextFinder(findText) | TextFinder | Crée un outil de recherche de texte pour la feuille, qui permet de rechercher et remplacer du texte dans la feuille. |
deleteColumn(columnPosition) | Sheet | Supprime la colonne à la position de colonne indiquée. |
deleteColumns(columnPosition, howMany) | void | Supprime un certain nombre de colonnes à partir de la position de colonne donnée. |
deleteRow(rowPosition) | Sheet | Supprime la ligne à la position de ligne indiquée. |
deleteRows(rowPosition, howMany) | void | Supprime un certain nombre de lignes à partir de la position de ligne indiquée. |
expandAllColumnGroups() | Sheet | Développe tous les groupes de colonnes de la feuille. |
expandAllRowGroups() | Sheet | Développe tous les groupes de lignes de la feuille. |
expandColumnGroupsUpToDepth(groupDepth) | Sheet | Développe tous les groupes de colonnes jusqu'à la profondeur donnée et réduit tous les autres. |
expandRowGroupsUpToDepth(groupDepth) | Sheet | Développe tous les groupes de lignes jusqu'à la profondeur donnée et réduit tous les autres. |
getActiveCell() | Range | Renvoie la cellule active dans cette feuille. |
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 s'il n'y a pas de plages actives. |
getBandings() | Banding[] | Renvoie toutes les bandes de cette feuille. |
getCharts() | EmbeddedChart[] | Renvoie un tableau de graphiques sur cette feuille. |
getColumnGroup(columnIndex, groupDepth) | Group | Renvoie le groupe de colonnes à l'index et à la profondeur de groupe donnés. |
getColumnGroupControlPosition() | GroupControlTogglePosition | Renvoie la valeur GroupControlTogglePosition pour tous les groupes de colonnes de la feuille. |
getColumnGroupDepth(columnIndex) | Integer | Renvoie la profondeur de groupe de la colonne au niveau de l'index donné. |
getColumnWidth(columnPosition) | Integer | Récupère la largeur en pixels de la colonne donnée. |
getConditionalFormatRules() | ConditionalFormatRule[] | Obtenez toutes les règles de mise en forme conditionnelle dans cette feuille. |
getCurrentCell() | Range | Renvoie la cellule active dans la feuille active ou null s'il n'y a pas de cellule active. |
getDataRange() | Range | Renvoie une valeur Range correspondant aux dimensions dans lesquelles des données sont présentes. |
getDataSourceFormulas() | DataSourceFormula[] | Récupère toutes les formules de la source de données. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Récupère tous les tableaux croisés dynamiques de sources de données. |
getDataSourceTables() | DataSourceTable[] | Récupère toutes les tables de la source de données. |
getDeveloperMetadata() | DeveloperMetadata[] | Obtenez toutes les métadonnées de développement associées à cette feuille. |
getDrawings() | Drawing[] | Renvoie un tableau de dessins sur la feuille. |
getFilter() | Filter | Renvoie le filtre de cette feuille, ou null s'il n'y a pas de filtre. |
getFormUrl() | String | Renvoie l'URL du formulaire qui envoie ses réponses à cette feuille, ou null si cette feuille n'est associée à aucun formulaire. |
getFrozenColumns() | Integer | Renvoie le nombre de colonnes figées. |
getFrozenRows() | Integer | Renvoie le nombre de lignes figées. |
getImages() | OverGridImage[] | Renvoie toutes les images de la feuille superposées à la grille. |
getIndex() | Integer | Récupère la position de la feuille dans sa feuille de calcul parente. |
getLastColumn() | Integer | Renvoie la position de la dernière colonne comportant du contenu. |
getLastRow() | Integer | Renvoie la position de la dernière ligne comportant du contenu. |
getMaxColumns() | Integer | Renvoie le nombre actuel de colonnes dans la feuille, quel que soit le contenu. |
getMaxRows() | Integer | Renvoie le nombre actuel de lignes dans la feuille, quel que soit le contenu. |
getName() | String | Renvoie le nom de la feuille. |
getNamedRanges() | NamedRange[] | Récupère toutes les plages nommées de cette feuille. |
getParent() | Spreadsheet | Renvoie la valeur Spreadsheet contenant cette feuille. |
getPivotTables() | PivotTable[] | Renvoie tous les tableaux croisés dynamiques de cette feuille. |
getProtections(type) | Protection[] | Récupère un tableau d'objets représentant toutes les plages protégées de la feuille, ou un tableau à un seul élément représentant la protection sur la feuille elle-même. |
getRange(row, column) | Range | Renvoie la plage dont la cellule en haut à gauche aux coordonnées données. |
getRange(row, column, numRows) | Range | Renvoie la plage avec la cellule en haut à gauche aux coordonnées données et avec le nombre de lignes indiqué. |
getRange(row, column, numRows, numColumns) | Range | Renvoie la plage avec la cellule en haut à gauche aux coordonnées données avec le nombre de lignes et de colonnes indiqué. |
getRange(a1Notation) | Range | Renvoie la plage telle qu'elle est spécifiée en notation A1 ou R1C1. |
getRangeList(a1Notations) | RangeList | Renvoie la collection RangeList représentant les plages de la même feuille spécifiées par une liste non vide de notations A1 ou R1C1. |
getRowGroup(rowIndex, groupDepth) | Group | Renvoie le groupe de lignes à l'index et à la profondeur de groupe donnés. |
getRowGroupControlPosition() | GroupControlTogglePosition | Renvoie la valeur GroupControlTogglePosition pour tous les groupes de lignes de la feuille. |
getRowGroupDepth(rowIndex) | Integer | Renvoie la profondeur de groupe de la ligne au niveau de l'index donné. |
getRowHeight(rowPosition) | Integer | Récupère la hauteur, en pixels, de la ligne donnée. |
getSelection() | Selection | Renvoie l'élément Selection actuel de la feuille de calcul. |
getSheetId() | Integer | Renvoie l'ID de la feuille représentée par cet objet. |
getSheetName() | String | Renvoie le nom de la feuille. |
getSheetValues(startRow, startColumn, numRows, numColumns) | Object[][] | Renvoie la grille rectangulaire des valeurs pour cette plage à partir des coordonnées données. |
getSlicers() | Slicer[] | Renvoie un tableau de segments sur la feuille. |
getTabColorObject() | Color | Récupère la couleur de l'onglet de la feuille ou null si l'onglet de la feuille n'est pas coloré. |
getType() | SheetType | Renvoie le type de la feuille. |
hasHiddenGridlines() | Boolean | Renvoie true si le quadrillage de la feuille est masqué. Sinon, renvoie false . |
hideColumn(column) | void | Masque la ou les colonnes figurant dans la plage indiquée. |
hideColumns(columnIndex) | void | Masque une seule colonne au niveau de l'index donné. |
hideColumns(columnIndex, numColumns) | void | Masque une ou plusieurs colonnes consécutives à partir de l'index donné. |
hideRow(row) | void | Masque les lignes de la plage donnée. |
hideRows(rowIndex) | void | Masque la ligne au niveau de l'index donné. |
hideRows(rowIndex, numRows) | void | Masque une ou plusieurs lignes consécutives à partir de l'index donné. |
hideSheet() | Sheet | Masque cette feuille. |
insertChart(chart) | void | Ajoute un nouveau graphique à cette feuille. |
insertColumnAfter(afterPosition) | Sheet | Insère une colonne après la position de colonne donnée. |
insertColumnBefore(beforePosition) | Sheet | Insère une colonne avant la position de colonne indiquée. |
insertColumns(columnIndex) | void | Insère une colonne vide dans une feuille à l'emplacement spécifié. |
insertColumns(columnIndex, numColumns) | void | Insère une ou plusieurs colonnes vides consécutives dans une feuille à partir de l'emplacement spécifié. |
insertColumnsAfter(afterPosition, howMany) | Sheet | Insère un nombre donné de colonnes après la position de colonne indiquée. |
insertColumnsBefore(beforePosition, howMany) | Sheet | Insère un certain nombre de colonnes avant la position de colonne donnée. |
insertImage(blobSource, column, row) | OverGridImage | Insère un BlobSource en tant qu'image dans le document, sur une ligne et une colonne données. |
insertImage(blobSource, column, row, offsetX, offsetY) | OverGridImage | Insère un BlobSource en tant qu'image dans le document sur une ligne et une colonne données, avec un décalage de pixel. |
insertImage(url, column, row) | OverGridImage | Insère une image dans le document sur une ligne et une colonne données. |
insertImage(url, column, row, offsetX, offsetY) | OverGridImage | Insère une image dans le document sur une ligne et une colonne données, avec un décalage de pixels. |
insertRowAfter(afterPosition) | Sheet | Insère une ligne après la position de ligne indiquée. |
insertRowBefore(beforePosition) | Sheet | Insère une ligne avant la position de ligne indiquée. |
insertRows(rowIndex) | void | Insère une ligne vide dans une feuille à l'emplacement spécifié. |
insertRows(rowIndex, numRows) | void | Insère une ou plusieurs lignes vides consécutives dans une feuille à partir de l'emplacement spécifié. |
insertRowsAfter(afterPosition, howMany) | Sheet | Insère un certain nombre de lignes après la position de ligne donnée. |
insertRowsBefore(beforePosition, howMany) | Sheet | Insère un certain nombre de lignes avant la position de ligne donnée. |
insertSlicer(range, anchorRowPos, anchorColPos) | Slicer | Ajoute un segment à cette feuille. |
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY) | Slicer | Ajoute un segment à cette feuille. |
isColumnHiddenByUser(columnPosition) | Boolean | Indique si la colonne donnée est masquée par l'utilisateur. |
isRightToLeft() | Boolean | Renvoie true si la mise en page de cette feuille est de droite à gauche. |
isRowHiddenByFilter(rowPosition) | Boolean | Indique si la ligne donnée est masquée par un filtre (et non par une vue filtrée). |
isRowHiddenByUser(rowPosition) | Boolean | Indique si la ligne donnée est masquée par l'utilisateur. |
isSheetHidden() | Boolean | Renvoie la valeur true si la feuille est actuellement masquée. |
moveColumns(columnSpec, destinationIndex) | void | Déplace les colonnes sélectionnées par la plage donnée vers la position indiquée par destinationIndex . |
moveRows(rowSpec, destinationIndex) | void | Déplace les lignes sélectionnées par la plage donnée vers la position indiquée par destinationIndex . |
newChart() | EmbeddedChartBuilder | Affiche un compilateur permettant de créer un graphique pour cette feuille. |
protect() | Protection | Crée un objet qui peut empêcher la modification de la feuille, sauf par les utilisateurs disposant de l'autorisation requise. |
removeChart(chart) | void | Supprime un graphique de la feuille parente. |
setActiveRange(range) | Range | Définit la plage spécifiée comme active range dans la feuille active, avec la cellule supérieure gauche de la plage en tant que current cell . |
setActiveRangeList(rangeList) | RangeList | Définit la liste des plages spécifiée comme active ranges dans la feuille active. |
setActiveSelection(range) | Range | Définit la région de sélection active pour cette feuille. |
setActiveSelection(a1Notation) | Range | Définit la sélection active, selon la notation A1 ou R1C1. |
setColumnGroupControlPosition(position) | Sheet | Définit la position du bouton d'activation des commandes de groupe de colonnes sur la feuille. |
setColumnWidth(columnPosition, width) | Sheet | Définit la largeur de la colonne donnée en pixels. |
setColumnWidths(startColumn, numColumns, width) | Sheet | Définit la largeur des colonnes indiquées en pixels. |
setConditionalFormatRules(rules) | void | Remplace toutes les règles de mise en forme conditionnelle existantes de la feuille par les règles de saisie. |
setCurrentCell(cell) | Range | Définit la cellule spécifiée comme current cell . |
setFrozenColumns(columns) | void | Gèle le nombre donné de colonnes. |
setFrozenRows(rows) | void | Figer le nombre donné de lignes. |
setHiddenGridlines(hideGridlines) | Sheet | Masque ou affiche le quadrillage de la feuille. |
setName(name) | Sheet | Définit le nom de la feuille. |
setRightToLeft(rightToLeft) | Sheet | Définit ou désactive la mise en page de la feuille de droite à gauche. |
setRowGroupControlPosition(position) | Sheet | Définit la position du bouton d'activation du groupe de lignes sur la feuille. |
setRowHeight(rowPosition, height) | Sheet | Définit la hauteur de la ligne donnée en pixels. |
setRowHeights(startRow, numRows, height) | Sheet | Définit la hauteur des lignes indiquées en pixels. |
setRowHeightsForced(startRow, numRows, height) | Sheet | Définit la hauteur des lignes indiquées en pixels. |
setTabColor(color) | Sheet | Définit la couleur des onglets de la feuille. |
setTabColorObject(color) | Sheet | Définit la couleur des onglets de la feuille. |
showColumns(columnIndex) | void | Affiche la colonne au niveau de l'index donné. |
showColumns(columnIndex, numColumns) | void | Affiche une ou plusieurs colonnes consécutives à partir de l'index donné. |
showRows(rowIndex) | void | Affiche la ligne au niveau de l'index donné. |
showRows(rowIndex, numRows) | void | Affiche une ou plusieurs lignes consécutives à partir de l'index donné. |
showSheet() | Sheet | Rend la feuille visible. |
sort(columnPosition) | Sheet | Trie une feuille par colonne, dans l’ordre croissant. |
sort(columnPosition, ascending) | Sheet | Trie une feuille par colonne. |
unhideColumn(column) | void | Affiche la colonne dans la plage donnée. |
unhideRow(row) | void | Affiche la ligne dans la plage donnée. |
updateChart(chart) | void | Met à jour le graphique sur cette feuille. |
Documentation détaillée
activate()
Active cette feuille. Ne modifie pas la feuille elle-même, seulement la notion parent de la feuille active.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.activate();
Renvois
Sheet
: feuille nouvellement active.
addDeveloperMetadata(key)
Ajoute à la feuille les métadonnées de développement avec la clé spécifiée.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' to the developer metadata for the sheet. sheet.addDeveloperMetadata('NAME'); // Gets the updated metadata info and logs it to the console. console.log(sheet.getDeveloperMetadata()[0].getKey());
Paramètres
Nom | Type | Description |
---|---|---|
key | String | Clé pour les nouvelles métadonnées du développeur. |
Renvois
Sheet
: feuille, pour le chaînage.
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
addDeveloperMetadata(key, visibility)
Ajoute à la feuille des métadonnées de développement avec la clé et la visibilité spécifiées.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'NAME' and sets the developer metadata visibility to PROJECT // for the sheet. sheet.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getVisibility().toString());
Paramètres
Nom | Type | Description |
---|---|---|
key | String | Clé pour les nouvelles métadonnées du développeur. |
visibility | DeveloperMetadataVisibility | Visibilité des nouvelles métadonnées du développeur. |
Renvois
Sheet
: feuille, pour le chaînage.
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
addDeveloperMetadata(key, value)
Ajoute à la feuille les métadonnées de développement avec la clé et la valeur spécifiées.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for the sheet. sheet.addDeveloperMetadata('COMPANY', 'TECH'); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());
Paramètres
Nom | Type | Description |
---|---|---|
key | String | Clé pour les nouvelles métadonnées du développeur. |
value | String | Valeur des nouvelles métadonnées de développeur. |
Renvois
Sheet
: feuille, pour le chaînage.
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
addDeveloperMetadata(key, value, visibility)
Ajoute des métadonnées de développement avec la clé, la valeur et la visibilité spécifiées à la feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and sets the // visibility to DOCUMENT for the sheet. sheet.addDeveloperMetadata( 'COMPANY', 'TECH', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT); // Gets the updated metadata info and logs it to the console. const developerMetaData = sheet.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
Paramètres
Nom | Type | Description |
---|---|---|
key | String | Clé pour les nouvelles métadonnées du développeur. |
value | String | Valeur des nouvelles métadonnées de développeur. |
visibility | DeveloperMetadataVisibility | Visibilité des nouvelles métadonnées du développeur. |
Renvois
Sheet
: feuille, pour le chaînage.
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
appendRow(rowContents)
Ajoute une ligne en bas de la région de données actuelle dans la feuille. Si le contenu d'une cellule commence par =
, il est interprété comme une formule.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Appends a new row with 3 columns to the bottom of the current // data region in the sheet containing the values in the array. sheet.appendRow(["a man", "a plan", "panama"]);
Paramètres
Nom | Type | Description |
---|---|---|
rowContents | Object[] | Tableau de valeurs à insérer après la dernière ligne de la feuille. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes.
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
asDataSourceSheet()
Renvoie la feuille en tant que DataSourceSheet
si elle est de type SheetType.DATASOURCE
, ou null
dans les autres cas.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the data source sheet value if the sheet is of type // SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value. const dataSourceSheet = sheet.asDataSourceSheet(); // Gets the data source sheet value and logs it to the console. console.log(dataSourceSheet); console.log(sheet.getType().toString());
Renvois
DataSourceSheet
: feuille de la source de données
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
autoResizeColumn(columnPosition)
Définit la largeur de la colonne donnée en fonction de son contenu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...'); // Sets the first column to a width which fits the text sheet.autoResizeColumn(1);
Paramètres
Nom | Type | Description |
---|---|---|
columnPosition | Integer | Position à redimensionner de la colonne donnée. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
autoResizeColumns(startColumn, numColumns)
Définit la largeur de toutes les colonnes à partir de la position de colonne donnée en fonction de leur contenu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first 15 columns to a width that fits their text. sheet.autoResizeColumns(1, 15);
Paramètres
Nom | Type | Description |
---|---|---|
startColumn | Integer | Première colonne à redimensionner automatiquement. |
numColumns | Integer | Nombre de colonnes à redimensionner automatiquement. |
Renvois
Sheet
: feuille, pour le chaînage.
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
autoResizeRows(startRow, numRows)
Définit la hauteur de toutes les lignes à partir de la position de ligne donnée en fonction de leur contenu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first 15 rows to a height that fits their text. sheet.autoResizeRows(1, 15);
Paramètres
Nom | Type | Description |
---|---|---|
startRow | Integer | Première ligne à redimensionner automatiquement. |
numRows | Integer | Nombre de lignes à redimensionner automatiquement. |
Renvois
Sheet
: feuille, pour le chaînage.
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
clear()
Efface le contenu et les informations de mise en forme de la feuille.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clear();
Renvois
Sheet
: feuille effacé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
clear(options)
Efface la feuille des matières et/ou le format, selon les spécifications des options avancées fournies.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.clear({ formatOnly: true, contentsOnly: true });
Paramètres
Nom | Type | Description |
---|---|---|
options | Object | Carte JavaScript contenant les options avancées, répertoriées ci-dessous. |
Paramètres avancés
Nom | Type | Description |
---|---|---|
contentsOnly | Boolean | Indique s'il faut effacer le contenu. |
formatOnly | Boolean | Indique s'il faut effacer le format. |
Renvois
Sheet
: feuille, pour le chaînage.
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
clearConditionalFormatRules()
Supprime toutes les règles de mise en forme conditionnelle de la feuille. Cela équivaut à appeler setConditionalFormatRules(rules)
avec un tableau vide en entrée.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.clearConditionalFormatRules();
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
clearContents()
Efface la feuille de contenu tout en conservant les informations de mise en forme.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearContents();
Renvois
Sheet
: feuille, pour le chaînage.
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
clearFormats()
Efface la mise en forme de la feuille tout en conservant le contenu.
La mise en forme désigne la mise en forme des données selon les options du menu "Format" (par exemple, gras, italique ou conditionnel), et non la largeur ou la hauteur des cellules.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearFormats();
Renvois
Sheet
: feuille, pour le chaînage.
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
clearNotes()
Efface toutes les notes de la feuille.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.clearNotes();
Renvois
Sheet
: feuille, pour le chaînage.
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
collapseAllColumnGroups()
Réduit tous les groupes de colonnes de la feuille.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are collapsed. sheet.collapseAllColumnGroups();
Renvois
Sheet
: feuille, pour le chaînage.
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
collapseAllRowGroups()
Réduit tous les groupes de lignes de la feuille.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are collapsed. sheet.collapseAllRowGroups();
Renvois
Sheet
: feuille, pour le chaînage.
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
copyTo(spreadsheet)
Copie la feuille dans une feuille de calcul donnée, qui peut correspondre à la feuille de calcul source. La feuille copiée est nommée "Copie de [nom d'origine]".
var source = SpreadsheetApp.getActiveSpreadsheet(); var sheet = source.getSheets()[0]; var destination = SpreadsheetApp.openById('ID_GOES HERE'); sheet.copyTo(destination);
Paramètres
Nom | Type | Description |
---|---|---|
spreadsheet | Spreadsheet | Feuille de calcul dans laquelle copier cette feuille, qui peut être identique à la feuille de calcul source. |
Renvois
Sheet
: nouvelle feuille, pour l'enchaînement.
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
createDeveloperMetadataFinder()
Renvoie un DeveloperMetadataFinder
pour rechercher des métadonnées de développeur dans le champ d'application de cette feuille. Les métadonnées sont comprises dans le champ d'application d'une feuille spécifique si elles sont associées à la feuille elle-même, ou à une ligne, une colonne ou une plage de cette feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Creates the developer metadata finder. const metadatafinder = sheet.createDeveloperMetadataFinder(); // Finds the metadata with value 'PARIS' and displays its key in the console. console.log(metadatafinder.withValue('PARIS').find()[0].getKey());
Renvois
DeveloperMetadataFinder
: outil de recherche de métadonnées de développement permettant de rechercher des métadonnées dans le champ d'application de cette feuille.
createTextFinder(findText)
Crée un outil de recherche de texte pour la feuille, qui permet de rechercher et remplacer du texte dans la feuille.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Creates a text finder. var textFinder = sheet.createTextFinder('dog'); // Returns the first occurrence of 'dog' in the sheet. var firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. var numOccurrencesReplaced = findOccurrence.replaceWith('cat');
Paramètres
Nom | Type | Description |
---|---|---|
findText | String | Texte à rechercher. |
Renvois
TextFinder
: TextFinder
de la feuille.
deleteColumn(columnPosition)
Supprime la colonne à la position de colonne indiquée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first column sheet.deleteColumn(1);
Paramètres
Nom | Type | Description |
---|---|---|
columnPosition | Integer | Position de la colonne, à partir de 1 pour la première colonne. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
deleteColumns(columnPosition, howMany)
Supprime un certain nombre de colonnes à partir de la position de colonne donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at "1" - this deletes the first two columns sheet.deleteColumns(1, 2);
Paramètres
Nom | Type | Description |
---|---|---|
columnPosition | Integer | Position de la première colonne à supprimer. |
howMany | Integer | Nombre de colonnes à supprimer. |
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
deleteRow(rowPosition)
Supprime la ligne à la position de ligne indiquée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first row sheet.deleteRow(1);
Paramètres
Nom | Type | Description |
---|---|---|
rowPosition | Integer | Position de la ligne, à partir de 1 pour la première ligne. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
deleteRows(rowPosition, howMany)
Supprime un certain nombre de lignes à partir de la position de ligne indiquée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at "1" - this deletes the first two rows sheet.deleteRows(1, 2);
Paramètres
Nom | Type | Description |
---|---|---|
rowPosition | Integer | Position de la première ligne à supprimer. |
howMany | Integer | Nombre de lignes à supprimer. |
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
expandAllColumnGroups()
Développe tous les groupes de colonnes de la feuille. Cette méthode nécessite au moins un groupe de colonnes.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups on the sheet are expanded. sheet.expandAllColumnGroups();
Renvois
Sheet
: feuille, pour le chaînage.
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
expandAllRowGroups()
Développe tous les groupes de lignes de la feuille. Cette méthode nécessite au moins un groupe de lignes.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups on the sheet are expanded. sheet.expandAllRowGroups();
Renvois
Sheet
: feuille, pour le chaînage.
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
expandColumnGroupsUpToDepth(groupDepth)
Développe tous les groupes de colonnes jusqu'à la profondeur donnée et réduit tous les autres.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All column groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandColumnGroupsUpToDepth(2);
Paramètres
Nom | Type | Description |
---|---|---|
groupDepth | Integer | Profondeur de groupe jusqu'à laquelle étendre les groupes de colonnes. |
Renvois
Sheet
: feuille, pour le chaînage.
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
expandRowGroupsUpToDepth(groupDepth)
Développe tous les groupes de lignes jusqu'à la profondeur donnée et réduit tous les autres.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // All row groups of depth 2 and lower are expanded, and groups with depth // 3 and higher are collapsed. sheet.expandRowGroupsUpToDepth(2);
Paramètres
Nom | Type | Description |
---|---|---|
groupDepth | Integer | Profondeur du groupe jusqu'à lequel développer les groupes de lignes. |
Renvois
Sheet
: feuille, pour le chaînage.
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
getActiveCell()
Renvoie la cellule active dans cette feuille.
Remarque:Il est préférable d'utiliser getCurrentCell()
, qui renvoie la cellule actuelle en surbrillance.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Returns the active cell var cell = sheet.getActiveCell();
Renvois
Range
: cellule actuellement 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
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.
Le terme "plage active" désigne la plage qu'un utilisateur a sélectionnée dans la feuille active, mais dans une fonction personnalisée, il fait référence à la cellule en cours de recalcul.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var activeRange = sheet.getActiveRange();
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
Voir aussi
getActiveRangeList()
Renvoie la liste des plages actives dans la feuille active ou dans null
s'il n'y a pas de plages actives.
Si une seule plage est sélectionnée, cela se comporte comme un appel getActiveRange()
.
var sheet = SpreadsheetApp.getActiveSheet(); // Returns the list of active ranges. var activeRangeList = sheet.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
Voir aussi
getBandings()
Renvoie toutes les bandes de cette feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the banding info for the sheet. const bandings = sheet.getBandings(); // Gets info on the bandings' second row color and logs it to the console. for (const banding of bandings) { console.log(banding.getSecondRowColor()); }
Renvois
Banding[]
: toutes les bandes de cette feuille.
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
getCharts()
Renvoie un tableau de graphiques sur cette feuille.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; // Do something with the chart }
Renvois
EmbeddedChart[]
: tableau de graphiques.
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
getColumnGroup(columnIndex, groupDepth)
Renvoie le groupe de colonnes à l'index et à la profondeur de groupe donnés.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at column 2 and has a depth of 1, or // null if the group doesn’t exist. var columnGroup = sheet.getColumnGroup(2, 1);
Paramètres
Nom | Type | Description |
---|---|---|
columnIndex | Integer | Index de colonne du bouton d'activation/de désactivation de la commande de groupe ou d'un index appartenant au groupe. |
groupDepth | Integer | Profondeur du groupe. |
Renvois
Group
: groupe de colonnes de l'index et de la profondeur de contrôle, ou génère une exception si le groupe n'existe pas.
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
getColumnGroupControlPosition()
Renvoie la valeur GroupControlTogglePosition
pour tous les groupes de colonnes de la feuille.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the column grouping control toggle is shown after the // group. var columnGroupControlPosition = sheet.getColumnGroupControlPosition();
Renvois
GroupControlTogglePosition
: true
si le bouton d'activation du regroupement de colonnes est affiché après le groupe sur cette feuille et false
dans le cas contraire.
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
getColumnGroupDepth(columnIndex)
Renvoie la profondeur de groupe de la colonne au niveau de l'index donné.
La profondeur du groupe indique le nombre de groupes qui chevauchent la colonne. Cela peut varier entre zéro et huit.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over columns 1 through 3 var groupDepth = sheet.getColumnGroupDepth(1);
Paramètres
Nom | Type | Description |
---|---|---|
columnIndex | Integer | Index de la colonne. |
Renvois
Integer
: profondeur de groupe de la colonne au niveau de l'index 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.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumnWidth(columnPosition)
Récupère la largeur en pixels de la colonne donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.getColumnWidth(1));
Paramètres
Nom | Type | Description |
---|---|---|
columnPosition | Integer | Position de la colonne à examiner. |
Renvois
Integer
: largeur de la colonne en pixels
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
getConditionalFormatRules()
Obtenez toutes les règles de mise en forme conditionnelle dans cette feuille.
// Logs the conditional format rules in a sheet. var rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules(); for (var i = 0; i < rules.length; i++) { var rule = rules[i]; Logger.log(rule); }
Renvois
ConditionalFormatRule[]
: tableau de toutes les règles de la feuille.
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 active dans la feuille active ou null
s'il n'y a pas de cellule active. La cellule actuelle est celle qui est active dans l'interface utilisateur de Google Sheets. Elle est mise en évidence par une bordure sombre. Il n'y a jamais plus d'une cellule active. Lorsqu'un utilisateur sélectionne une ou plusieurs plages de cellules, l'une des cellules sélectionnées correspond à la cellule actuelle.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); // Returns the current highlighted cell in the one of the active ranges. var currentCell = sheet.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
getDataRange()
Renvoie une valeur Range
correspondant aux dimensions dans lesquelles des données sont présentes.
D'un point de vue fonctionnel, cela revient à créer une plage limitée par A1 et (Sheet.getLastColumn(), Sheet.getLastRow()).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This represents ALL the data var range = sheet.getDataRange(); var values = range.getValues(); // This logs the spreadsheet in CSV format with a trailing comma for (var i = 0; i < values.length; i++) { var row = ""; for (var j = 0; j < values[i].length; j++) { if (values[i][j]) { row = row + values[i][j]; } row = row + ","; } Logger.log(row); }
Renvois
Range
: plage contenant toutes les données de la 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.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormulas()
Récupère toutes les formules de la source de données.
// Opens the spreadsheet by its ID. If you created your script from within a Google Sheets // file, use SpreadsheetApp.getActiveSpreadsheet(). // TODO(developer): Replace the ID with your own. const ss = SpreadsheetApp.openById('abc123456'); // Gets Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of the data source formulas on Sheet1. // To get an array of data source formulas for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceFormulas = sheet.getDataSourceFormulas(); // Logs the first data source formula in the array. console.log(dataSourceFormulas[0].getFormula());
Renvois
DataSourceFormula[]
: liste de formules de sources de données.
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
getDataSourcePivotTables()
Récupère tous les tableaux croisés dynamiques de sources de données.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of the data source pivot tables on Sheet1. // To get an array of data source pivot tables for the entire // spreadsheet, replace 'sheet' with 'ss'. const dataSourcePivotTables = sheet.getDataSourcePivotTables(); // Logs the last time that the first pivot table in the array was refreshed. console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());
Renvois
DataSourcePivotTable[]
: liste de tableaux croisés dynamiques de sources de données.
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
getDataSourceTables()
Récupère toutes les tables de la source de données.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets an array of data source tables on Sheet1. // To get an array of data source tables for the entire spreadsheet, // replace 'sheet' with 'ss'. const dataSourceTables = sheet.getDataSourceTables(); // Logs the last completed data execution time on the first data source table. console.log(dataSourceTables[0].getStatus().getLastExecutionTime());
Renvois
DataSourceTable[]
: liste de tables de sources de données.
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
getDeveloperMetadata()
Obtenez toutes les métadonnées de développement associées à cette feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Adds developer metadata for testing. sheet.addDeveloperMetadata('CITY', 'PARIS'); // Gets all the developer metadata for the sheet. const developerMetaDataList = sheet.getDeveloperMetadata(); // Logs the developer metadata to the console. for (const developerMetaData of developerMetaDataList) { console.log(developerMetaData.getKey()); }
Renvois
DeveloperMetadata[]
: métadonnées du développeur associées à cette feuille.
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
getDrawings()
Renvoie un tableau de dessins sur la feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the drawings from the sheet. const allDrawings = sheet.getDrawings(); // Logs the number of drawings present on the sheet. console.log(allDrawings.length);
Renvois
Drawing[]
: liste des dessins de cette feuille.
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
getFilter()
Renvoie le filtre de cette feuille, ou null
s'il n'y a pas de filtre.
// Gets the filter on the active sheet. let ss = SpreadsheetApp.getActiveSheet(); let filter = ss.getFilter();
Renvois
Filter
: filtre.
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
getFormUrl()
Renvoie l'URL du formulaire qui envoie ses réponses à cette feuille, ou null
si cette feuille n'est associée à aucun formulaire.
var sheet = SpreadsheetApp.getActiveSheet(); var url = sheet.getFormUrl();
Renvois
String
: URL du formulaire qui place ses réponses dans cette feuille, ou null
si cette feuille n'est pas associée à un formulaire.
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
getFrozenColumns()
Renvoie le nombre de colonnes figées.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());
Renvois
Integer
: nombre de colonnes figées
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
getFrozenRows()
Renvoie le nombre de lignes figées.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());
Renvois
Integer
: nombre de lignes figées
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
getImages()
Renvoie toutes les images de la feuille superposées à la grille.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets spreadsheet, 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 the over-the-grid images from Sheet1. // To get the over-the-grid images from the entire spreadsheet, use ss.getImages() instead. const images = sheet.getImages(); // For each image, logs the anchor cell in A1 notation. for (const image of images) { console.log(image.getAnchorCell().getA1Notation()); }
Renvois
OverGridImage[]
: tableau d'images superposées à la grille.
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
getIndex()
Récupère la position de la feuille dans sa feuille de calcul parente. Commence à 1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); // Note that the JavaScript index is 0, but this logs 1 var sheet = ss.getSheets()[0]; // ... because spreadsheets are 1-indexed Logger.log(sheet.getIndex());
Renvois
Integer
: position de la feuille dans la feuille de calcul parente.
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
getLastColumn()
Renvoie la position de la dernière colonne comportant du contenu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
Renvois
Integer
: dernière colonne de la feuille comportant du contenu
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
getLastRow()
Renvoie la position de la dernière ligne comportant du contenu.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This logs the value in the very last cell of this sheet var lastRow = sheet.getLastRow(); var lastColumn = sheet.getLastColumn(); var lastCell = sheet.getRange(lastRow, lastColumn); Logger.log(lastCell.getValue());
Renvois
Integer
: dernière ligne de la feuille comportant du contenu
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
getMaxColumns()
Renvoie le nombre actuel de colonnes dans la feuille, quel que soit le contenu.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxColumns());
Renvois
Integer
: largeur maximale de la feuille.
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
getMaxRows()
Renvoie le nombre actuel de lignes dans la feuille, quel que soit le contenu.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); Logger.log(first.getMaxRows());
Renvois
Integer
: hauteur maximale de la feuille.
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
getName()
Renvoie le nom de la feuille.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getName());
Renvois
String
: nom de la feuille.
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
getNamedRanges()
Récupère toutes les plages nommées de cette feuille.
// The code below logs the name of the first named range. var namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges(); if (namedRanges.length > 1) { Logger.log(namedRanges[0].getName()); }
Renvois
NamedRange[]
: tableau de toutes les plages nommées de la feuille.
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
getParent()
Renvoie la valeur Spreadsheet
contenant cette feuille.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // parent is identical to ss var parent = sheet.getParent();
Renvois
Spreadsheet
: feuille de calcul parente.
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
getPivotTables()
Renvoie tous les tableaux croisés dynamiques de cette feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all the pivot table info for the sheet. const pivotTables = sheet.getPivotTables(); // Logs the pivot tables to the console. for (const pivotTable of pivotTables) { console.log(pivotTable.getSourceDataRange().getValues()); }
Renvois
PivotTable[]
: tableaux croisés dynamiques de cette feuille.
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
getProtections(type)
Récupère un tableau d'objets représentant toutes les plages protégées de la feuille, ou un tableau à un seul élément représentant la protection sur la feuille elle-même.
// Remove all range protections in the spreadsheet that the user has permission to edit. var sheet = SpreadsheetApp.getActiveSheet(); var protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE); for (var i = 0; i < protections.length; i++) { var protection = protections[i]; if (protection.canEdit()) { protection.remove(); } }
// Remove sheet protection from the active sheet, if the user has permission to edit it. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0]; if (protection && protection.canEdit()) { protection.remove(); }
Paramètres
Nom | Type | Description |
---|---|---|
type | ProtectionType | Type de zone protégée (SpreadsheetApp.ProtectionType.RANGE ou SpreadsheetApp.ProtectionType.SHEET ). |
Renvois
Protection[]
: tableau d'objets représentant toutes les plages protégées de la feuille, ou tableau à un seul élément représentant la protection sur la feuille elle-même.
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
getRange(row, column)
Renvoie la plage dont la cellule en haut à gauche aux coordonnées données.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Passing only two arguments returns a "range" with a single cell. var range = sheet.getRange(1, 1); var values = range.getValues(); Logger.log(values[0][0]);
Paramètres
Nom | Type | Description |
---|---|---|
row | Integer | Index de ligne de la cellule à renvoyer ; l'indexation des lignes commence par 1. |
column | Integer | Index de colonne de la cellule à renvoyer ; l'indexation de la colonne commence par 1. |
Renvois
Range
: plage ne contenant que cette cellule.
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
getRange(row, column, numRows)
Renvoie la plage avec la cellule en haut à gauche aux coordonnées données et avec le nombre de lignes indiqué.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // When the "numRows" argument is used, only a single column of data is returned. var range = sheet.getRange(1, 1, 3); var values = range.getValues(); // Prints 3 values from the first column, starting from row 1. for (var row in values) { for (var col in values[row]) { Logger.log(values[row][col]); } }
Paramètres
Nom | Type | Description |
---|---|---|
row | Integer | Index de première ligne de la plage ; l'indexation des lignes commence par 1. |
column | Integer | Index de colonne de la plage ; l'indexation de la colonne commence par 1. |
numRows | Integer | Nombre de lignes à afficher. |
Renvois
Range
: plage contenant une seule colonne de données avec le nombre de lignes spécifié.
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
getRange(row, column, numRows, numColumns)
Renvoie la plage avec la cellule en haut à gauche aux coordonnées données avec le nombre de lignes et de colonnes indiqué.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange(1, 1, 3, 3); var values = range.getValues(); // Print values from a 3x3 box. for (var row in values) { for (var col in values[row]) { Logger.log(values[row][col]); } }
Paramètres
Nom | Type | Description |
---|---|---|
row | Integer | Index de première ligne de la plage ; l'indexation des lignes commence par 1. |
column | Integer | Index de colonne de départ de la plage. L'indexation des colonnes commence par 1. |
numRows | Integer | Nombre de lignes à afficher. |
numColumns | Integer | Nombre de colonnes à afficher. |
Renvois
Range
: plage correspondant à la zone spécifié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
getRange(a1Notation)
Renvoie la plage telle qu'elle est spécifiée en notation A1 ou R1C1.
// Get a range A1:D4 on sheet titled "Invoices" var ss = SpreadsheetApp.getActiveSpreadsheet(); var range = ss.getRange("Invoices!A1:D4"); // Get cell A1 on the first sheet var sheet = ss.getSheets()[0]; var cell = sheet.getRange("A1");
Paramètres
Nom | Type | Description |
---|---|---|
a1Notation | String | Plage à afficher, telle que spécifiée en notation A1 ou R1C1. |
Renvois
Range
: plage de l'emplacement désigné
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
getRangeList(a1Notations)
Renvoie la collection RangeList
représentant les plages de la même feuille spécifiées par une liste non vide de notations A1 ou R1C1.
// Get a list of ranges A1:D4, F1:H4. var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);
Paramètres
Nom | Type | Description |
---|---|---|
a1Notations | String[] | Liste des plages à renvoyer, comme spécifié en notation A1 ou R1C1. |
Renvois
RangeList
: liste des plages à l'emplacement désigné
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
getRowGroup(rowIndex, groupDepth)
Renvoie le groupe de lignes à l'index et à la profondeur de groupe donnés.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Returns the group whose control index is at row 2 and has a depth of 1, or // null if the group doesn’t exist. var rowGroup = sheet.getRowGroup(2, 1);
Paramètres
Nom | Type | Description |
---|---|---|
rowIndex | Integer | Index de ligne du bouton d'activation de la commande de groupe ou d'un index du groupe. |
groupDepth | Integer | Profondeur du groupe. |
Renvois
Group
: groupe de lignes de l'index et de la profondeur de contrôle, ou génère une exception si le groupe n'existe pas.
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
getRowGroupControlPosition()
Renvoie la valeur GroupControlTogglePosition
pour tous les groupes de lignes de la feuille.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // GroupControlTogglePosition.AFTER if the row grouping control toggle is shown after the // group. var rowGroupControlPosition = sheet.getRowGroupControlPosition();
Renvois
GroupControlTogglePosition
: true
si le bouton d'activation du regroupement de lignes s'affiche après le groupe sur cette feuille, et false
dans le cas contraire.
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
getRowGroupDepth(rowIndex)
Renvoie la profondeur de groupe de la ligne au niveau de l'index donné.
La profondeur du groupe indique le nombre de groupes qui chevauchent la ligne. Cela peut aller de zéro à huit.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // 1 if there is a group over rows 1 through 3 var groupDepth = sheet.getRowGroupDepth(1);
Paramètres
Nom | Type | Description |
---|---|---|
rowIndex | Integer | Index de la ligne. |
Renvois
Integer
: profondeur de groupe de la ligne au niveau de l'index 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.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowHeight(rowPosition)
Récupère la hauteur, en pixels, de la ligne donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.getRowHeight(1));
Paramètres
Nom | Type | Description |
---|---|---|
rowPosition | Integer | Position de la ligne à examiner. |
Renvois
Integer
: hauteur de ligne en pixels
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.getActiveSpreadsheet().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
getSheetId()
Renvoie l'ID de la feuille représentée par cet objet.
Il s'agit d'un identifiant de feuille qui est propre à la feuille de calcul. L'ID est un nombre entier monotone croissant attribué au moment de la création de la feuille et indépendant de la position de la feuille. Cela est utile conjointement avec des méthodes telles que Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
qui utilisent un paramètre gridId
au lieu d'une instance Sheet
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetId());
Renvois
Integer
: ID de la feuille propre à la 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.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheetName()
Renvoie le nom de la feuille.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getSheetName());
Renvois
String
: nom de la feuille
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
getSheetValues(startRow, startColumn, numRows, numColumns)
Renvoie la grille rectangulaire des valeurs pour cette plage à partir des coordonnées données. Une valeur -1 indiquée comme position de ligne ou de colonne équivaut à obtenir la toute dernière ligne ou colonne contenant des données dans la feuille.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The two samples below produce the same output var values = sheet.getSheetValues(1, 1, 3, 3); Logger.log(values); var range = sheet.getRange(1, 1, 3, 3); values = range.getValues(); Logger.log(values);
Paramètres
Nom | Type | Description |
---|---|---|
startRow | Integer | Position de la première ligne. |
startColumn | Integer | Position de la colonne de départ. |
numRows | Integer | Nombre de lignes pour lesquelles renvoyer des valeurs. |
numColumns | Integer | Nombre de colonnes pour lesquelles renvoyer des valeurs. |
Renvois
Object[][]
: tableau de valeurs à deux dimensions
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
getSlicers()
Renvoie un tableau de segments sur la feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets all slicers in the spreadsheet. const slicers = sheet.getSlicers(); // Logs the slicer titles to the console. for (const slicer of slicers) { console.log(slicer.getTitle()); }
Renvois
Slicer[]
: liste des segments sur cette feuille.
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
getTabColorObject()
Récupère la couleur de l'onglet de la feuille ou null
si l'onglet de la feuille n'est pas coloré.
// This example assumes there is a sheet named "Sheet1" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = first.getTabColorObject();
Renvois
Color
: couleur de l'onglet de la feuille ou null
si l'onglet de la feuille n'est pas coloré.
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
getType()
Renvoie le type de la feuille.
Le type de feuille par défaut est SheetType.GRID
. Une feuille qui contient un seul objet intégré tel qu'un EmbeddedChart
est une feuille SheetType.OBJECT
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; Logger.log(sheet.getType());
Renvois
SheetType
: type de feuille.
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
hasHiddenGridlines()
Renvoie true
si le quadrillage de la feuille est masqué. Sinon, renvoie false
.
Le quadrillage est visible par défaut.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if the spreadsheet has hidden gridelines and logs the result to the console. console.log(sheet.hasHiddenGridlines());
Renvois
Boolean
: true
si le quadrillage est masqué, false
dans le cas contraire.
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
hideColumn(column)
Masque la ou les colonnes figurant dans la plage indiquée.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // This hides the first column let range = sheet.getRange("A1"); sheet.hideColumn(range); // This hides the first 3 columns let range = sheet.getRange("A:C"); sheet.hideColumn(range);
Paramètres
Nom | Type | Description |
---|---|---|
column | Range | Plage de colonnes à masquer. |
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
hideColumns(columnIndex)
Masque une seule colonne au niveau de l'index donné. Utilisez "1-index" pour cette méthode.
Pour masquer plusieurs colonnes à l'aide d'un index, utilisez hideColumns(columnIndex, numColumns)
.
Pour masquer plusieurs colonnes à l'aide d'une plage, utilisez hideColumn()
.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // Hides the first column sheet.hideColumns(1);
Paramètres
Nom | Type | Description |
---|---|---|
columnIndex | Integer | Index de la colonne à masquer. |
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
hideColumns(columnIndex, numColumns)
Masque une ou plusieurs colonnes consécutives à partir de l'index donné. Utilisez "1-index" pour cette méthode.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first three columns sheet.hideColumns(1, 3);
Paramètres
Nom | Type | Description |
---|---|---|
columnIndex | Integer | Index de départ des colonnes à masquer. |
numColumns | Integer | Nombre de colonnes à masquer. |
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
hideRow(row)
Masque les lignes de la plage donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This hides the first row var range = sheet.getRange("A1"); sheet.hideRow(range);
Paramètres
Nom | Type | Description |
---|---|---|
row | Range | Plage de lignes à masquer. |
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
hideRows(rowIndex)
Masque la ligne au niveau de l'index donné.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first row sheet.hideRows(1);
Paramètres
Nom | Type | Description |
---|---|---|
rowIndex | Integer | Index de la ligne à masquer. |
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
hideRows(rowIndex, numRows)
Masque une ou plusieurs lignes consécutives à partir de l'index donné.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Hides the first three rows sheet.hideRows(1, 3);
Paramètres
Nom | Type | Description |
---|---|---|
rowIndex | Integer | Index de départ des lignes à masquer. |
numRows | Integer | Nombre de lignes à masquer. |
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
hideSheet()
Masque cette feuille. N'a aucun effet si la feuille est déjà masquée. Si cette méthode est appelée sur la seule feuille visible, une exception est générée.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.hideSheet();
Renvois
Sheet
: 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
insertChart(chart)
Ajoute un nouveau graphique à cette feuille.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This creates a simple bar chart from the first three rows // of the first two columns of the spreadsheet var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange("A1:B4")) .setPosition(5, 5, 0, 0) .setOption("title", "Dynamic Chart") .build(); sheet.insertChart(chart);
Paramètres
Nom | Type | Description |
---|---|---|
chart | EmbeddedChart | Graphique à insérer. |
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
insertColumnAfter(afterPosition)
Insère une colonne après la position de colonne donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column after the first column position sheet.insertColumnAfter(1);
Paramètres
Nom | Type | Description |
---|---|---|
afterPosition | Integer | Colonne après laquelle la nouvelle colonne doit être ajoutée. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
insertColumnBefore(beforePosition)
Insère une colonne avant la position de colonne indiquée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a column in the first column position sheet.insertColumnBefore(1);
Paramètres
Nom | Type | Description |
---|---|---|
beforePosition | Integer | Colonne avant laquelle la nouvelle colonne doit être ajoutée. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
insertColumns(columnIndex)
Insère une colonne vide dans une feuille à l'emplacement spécifié.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all columns by one sheet.insertColumns(1);
Paramètres
Nom | Type | Description |
---|---|---|
columnIndex | Integer | Index indiquant où insérer une colonne. |
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
insertColumns(columnIndex, numColumns)
Insère une ou plusieurs colonnes vides consécutives dans une feuille à partir de l'emplacement spécifié.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all columns by three sheet.insertColumns(1, 3);
Paramètres
Nom | Type | Description |
---|---|---|
columnIndex | Integer | Index indiquant où insérer une colonne. |
numColumns | Integer | Nombre de colonnes à insérer. |
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
insertColumnsAfter(afterPosition, howMany)
Insère un nombre donné de colonnes après la position de colonne indiquée.
let ss = SpreadsheetApp.getActiveSpreadsheet(); let sheet = ss.getSheets()[0]; // Inserts two columns after the first column on the first sheet of the spreadsheet. sheet.insertColumnsAfter(1,2);
Paramètres
Nom | Type | Description |
---|---|---|
afterPosition | Integer | Colonne après laquelle la nouvelle colonne doit être ajoutée. |
howMany | Integer | Nombre de colonnes à insérer. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
insertColumnsBefore(beforePosition, howMany)
Insère un certain nombre de colonnes avant la position de colonne donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five columns before the first column sheet.insertColumnsBefore(1, 5);
Paramètres
Nom | Type | Description |
---|---|---|
beforePosition | Integer | Colonne avant laquelle la nouvelle colonne doit être ajoutée. |
howMany | Integer | Nombre de colonnes à insérer. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
insertImage(blobSource, column, row)
Insère un BlobSource
en tant qu'image dans le document, sur une ligne et une colonne données. La taille de l'image est récupérée à partir du contenu de l'objet blob. La taille maximale acceptée pour les blobs est de 2 Mo.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1);
Paramètres
Nom | Type | Description |
---|---|---|
blobSource | BlobSource | Objet blob contenant le contenu de l'image, le type MIME et (éventuellement) son nom. |
column | Integer | Position de la colonne. |
row | Integer | Position de la ligne. |
Renvois
OverGridImage
: image inséré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
insertImage(blobSource, column, row, offsetX, offsetY)
Insère un BlobSource
en tant qu'image dans le document sur une ligne et une colonne données, avec un décalage de pixel. La taille de l'image est extraite du contenu de l'objet blob. La taille maximale acceptée pour les objets blob est de 2 Mo.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName'); sheet.insertImage(blob, 1, 1, 10, 10);
Paramètres
Nom | Type | Description |
---|---|---|
blobSource | BlobSource | Objet blob contenant le contenu de l'image, le type MIME et (éventuellement) son nom. |
column | Integer | Position de la colonne. |
row | Integer | Position de la ligne. |
offsetX | Integer | Décalage horizontal à partir de l'angle de la cellule, en pixels. |
offsetY | Integer | Décalage vertical depuis l'angle de la cellule, en pixels. |
Renvois
OverGridImage
: image inséré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
insertImage(url, column, row)
Insère une image dans le document sur une ligne et une colonne données.
L'URL fournie doit être accessible au public.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);
Paramètres
Nom | Type | Description |
---|---|---|
url | String | URL de l'image |
column | Integer | Position de la colonne de la grille. |
row | Integer | Position des lignes de la grille. |
Renvois
OverGridImage
: image inséré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
insertImage(url, column, row, offsetX, offsetY)
Insère une image dans le document sur une ligne et une colonne données, avec un décalage de pixels.
L'URL fournie doit être accessible au public.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);
Paramètres
Nom | Type | Description |
---|---|---|
url | String | URL de l'image. |
column | Integer | Position de la colonne. |
row | Integer | Position de la ligne. |
offsetX | Integer | Décalage horizontal à partir de l'angle de la cellule, en pixels. |
offsetY | Integer | Décalage vertical depuis l'angle de la cellule, en pixels. |
Renvois
OverGridImage
: image inséré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
insertRowAfter(afterPosition)
Insère une ligne après la position de ligne indiquée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a row after the first row position sheet.insertRowAfter(1);
Paramètres
Nom | Type | Description |
---|---|---|
afterPosition | Integer | Ligne après laquelle la nouvelle ligne doit être ajoutée. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
insertRowBefore(beforePosition)
Insère une ligne avant la position de ligne indiquée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts a row before the first row position sheet.insertRowBefore(1);
Paramètres
Nom | Type | Description |
---|---|---|
beforePosition | Integer | Ligne avant laquelle la nouvelle ligne doit être ajoutée. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
insertRows(rowIndex)
Insère une ligne vide dans une feuille à l'emplacement spécifié.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all rows down by one sheet.insertRows(1);
Paramètres
Nom | Type | Description |
---|---|---|
rowIndex | Integer | Index indiquant où insérer une ligne. |
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
insertRows(rowIndex, numRows)
Insère une ou plusieurs lignes vides consécutives dans une feuille à partir de l'emplacement spécifié.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Shifts all rows down by three sheet.insertRows(1, 3);
Paramètres
Nom | Type | Description |
---|---|---|
rowIndex | Integer | Index indiquant où insérer une ligne. |
numRows | Integer | Nombre de lignes à insérer. |
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
insertRowsAfter(afterPosition, howMany)
Insère un certain nombre de lignes après la position de ligne donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five rows after the first row sheet.insertRowsAfter(1, 5);
Paramètres
Nom | Type | Description |
---|---|---|
afterPosition | Integer | Ligne après laquelle les nouvelles lignes doivent être ajoutées. |
howMany | Integer | Nombre de lignes à insérer. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
insertRowsBefore(beforePosition, howMany)
Insère un certain nombre de lignes avant la position de ligne donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This inserts five rows before the first row sheet.insertRowsBefore(1, 5);
Paramètres
Nom | Type | Description |
---|---|---|
beforePosition | Integer | Ligne avant laquelle les nouvelles lignes doivent être ajoutées. |
howMany | Integer | Nombre de lignes à insérer. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
insertSlicer(range, anchorRowPos, anchorColPos)
Ajoute un segment à cette feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range of the sheet. const range = sheet.getRange('A1:D10'); // Inserts the slicer with a random range into the sheet. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10); // Logs the insert slicer result to the console. console.log(insertSlicers);
Paramètres
Nom | Type | Description |
---|---|---|
range | Range | Plage dans laquelle le segment de segment est créé. |
anchorRowPos | Integer | Le côté supérieur du segment est ancré sur cette ligne. |
anchorColPos | Integer | La partie supérieure du segment est ancrée dans ce col. |
Renvois
Slicer
: segment nouvellement inséré.
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
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)
Ajoute un segment à cette feuille.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range. const range = sheet.getRange('A1:D10'); // Inserts a slicer using the random range function. const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0); // Logs the insert slicer result to the console. console.log(insertSlicers);
Paramètres
Nom | Type | Description |
---|---|---|
range | Range | Plage dans laquelle le segment de segment est créé. |
anchorRowPos | Integer | Le côté supérieur du segment est ancré sur cette ligne. |
anchorColPos | Integer | La partie supérieure du segment est ancrée dans ce col. |
offsetX | Integer | Décalage horizontal à partir de l'angle de la cellule, en pixels. |
offsetY | Integer | Décalage vertical depuis l'angle de la cellule, en pixels. |
Renvois
Slicer
: segment nouvellement inséré.
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
isColumnHiddenByUser(columnPosition)
Indique si la colonne donnée est masquée par l'utilisateur.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Columns start at 1 Logger.log(sheet.isColumnHiddenByUser(1));
Paramètres
Nom | Type | Description |
---|---|---|
columnPosition | Integer | Position de la colonne à examiner. |
Renvois
Boolean
: true
si la colonne est masquée, false
dans le cas contraire.
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
isRightToLeft()
Renvoie true
si la mise en page de cette feuille est de droite à gauche. Renvoie false
si la feuille utilise la mise en page par défaut de gauche à droite.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Checks if a spreadsheet is ordered from right to left and logs the result to the console. console.log(sheet.isRightToLeft());
Renvois
Boolean
: true
pour l'orientation de droite à gauche, false
dans le cas contraire.
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
isRowHiddenByFilter(rowPosition)
Indique si la ligne donnée est masquée par un filtre (et non par une vue filtrée).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByFilter(1));
Paramètres
Nom | Type | Description |
---|---|---|
rowPosition | Integer | Position de la ligne à examiner. |
Renvois
Boolean
: true
si la ligne est masquée, false
dans le cas contraire.
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
isRowHiddenByUser(rowPosition)
Indique si la ligne donnée est masquée par l'utilisateur.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Rows start at 1 Logger.log(sheet.isRowHiddenByUser(1));
Paramètres
Nom | Type | Description |
---|---|---|
rowPosition | Integer | Position de la ligne à examiner. |
Renvois
Boolean
: true
si la ligne est masquée, false
dans le cas contraire.
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
isSheetHidden()
Renvoie la valeur true
si la feuille est actuellement masquée.
var sheet = SpreadsheetApp.getActiveSheet(); if (sheet.isSheetHidden()) { // do something... }
Renvois
Boolean
: true
si la feuille est masquée, false
dans le cas contraire.
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
moveColumns(columnSpec, destinationIndex)
Déplace les colonnes sélectionnées par la plage donnée vers la position indiquée par destinationIndex
. L'élément columnSpec
lui-même ne doit pas nécessairement représenter exactement une colonne entière ou un groupe de colonnes à déplacer. Il sélectionne toutes les colonnes comprises dans la plage.
// The code below moves rows A-B to destination index 5. // This results in those columns becoming columns C-D. var sheet = SpreadsheetApp.getActiveSheet(); // Selects column A and column B to be moved. var columnSpec = sheet.getRange("A1:B1"); sheet.moveColumns(columnSpec, 5);
Paramètres
Nom | Type | Description |
---|---|---|
columnSpec | Range | Une plage couvrant les colonnes à déplacer. |
destinationIndex | Integer | Index vers lequel les colonnes doivent être déplacées Notez que cet index est basé sur les coordonnées avant le déplacement des colonnes. Les données existantes sont décalées vers la droite pour laisser de la place aux colonnes déplacées tandis que les colonnes sources sont supprimées de la grille. Par conséquent, les données peuvent se retrouver à un indice différent de celui spécifié au départ. |
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
moveRows(rowSpec, destinationIndex)
Déplace les lignes sélectionnées par la plage donnée vers la position indiquée par destinationIndex
. L'élément rowSpec
lui-même ne doit pas nécessairement représenter exactement une ligne entière ou un groupe de lignes à déplacer. Il sélectionne toutes les lignes couvertes par la plage.
// The code below moves rows 1-2 to destination index 5. // This results in those rows becoming rows 3-4. var sheet = SpreadsheetApp.getActiveSheet(); // Selects row 1 and row 2 to be moved. var rowSpec = sheet.getRange("A1:A2"); sheet.moveRows(rowSpec, 5);
Paramètres
Nom | Type | Description |
---|---|---|
rowSpec | Range | Une plage couvrant les lignes à déplacer. |
destinationIndex | Integer | Index vers lequel les lignes doivent être déplacées Notez que cet indice est basé sur les coordonnées avant le déplacement des lignes. Les données existantes sont décalées vers le bas pour faire de la place pour les lignes déplacées pendant que les lignes sources sont supprimées de la grille. Par conséquent, les données peuvent se retrouver à un indice différent de celui spécifié au départ. |
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
newChart()
Affiche un compilateur permettant de créer un graphique pour cette feuille.
Cet exemple montre comment créer un graphique:
var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("A1:B8"); var chartBuilder = sheet.newChart(); chartBuilder.addRange(range) .setChartType(Charts.ChartType.LINE) .setPosition(2, 2, 0, 0) .setOption('title', 'My Line Chart!'); sheet.insertChart(chartBuilder.build());
Renvois
EmbeddedChartBuilder
: outil permettant de créer un graphique.
protect()
Crée un objet qui peut empêcher la modification de la feuille, sauf par les utilisateurs disposant de l'autorisation requise. Tant que le script ne modifie pas la liste des éditeurs de la feuille (en appelant Protection.removeEditor(emailAddress)
, Protection.removeEditor(user)
, Protection.removeEditors(emailAddresses)
, Protection.addEditor(emailAddress)
, Protection.addEditor(user)
, Protection.addEditors(emailAddresses)
ou en définissant une nouvelle valeur pour Protection.setDomainEdit(editable)
), les autorisations reflètent celles de la feuille de calcul elle-même, ce qui signifie que la feuille n'est pas protégée. Si la feuille est déjà protégée, cette méthode renvoie un objet représentant ses paramètres de protection existants.
Une feuille protégée peut inclure des zones non protégées.
// Protect the active sheet, then remove all other users from the list of editors. var sheet = SpreadsheetApp.getActiveSheet(); var protection = sheet.protect().setDescription('Sample protected sheet'); // Ensure the current user is an editor before removing others. Otherwise, if the user's edit // permission comes from a group, the script throws an exception upon removing the group. var me = Session.getEffectiveUser(); protection.addEditor(me); protection.removeEditors(protection.getEditors()); if (protection.canDomainEdit()) { protection.setDomainEdit(false); }
Renvois
Protection
: objet représentant les paramètres de protection.
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
removeChart(chart)
Supprime un graphique de la feuille parente.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This removes all the embedded charts from the spreadsheet var charts = sheet.getCharts(); for (var i in charts) { sheet.removeChart(charts[i]); }
Paramètres
Nom | Type | Description |
---|---|---|
chart | EmbeddedChart | Graphique à supprimer. |
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
setActiveRange(range)
Définit la plage spécifiée comme active range
dans la feuille active, avec la cellule supérieure gauche de la plage en tant que current cell
.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var range = sheet.getRange('A1:D4'); sheet.setActiveRange(range); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D4 var activeRange = selection.getActiveRange();
Paramètres
Nom | Type | Description |
---|---|---|
range | Range | Plage à définir comme plage active. |
Renvois
Range
: nouvelle 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
setActiveRangeList(rangeList)
Définit la liste des plages spécifiée comme active ranges
dans la feuille active. La dernière plage de la liste est définie en tant que active range
.
var sheet = SpreadsheetApp.getActiveSheet(); var rangeList = sheet.getRangeList(['D4', 'B2:C4']); sheet.setActiveRangeList(rangeList); var selection = sheet.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
setActiveSelection(range)
Définit la région de sélection active pour cette feuille.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D4"); sheet.setActiveSelection(range);
Paramètres
Nom | Type | Description |
---|---|---|
range | Range | Plage à définir comme sélection active. |
Renvois
Range
: nouvelle 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
setActiveSelection(a1Notation)
Définit la sélection active, selon la notation A1 ou R1C1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.setActiveSelection("A1:D4");
Paramètres
Nom | Type | Description |
---|---|---|
a1Notation | String | Plage à définir comme active, comme spécifié en notation A1 ou R1C1. |
Renvois
Range
: nouvelle 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
setColumnGroupControlPosition(position)
Définit la position du bouton d'activation des commandes de groupe de colonnes sur la feuille.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setColumnGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);
Paramètres
Nom | Type | Description |
---|---|---|
position | GroupControlTogglePosition | Position du bouton d'activation des commandes des groupes de colonnes. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setColumnWidth(columnPosition, width)
Définit la largeur de la colonne donnée en pixels.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first column to a width of 200 pixels sheet.setColumnWidth(1, 200);
Paramètres
Nom | Type | Description |
---|---|---|
columnPosition | Integer | Position à définir de la colonne donnée. |
width | Integer | Largeur en pixels à appliquer. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
setColumnWidths(startColumn, numColumns, width)
Définit la largeur des colonnes indiquées en pixels.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three columns to a width of 200 pixels sheet.setColumnWidths(1, 3, 200);
Paramètres
Nom | Type | Description |
---|---|---|
startColumn | Integer | Position de départ de la colonne à modifier. |
numColumns | Integer | Nombre de colonnes à modifier. |
width | Integer | Largeur en pixels à appliquer. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setConditionalFormatRules(rules)
Remplace toutes les règles de mise en forme conditionnelle existantes de la feuille par les règles de saisie. Les règles sont évaluées dans l'ordre dans lequel elles ont été saisies.
// Remove one of the existing conditional format rules. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); rules.splice(1, 1); // Deletes the 2nd format rule. sheet.setConditionalFormatRules(rules);
Paramètres
Nom | Type | Description |
---|---|---|
rules | ConditionalFormatRule[] | Nouvelles règles de mise en forme conditionnelle. |
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
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, toute 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 seule cellule. Sinon, une exception sera générée.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet(); var cell = sheet.getRange('B5'); sheet.setCurrentCell(cell); var selection = sheet.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
setFrozenColumns(columns)
Gèle le nombre donné de colonnes. Si la valeur est zéro, aucune colonne n'est figée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Freezes the first column sheet.setFrozenColumns(1);
Paramètres
Nom | Type | Description |
---|---|---|
columns | Integer | Nombre de colonnes à figer. |
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
setFrozenRows(rows)
Figer le nombre donné de lignes. Si la valeur est zéro, aucune ligne n'est figée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Freezes the first row sheet.setFrozenRows(1);
Paramètres
Nom | Type | Description |
---|---|---|
rows | Integer | Nombre de lignes à figer. |
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
setHiddenGridlines(hideGridlines)
Masque ou affiche le quadrillage de la feuille.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Gets a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Hides the gridlines in the sheet. sheet.setHiddenGridlines(true);
Paramètres
Nom | Type | Description |
---|---|---|
hideGridlines | Boolean | Si la valeur est true , masquez le quadrillage dans cette feuille. Sinon, affichez le quadrillage. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setName(name)
Définit le nom de la feuille.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.setName("not first anymore");
Paramètres
Nom | Type | Description |
---|---|---|
name | String | Nouveau nom de la feuille. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setRightToLeft(rightToLeft)
Définit ou désactive la mise en page de la feuille de droite à gauche.
// 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 a sheet by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets the sheet layout, so that the sheet is ordered from right to left. sheet.setRightToLeft(true);
Paramètres
Nom | Type | Description |
---|---|---|
rightToLeft | Boolean | Si la valeur est true , la mise en page de la feuille est définie de droite à gauche, avec la cellule A1 dans l'angle supérieur droit. Si la valeur est false , la mise en page de la feuille est définie sur la mise en page par défaut de gauche à droite, avec la cellule A1 en haut à gauche. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setRowGroupControlPosition(position)
Définit la position du bouton d'activation du groupe de lignes sur la feuille.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; sheet.setRowGroupControlPosition(SpreadsheetApp.GroupControlTogglePosition.AFTER);
Paramètres
Nom | Type | Description |
---|---|---|
position | GroupControlTogglePosition | Position du bouton d'activation du groupe de lignes. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setRowHeight(rowPosition, height)
Définit la hauteur de la ligne donnée en pixels. Par défaut, les lignes s'agrandissent pour s'adapter au contenu des cellules. Si vous souhaitez forcer les lignes à une hauteur spécifiée, utilisez setRowHeightsForced(startRow, numRows, height)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first row to a height of 200 pixels sheet.setRowHeight(1, 200);
Paramètres
Nom | Type | Description |
---|---|---|
rowPosition | Integer | Position de la ligne à modifier. |
height | Integer | Hauteur en pixels à laquelle le définir. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes.
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
setRowHeights(startRow, numRows, height)
Définit la hauteur des lignes indiquées en pixels. Par défaut, les lignes s'agrandissent pour s'adapter au contenu des cellules. Si vous souhaitez forcer les lignes à une hauteur spécifiée, utilisez setRowHeightsForced(startRow, numRows, height)
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 20 pixels sheet.setRowHeights(1, 3, 20);
Paramètres
Nom | Type | Description |
---|---|---|
startRow | Integer | Position de la ligne de départ à modifier. |
numRows | Integer | Nombre de lignes à modifier. |
height | Integer | Hauteur en pixels à laquelle le définir. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setRowHeightsForced(startRow, numRows, height)
Définit la hauteur des lignes indiquées en pixels. Par défaut, les lignes s'agrandissent pour s'adapter au contenu des cellules. Lorsque vous utilisez setRowHeightsForced
, les lignes sont forcées à la hauteur spécifiée, même si le contenu des cellules est plus grand que la hauteur de la ligne.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sets the first three rows to a height of 5 pixels. sheet.setRowHeightsForced(1, 3, 5);
Paramètres
Nom | Type | Description |
---|---|---|
startRow | Integer | Position de la ligne de départ à modifier. |
numRows | Integer | Nombre de lignes à modifier. |
height | Integer | Hauteur en pixels à laquelle le définir. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setTabColor(color)
Définit la couleur des onglets de la feuille.
// This example assumes there is a sheet named "first" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("first"); first.setTabColor("ff0000"); // Set the color to red. first.setTabColor(null); // Unset the color.
Paramètres
Nom | Type | Description |
---|---|---|
color | String | Code couleur en notation CSS (comme '#ffffff' ou 'white' ), ou null pour réinitialiser la couleur de l'onglet. |
Renvois
Sheet
: feuille, pour le chaînage.
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
setTabColorObject(color)
Définit la couleur des onglets de la feuille.
// This example assumes there is a sheet named "Sheet1" var ss = SpreadsheetApp.getActiveSpreadsheet(); var first = ss.getSheetByName("Sheet1"); var color = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); first.setTabColorObject(color); // Set the color to theme accent 1. first.setTabColorObject(null); // Unset the color.
Paramètres
Nom | Type | Description |
---|---|---|
color | Color | Couleur de l'onglet de la feuille à définir. |
Renvois
Sheet
: feuille, pour le chaînage.
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
showColumns(columnIndex)
Affiche la colonne au niveau de l'index donné.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first column sheet.showColumns(1);
Paramètres
Nom | Type | Description |
---|---|---|
columnIndex | Integer | Index de la colonne à afficher. |
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
showColumns(columnIndex, numColumns)
Affiche une ou plusieurs colonnes consécutives à partir de l'index donné.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first three columns sheet.showColumns(1, 3);
Paramètres
Nom | Type | Description |
---|---|---|
columnIndex | Integer | Index de départ des colonnes à afficher. |
numColumns | Integer | Nombre de colonnes à afficher. |
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
showRows(rowIndex)
Affiche la ligne au niveau de l'index donné.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first row sheet.showRows(1);
Paramètres
Nom | Type | Description |
---|---|---|
rowIndex | Integer | Index de la ligne à afficher. |
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
showRows(rowIndex, numRows)
Affiche une ou plusieurs lignes consécutives à partir de l'index donné.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Unhides the first three rows sheet.showRows(1, 3);
Paramètres
Nom | Type | Description |
---|---|---|
rowIndex | Integer | Index de départ des lignes à afficher. |
numRows | Integer | Nombre de lignes à afficher. |
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
showSheet()
Rend la feuille visible. N'a aucun effet si la feuille est déjà visible.
var sheet = SpreadsheetApp.getActiveSheet(); sheet.showSheet();
Renvois
Sheet
: 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
sort(columnPosition)
Trie une feuille par colonne, dans l’ordre croissant.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, ascending sheet.sort(1);
Paramètres
Nom | Type | Description |
---|---|---|
columnPosition | Integer | Colonne utilisée pour le tri. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
sort(columnPosition, ascending)
Trie une feuille par colonne. Utilise un paramètre pour spécifier l'ordre croissant ou décroissant.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // Sorts the sheet by the first column, descending sheet.sort(1, false);
Paramètres
Nom | Type | Description |
---|---|---|
columnPosition | Integer | Colonne utilisée pour le tri. |
ascending | Boolean | true pour les tris croissants, false pour les tris décroissants. |
Renvois
Sheet
: feuille, utile pour le chaînage de méthodes
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
unhideColumn(column)
Affiche la colonne dans la plage donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This unhides the first column if it was previously hidden var range = sheet.getRange("A1"); sheet.unhideColumn(range);
Paramètres
Nom | Type | Description |
---|---|---|
column | Range | Plage à afficher, si elle est masqué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
unhideRow(row)
Affiche la ligne dans la plage donnée.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This unhides the first row if it was previously hidden var range = sheet.getRange("A1"); sheet.unhideRow(range);
Paramètres
Nom | Type | Description |
---|---|---|
row | Range | Plage à afficher, si elle est masqué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
updateChart(chart)
Met à jour le graphique sur cette feuille.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This code is going to loop through all the charts and change them to // column charts var charts = sheet.getCharts(); for (var i in charts) { var chart = charts[i]; var newChart = chart .modify() .setChartType(Charts.ChartType.COLUMN) .build(); sheet.updateChart(newChart); }
Paramètres
Nom | Type | Description |
---|---|---|
chart | EmbeddedChart | Graphique à mettre à jour. |
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