Cette page a été traduite par l'API Cloud Translation.

Class Range

accéder aux plages des feuilles de calcul et les modifier ; Une plage peut être une cellule unique dans une feuille ou un groupe de cellules adjacentes dans une feuille.

Méthodes

Méthode	Type renvoyé	Brève description
`activate()`	`Range`	Définit la plage spécifiée en tant que `active range`, la cellule supérieure gauche de la plage étant `current cell`.
`activateAsCurrentCell()`	`Range`	Définit la cellule spécifiée en tant que `current cell`.
`addDeveloperMetadata(key)`	`Range`	Ajoute à la plage des métadonnées de développement avec la clé spécifiée.
`addDeveloperMetadata(key, visibility)`	`Range`	Ajoute des métadonnées de développement avec la clé spécifiée et la visibilité à la plage.
`addDeveloperMetadata(key, value)`	`Range`	Ajoute à la plage des métadonnées de développement avec la clé et la valeur spécifiées.
`addDeveloperMetadata(key, value, visibility)`	`Range`	Ajoute des métadonnées de développement avec la clé, la valeur et la visibilité spécifiées à la plage.
`applyColumnBanding()`	`Banding`	Applique un thème de bandes de colonnes par défaut à la plage.
`applyColumnBanding(bandingTheme)`	`Banding`	Applique un thème de bandes de colonnes spécifié à la plage.
`applyColumnBanding(bandingTheme, showHeader, showFooter)`	`Banding`	Applique un thème de bandes de colonnes spécifié à la plage dont les paramètres d'en-tête et de pied de page sont spécifiés.
`applyRowBanding()`	`Banding`	Applique un thème de bandes de lignes par défaut à la plage.
`applyRowBanding(bandingTheme)`	`Banding`	Applique un thème de bandes de lignes spécifié à la plage.
`applyRowBanding(bandingTheme, showHeader, showFooter)`	`Banding`	Applique un thème de bandes de lignes spécifié à la plage avec des paramètres d'en-tête et de pied de page spécifiés.
`autoFill(destination, series)`	`void`	Remplis le `destinationRange` avec des données basées sur les données de cette plage.
`autoFillToNeighbor(series)`	`void`	Calcule une plage à remplir avec de nouvelles données en fonction des cellules voisines, puis la remplit automatiquement avec de nouvelles valeurs en fonction des données qu'elle contient.
`breakApart()`	`Range`	Divisez à nouveau les cellules à plusieurs colonnes de la plage en cellules individuelles.
`canEdit()`	`Boolean`	Détermine si l'utilisateur est autorisé ou non à modifier chaque cellule de la plage.
`check()`	`Range`	Modifie l'état des cases à cocher de la plage sur "cochées".
`clear()`	`Range`	Efface la plage de contenus et de formats.
`clear(options)`	`Range`	Efface la plage de contenus, le format, les règles de validation des données et/ou les commentaires, comme spécifié avec les options avancées données.
`clearContent()`	`Range`	Efface le contenu de la plage, sans modifier la mise en forme.
`clearDataValidations()`	`Range`	Efface les règles de validation des données pour la plage.
`clearFormat()`	`Range`	Efface la mise en forme de cette plage.
`clearNote()`	`Range`	Efface la note dans la ou les cellules spécifiées.
`collapseGroups()`	`Range`	Réduit tous les groupes entièrement contenus dans la plage.
`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copiez la mise en forme de la plage à l'emplacement indiqué.
`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copiez la mise en forme de la plage à l'emplacement indiqué.
`copyTo(destination)`	`void`	Copie les données d'une plage de cellules vers une autre plage de cellules.
`copyTo(destination, copyPasteType, transposed)`	`void`	Copie les données d'une plage de cellules vers une autre plage de cellules.
`copyTo(destination, options)`	`void`	Copie les données d'une plage de cellules vers une autre plage de cellules.
`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copier le contenu de la plage à l'emplacement indiqué.
`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copier le contenu de la plage à l'emplacement indiqué.
`createDataSourcePivotTable(dataSource)`	`DataSourcePivotTable`	Crée un tableau croisé dynamique de source de données vide à partir de la source de données, ancré à la première cellule de cette plage.
`createDataSourceTable(dataSource)`	`DataSourceTable`	Crée une table de source de données vide à partir de la source de données, ancrée à la première cellule de cette plage.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Renvoie une DeveloperMetadataFinderApi pour la recherche de métadonnées de développeur dans le champ d'application de cette plage.
`createFilter()`	`Filter`	Crée un filtre et l'applique à la plage spécifiée dans la feuille.
`createPivotTable(sourceData)`	`PivotTable`	Crée un tableau croisé dynamique vide à partir de la valeur `sourceData` spécifiée, ancré à la première cellule de cette plage.
`createTextFinder(findText)`	`TextFinder`	Crée un outil de recherche de texte pour la plage, qui peut rechercher et remplacer du texte dans cette plage.
`deleteCells(shiftDimension)`	`void`	Supprime cette plage de cellules.
`expandGroups()`	`Range`	Développe les groupes réduits dont le bouton d'activation de plage ou de commande présente une intersection avec cette plage.
`getA1Notation()`	`String`	Renvoie une description de la plage sous forme de chaîne, au format A1.
`getBackground()`	`String`	Renvoie la couleur d'arrière-plan de la cellule en haut à gauche de la plage (par exemple, `'#ffffff'`).
`getBackgroundObject()`	`Color`	Renvoie la couleur d'arrière-plan de la cellule en haut à gauche de la plage.
`getBackgroundObjects()`	`Color[][]`	Renvoie les couleurs d'arrière-plan des cellules de la plage.
`getBackgrounds()`	`String[][]`	Renvoie les couleurs d'arrière-plan des cellules de la plage (par exemple, `'#ffffff'`).
`getBandings()`	`Banding[]`	Renvoie toutes les bandes appliquées aux cellules de cette plage.
`getCell(row, column)`	`Range`	Renvoie une cellule donnée dans une plage.
`getColumn()`	`Integer`	Renvoie la position de départ de la colonne pour cette plage.
`getDataRegion()`	`Range`	Renvoie une copie de la plage étendue dans les quatre `Direction` cardinaux pour couvrir toutes les cellules adjacentes contenant des données.
`getDataRegion(dimension)`	`Range`	Renvoie une copie de la plage étendue `Direction.UP` et `Direction.DOWN` si la dimension spécifiée est `Dimension.ROWS`, ou `Direction.NEXT` et `Direction.PREVIOUS` si la dimension est `Dimension.COLUMNS`.
`getDataSourceFormula()`	`DataSourceFormula`	Renvoie la valeur `DataSourceFormula` pour la première cellule de la plage, ou `null` si la cellule ne contient pas de formule de source de données.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Renvoie les valeurs `DataSourceFormula` des cellules de la plage.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Récupère tous les tableaux croisés dynamiques de sources de données présentant une intersection avec la plage.
`getDataSourceTables()`	`DataSourceTable[]`	Récupère toutes les tables de sources de données qui présentent une intersection avec la plage.
`getDataSourceUrl()`	`String`	Renvoie une URL pour les données de cette plage, qui peut être utilisée pour créer des graphiques et des requêtes.
`getDataTable()`	`DataTable`	Renvoyez les données contenues dans cet objet en tant que DataTable.
`getDataTable(firstRowIsHeader)`	`DataTable`	Renvoyez les données de cette plage en tant que DataTable.
`getDataValidation()`	`DataValidation`	Renvoie la règle de validation des données pour la cellule supérieure gauche de la plage.
`getDataValidations()`	`DataValidation[][]`	Affiche les règles de validation des données pour toutes les cellules de la plage.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Récupère les métadonnées de développement associées à cette plage.
`getDisplayValue()`	`String`	Renvoie la valeur affichée de la cellule supérieure gauche de la plage.
`getDisplayValues()`	`String[][]`	Renvoie la grille rectangulaire de valeurs pour cette plage.
`getFilter()`	`Filter`	Renvoie le filtre sur la feuille à laquelle cette plage appartient, ou `null` si la feuille ne contient pas de filtre.
`getFontColorObject()`	`Color`	Renvoie la couleur de police de la cellule dans le coin supérieur gauche de la plage.
`getFontColorObjects()`	`Color[][]`	Renvoie les couleurs de police des cellules de la plage.
`getFontFamilies()`	`String[][]`	Renvoie les familles de polices des cellules de la plage.
`getFontFamily()`	`String`	Renvoie la famille de polices de la cellule dans le coin supérieur gauche de la plage.
`getFontLine()`	`String`	Récupère le style de ligne de la cellule située dans l'angle supérieur gauche de la plage (`'underline'`, `'line-through'` ou `'none'`).
`getFontLines()`	`String[][]`	Récupère le style de ligne des cellules de la plage (`'underline'`, `'line-through'` ou `'none'`).
`getFontSize()`	`Integer`	Renvoie la taille de la police en points de la cellule située dans l'angle supérieur gauche de la plage.
`getFontSizes()`	`Integer[][]`	Renvoie les tailles de police des cellules de la plage.
`getFontStyle()`	`String`	Renvoie le style de police (`'italic'` ou `'normal'`) de la cellule dans l'angle supérieur gauche de la plage.
`getFontStyles()`	`String[][]`	Renvoie les styles de police des cellules de la plage.
`getFontWeight()`	`String`	Renvoie l'épaisseur de la police (normal/gras) de la cellule dans l'angle supérieur gauche de la plage.
`getFontWeights()`	`String[][]`	Renvoie l'épaisseur de police des cellules de la plage.
`getFormula()`	`String`	Renvoie la formule (notation A1) de la cellule supérieure gauche de la plage, ou une chaîne vide si la cellule est vide ou ne contient pas de formule.
`getFormulaR1C1()`	`String`	Renvoie la formule (notation R1C1) pour une cellule donnée, ou `null` si aucune.
`getFormulas()`	`String[][]`	Renvoie les formules (notation A1) des cellules dans la plage.
`getFormulasR1C1()`	`String[][]`	Renvoie les formules (notation R1C1) des cellules dans la plage.
`getGridId()`	`Integer`	Renvoie l'ID de grille de la feuille parente de la plage.
`getHeight()`	`Integer`	Renvoie la hauteur de la plage.
`getHorizontalAlignment()`	`String`	Renvoie l'alignement horizontal du texte (à gauche/au centre/à droite) de la cellule dans l'angle supérieur gauche de la plage.
`getHorizontalAlignments()`	`String[][]`	Renvoie les alignements horizontaux des cellules de la plage.
`getLastColumn()`	`Integer`	Renvoie la position de fin de la colonne.
`getLastRow()`	`Integer`	Renvoie la position de la ligne de fin.
`getMergedRanges()`	`Range[]`	Renvoie un tableau d'objets `Range` représentant des cellules fusionnées qui sont entièrement dans la plage actuelle ou qui contiennent au moins une cellule de la plage actuelle.
`getNextDataCell(direction)`	`Range`	En commençant par la cellule de la première colonne et de la première ligne de la plage, elle renvoie la cellule suivante dans la direction donnée, à savoir le bord d'une plage contiguë de cellules contenant des données ou la cellule située au bord de la feuille de calcul dans cette direction.
`getNote()`	`String`	Renvoie la note associée à la plage donnée.
`getNotes()`	`String[][]`	Affiche les notes associées aux cellules de la plage.
`getNumColumns()`	`Integer`	Renvoie le nombre de colonnes dans cette plage.
`getNumRows()`	`Integer`	Renvoie le nombre de lignes dans cette plage.
`getNumberFormat()`	`String`	Permet d'obtenir le format des nombres ou des dates dans la cellule supérieure gauche de la plage donnée.
`getNumberFormats()`	`String[][]`	Renvoie le format numérique ou de date des cellules dans la plage.
`getRichTextValue()`	`RichTextValue`	Renvoie la valeur de texte enrichi de la cellule supérieure gauche de la plage ou `null` si la valeur de la cellule n'est pas du texte.
`getRichTextValues()`	`RichTextValue[][]`	Renvoie les valeurs de texte enrichi des cellules dans la plage.
`getRow()`	`Integer`	Renvoie la position de la ligne pour cette plage.
`getRowIndex()`	`Integer`	Renvoie la position de la ligne pour cette plage.
`getSheet()`	`Sheet`	Renvoie la feuille à laquelle cette plage appartient.
`getTextDirection()`	`TextDirection`	Renvoie l'orientation du texte de la cellule supérieure gauche de la plage.
`getTextDirections()`	`TextDirection[][]`	Renvoie le sens du texte des cellules de la plage.
`getTextRotation()`	`TextRotation`	Renvoie les paramètres de rotation du texte pour la cellule supérieure gauche de la plage.
`getTextRotations()`	`TextRotation[][]`	Renvoie les paramètres de rotation du texte pour les cellules de la plage.
`getTextStyle()`	`TextStyle`	Renvoie le style de texte de la cellule supérieure gauche de la plage.
`getTextStyles()`	`TextStyle[][]`	Renvoie les styles de texte des cellules de la plage.
`getValue()`	`Object`	Renvoie la valeur de la cellule supérieure gauche de la plage.
`getValues()`	`Object[][]`	Renvoie la grille rectangulaire de valeurs pour cette plage.
`getVerticalAlignment()`	`String`	Renvoie l'alignement vertical (haut/milieu/bas) de la cellule dans l'angle supérieur gauche de la plage.
`getVerticalAlignments()`	`String[][]`	Renvoie les alignements verticaux des cellules de la plage.
`getWidth()`	`Integer`	Renvoie la largeur de la plage en colonnes.
`getWrap()`	`Boolean`	Indique si le texte contenu dans la cellule doit être renvoyé à la ligne.
`getWrapStrategies()`	`WrapStrategy[][]`	Renvoie les stratégies de retour automatique à la ligne pour les cellules de la plage.
`getWrapStrategy()`	`WrapStrategy`	Renvoie la stratégie de retour à la ligne automatique pour la cellule supérieure gauche de la plage.
`getWraps()`	`Boolean[][]`	Indique si le texte contenu dans les cellules est renvoyé à la ligne.
`insertCells(shiftDimension)`	`Range`	Insère des cellules vides dans cette plage.
`insertCheckboxes()`	`Range`	Insère des cases à cocher dans chaque cellule de la plage, configurées avec `true` pour les cases cochées et `false` pour les cases non cochées.
`insertCheckboxes(checkedValue)`	`Range`	Insère des cases à cocher dans chaque cellule de la plage, configurées avec une valeur personnalisée pour "coché" et la chaîne vide pour "décochée".
`insertCheckboxes(checkedValue, uncheckedValue)`	`Range`	Insère des cases à cocher dans chaque cellule de la plage, configurées avec des valeurs personnalisées pour les états cochés et non cochés.
`isBlank()`	`Boolean`	Renvoie `true` si la plage est totalement vide.
`isChecked()`	`Boolean`	Indique si toutes les cellules de la plage sont cochées.
`isEndColumnBounded()`	`Boolean`	Détermine si la fin de la plage est liée à une colonne spécifique.
`isEndRowBounded()`	`Boolean`	Détermine si la fin de la plage est liée à une ligne spécifique.
`isPartOfMerge()`	`Boolean`	Renvoie `true` si les cellules de la plage actuelle chevauchent des cellules fusionnées.
`isStartColumnBounded()`	`Boolean`	Détermine si le début de la plage est lié à une colonne spécifique.
`isStartRowBounded()`	`Boolean`	Détermine si le début de la plage est lié à une ligne spécifique.
`merge()`	`Range`	Fusionne les cellules de la plage en un seul bloc.
`mergeAcross()`	`Range`	Fusionne les cellules de la plage dans les colonnes de la plage.
`mergeVertically()`	`Range`	Fusionne les cellules de la plage.
`moveTo(target)`	`void`	Coupez et collez (format et valeurs) de cette plage dans la plage cible.
`offset(rowOffset, columnOffset)`	`Range`	Renvoie une nouvelle plage qui est décalée par rapport au nombre donné de lignes et de colonnes (qui peut être négatif).
`offset(rowOffset, columnOffset, numRows)`	`Range`	Renvoie une nouvelle plage relative à la plage actuelle, dont le point supérieur gauche est décalé par rapport à la plage actuelle par les lignes et colonnes données, et par la hauteur indiquée en cellules.
`offset(rowOffset, columnOffset, numRows, numColumns)`	`Range`	Renvoie une nouvelle plage relative à la plage actuelle, dont le point supérieur gauche est décalé par rapport à la plage actuelle par les lignes et colonnes données, et par la hauteur et la largeur données en cellules.
`protect()`	`Protection`	Crée un objet pouvant empêcher la modification de la plage d'être modifiée, sauf par les utilisateurs autorisés.
`randomize()`	`Range`	Donne l'ordre des lignes de façon aléatoire dans la plage donnée.
`removeCheckboxes()`	`Range`	Supprime toutes les cases à cocher de la plage.
`removeDuplicates()`	`Range`	Supprime les lignes de cette plage qui contiennent des valeurs en double de n'importe quelle ligne précédente.
`removeDuplicates(columnsToCompare)`	`Range`	Supprime les lignes de cette plage qui contiennent des valeurs dans les colonnes spécifiées qui sont des doublons de valeurs de toute ligne précédente.
`setBackground(color)`	`Range`	Définit la couleur d'arrière-plan de toutes les cellules de la plage au format CSS (`'#ffffff'` ou `'white'`, par exemple).
`setBackgroundObject(color)`	`Range`	Définit la couleur d'arrière-plan de toutes les cellules de la plage.
`setBackgroundObjects(color)`	`Range`	Définit une grille rectangulaire de couleurs d'arrière-plan (doit correspondre aux dimensions de cette plage).
`setBackgroundRGB(red, green, blue)`	`Range`	Définit l'arrière-plan sur la couleur indiquée à l'aide de valeurs RVB (entiers compris entre 0 et 255 inclus).
`setBackgrounds(color)`	`Range`	Définit une grille rectangulaire de couleurs d'arrière-plan (doit correspondre aux dimensions de cette plage).
`setBorder(top, left, bottom, right, vertical, horizontal)`	`Range`	Définit la propriété de la bordure.
`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`	`Range`	Définit la propriété de la bordure avec une couleur et/ou un style.
`setDataValidation(rule)`	`Range`	Définit une règle de validation des données pour toutes les cellules de la plage.
`setDataValidations(rules)`	`Range`	Définit les règles de validation des données pour toutes les cellules de la plage.
`setFontColor(color)`	`Range`	Définit la couleur de la police au format CSS (`'#ffffff'` ou `'white'`, par exemple).
`setFontColorObject(color)`	`Range`	Définit la couleur de police de la plage donnée.
`setFontColorObjects(colors)`	`Range`	Définit une grille rectangulaire de couleurs de police (doit correspondre aux dimensions de cette plage).
`setFontColors(colors)`	`Range`	Définit une grille rectangulaire de couleurs de police (doit correspondre aux dimensions de cette plage).
`setFontFamilies(fontFamilies)`	`Range`	Définit une grille rectangulaire de familles de polices (doit correspondre aux dimensions de cette plage).
`setFontFamily(fontFamily)`	`Range`	Définit la famille de polices, telle que " Arial" ou "Helvetica".
`setFontLine(fontLine)`	`Range`	Définit le style de ligne de la police de la plage donnée (`'underline'`, `'line-through'` ou `'none'`).
`setFontLines(fontLines)`	`Range`	Définit une grille rectangulaire de styles de ligne (doit correspondre aux dimensions de cette plage).
`setFontSize(size)`	`Range`	Définit la taille de la police, qui correspond à la taille en points à utiliser.
`setFontSizes(sizes)`	`Range`	Définit une grille rectangulaire des tailles de police (elles doivent correspondre aux dimensions de cette plage).
`setFontStyle(fontStyle)`	`Range`	Définissez le style de police pour la plage donnée (`'italic'` ou `'normal'`).
`setFontStyles(fontStyles)`	`Range`	Définit une grille rectangulaire de styles de police (doit correspondre aux dimensions de cette plage).
`setFontWeight(fontWeight)`	`Range`	Définissez l'épaisseur de la police pour la plage donnée (normal/gras).
`setFontWeights(fontWeights)`	`Range`	Définit une grille rectangulaire d'épaisseurs de police (doit correspondre aux dimensions de cette plage).
`setFormula(formula)`	`Range`	Met à jour la formule pour cette plage.
`setFormulaR1C1(formula)`	`Range`	Met à jour la formule pour cette plage.
`setFormulas(formulas)`	`Range`	Définit une grille rectangulaire de formules (doit correspondre aux dimensions de cette plage).
`setFormulasR1C1(formulas)`	`Range`	Définit une grille rectangulaire de formules (doit correspondre aux dimensions de cette plage).
`setHorizontalAlignment(alignment)`	`Range`	Définissez l'alignement horizontal (de gauche à droite) pour la plage donnée (gauche/centre/droite).
`setHorizontalAlignments(alignments)`	`Range`	Définit une grille rectangulaire d'alignements horizontaux.
`setNote(note)`	`Range`	Définit la note sur la valeur indiquée.
`setNotes(notes)`	`Range`	Définit une grille de notes rectangulaire (doit correspondre aux dimensions de cette plage).
`setNumberFormat(numberFormat)`	`Range`	Définit le format du nombre ou de la date sur la chaîne de mise en forme indiquée.
`setNumberFormats(numberFormats)`	`Range`	Définit une grille rectangulaire de formats numériques ou de dates (doit correspondre aux dimensions de cette plage).
`setRichTextValue(value)`	`Range`	Définit la valeur du texte enrichi pour les cellules de la plage.
`setRichTextValues(values)`	`Range`	Définit une grille rectangulaire de valeurs de texte enrichi.
`setShowHyperlink(showHyperlink)`	`Range`	Détermine si la plage doit afficher des liens hypertextes.
`setTextDirection(direction)`	`Range`	Définit l'orientation du texte des cellules de la plage.
`setTextDirections(directions)`	`Range`	Définit une grille rectangulaire d'orientations de texte.
`setTextRotation(degrees)`	`Range`	Définit les paramètres de rotation du texte pour les cellules de la plage.
`setTextRotation(rotation)`	`Range`	Définit les paramètres de rotation du texte pour les cellules de la plage.
`setTextRotations(rotations)`	`Range`	Définit une grille rectangulaire des rotations de texte.
`setTextStyle(style)`	`Range`	Définit le style du texte des cellules de la plage.
`setTextStyles(styles)`	`Range`	Définit une grille rectangulaire de styles de texte.
`setValue(value)`	`Range`	Définit la valeur de la plage.
`setValues(values)`	`Range`	Définit une grille rectangulaire de valeurs (doit correspondre aux dimensions de cette plage).
`setVerticalAlignment(alignment)`	`Range`	Définissez l'alignement vertical (de haut en bas) pour la plage donnée (haut/milieu/bas).
`setVerticalAlignments(alignments)`	`Range`	Définit une grille rectangulaire d'alignements verticaux (doit correspondre aux dimensions de cette plage).
`setVerticalText(isVertical)`	`Range`	Détermine si le texte des cellules de la plage doit être empilé ou non.
`setWrap(isWrapEnabled)`	`Range`	Définit le retour automatique à la ligne de la plage donnée.
`setWrapStrategies(strategies)`	`Range`	Définit une grille rectangulaire de stratégies de retour à la ligne.
`setWrapStrategy(strategy)`	`Range`	Définit la stratégie de retour à la ligne automatique pour les cellules de la plage.
`setWraps(isWrapEnabled)`	`Range`	Définit une grille rectangulaire de règles de retour à la ligne (doit correspondre aux dimensions de cette plage).
`shiftColumnGroupDepth(delta)`	`Range`	Modifie la profondeur de regroupement de colonnes de la plage selon la valeur spécifiée.
`shiftRowGroupDepth(delta)`	`Range`	Modifie la profondeur de regroupement des lignes de la plage selon la valeur spécifiée.
`sort(sortSpecObj)`	`Range`	Trie les cellules de la plage donnée, par colonne et par ordre spécifié.
`splitTextToColumns()`	`void`	Divise une colonne de texte en plusieurs colonnes en fonction d'un délimiteur détecté automatiquement.
`splitTextToColumns(delimiter)`	`void`	Divise une colonne de texte en plusieurs colonnes en utilisant la chaîne spécifiée comme délimiteur personnalisé.
`splitTextToColumns(delimiter)`	`void`	Divise une colonne de texte en plusieurs colonnes en fonction du délimiteur spécifié.
`trimWhitespace()`	`Range`	Supprime les espaces blancs (espaces, tabulations ou sauts de ligne, par exemple) dans chaque cellule de la plage.
`uncheck()`	`Range`	Modifie l'état des cases à cocher de la plage sur "décochée".

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`getFontColor()`	`String`	Renvoie la couleur de police de la cellule située dans l'angle supérieur gauche de la plage, au format CSS (par exemple, `'#ffffff'` ou `'white'`).
`getFontColors()`	`String[][]`	Renvoie les couleurs de police des cellules de la plage au format CSS (par exemple, `'#ffffff'` ou `'white'`).

Documentation détaillée

`activate()`

Définit la plage spécifiée en tant que active range, la cellule supérieure gauche de la plage étant current cell.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:D10');
range.activate();

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D10
var activeRange = selection.getActiveRange();

Aller-retour

Range : plage pour le chaînage.

`activateAsCurrentCell()`

Définit la cellule spécifiée en tant que current cell.

Si la cellule spécifiée est présente dans une plage existante, cette plage devient la plage active et la cellule devient la cellule active.

Si la cellule spécifiée n'est présente dans aucune plage existante, la sélection existante est supprimée, et la cellule devient la cellule actuelle et la plage active.

Remarque:L'élément Range spécifié doit être constitué d'une cellule. Dans le cas contraire, une exception est générée.

// Gets the first sheet of the spreadsheet.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Gets the cell B5 and sets it as the active cell.
var range = sheet.getRange('B5');
var currentCell = range.activateAsCurrentCell();

// Logs the activated cell.
console.log(currentCell.getA1Notation());

Aller-retour

Range : plage 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)`

Ajoute à la plage des 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' to the developer metadata for row 2.
range.addDeveloperMetadata('NAME');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

Paramètres

Nom	Type	Description
`key`	`String`	Clé pour les nouvelles métadonnées de développement.

Aller-retour

Range : plage 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 des métadonnées de développement avec la clé spécifiée et la visibilité à la plage.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT'
// for row 2 on Sheet1.
range.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.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 de développement.
`visibility`	`DeveloperMetadataVisibility`	Visibilité des nouvelles métadonnées du développeur.

Aller-retour

Range : plage 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 plage des 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 of Sheet1.
const range = sheet.getRange('2:2');

// Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the metadata and logs it to the console.
const developerMetaData = range.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

Paramètres

Nom	Type	Description
`key`	`String`	Clé pour les nouvelles métadonnées de développement.
`value`	`String`	Valeur des nouvelles métadonnées de développeur.

Aller-retour

Range : plage 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 plage.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to PROJECT for row 2 on the sheet.
range.addDeveloperMetadata(
  'NAME',
  'GOOGLE',
  SpreadsheetApp.DeveloperMetadataVisibility.PROJECT);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = range.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 de développement.
`value`	`String`	Valeur des nouvelles métadonnées de développeur.
`visibility`	`DeveloperMetadataVisibility`	Visibilité des nouvelles métadonnées du développeur.

Aller-retour

Range : plage 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

`applyColumnBanding()`

Applique un thème de bandes de colonnes par défaut à la plage. Par défaut, les bandes ont une couleur pour l'en-tête, mais pas pour le pied de page.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies column banding to row 2.
const colBanding = range.applyColumnBanding();

// Gets the first banding on the sheet and logs the color of the header column.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject().asRgbColor().asHexString());

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

Aller-retour

Banding : nouvelle création de bandes.

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

`applyColumnBanding(bandingTheme)`

Applique un thème de bandes de colonnes spécifié à la plage. Par défaut, les bandes ont une couleur pour l'en-tête et pas pour le pied de page.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on the sheet.
const range = sheet.getRange('2:2');

// Applies the INDIGO color banding theme to the columns in row 2.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the first banding on the sheet and logs the color of the second column.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

Paramètres

Nom	Type	Description
`bandingTheme`	`BandingTheme`	Thème de couleur à appliquer aux colonnes de la plage.

Aller-retour

Banding : nouvelle création de bandes.

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

`applyColumnBanding(bandingTheme, showHeader, showFooter)`

Applique un thème de bandes de colonnes spécifié à la plage dont les paramètres d'en-tête et de pied de page sont spécifiés.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets rows 12-22 on the sheet.
const range = sheet.getRange('12:22');

// Applies the BLUE color banding theme to rows 12-22.
// Sets the header visibility to false and the footer visibility to true.
const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.BLUE, false, true);

// Gets the banding color and logs it to the console.
console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());

// Gets the header color object and logs it to the console. Returns null because the header
// visibility is set to false.
console.log(sheet.getBandings()[0].getHeaderColumnColorObject());

// Gets the footer color and logs it to the console.
console.log(sheet.getBandings()[0].getFooterColumnColorObject().asRgbColor().asHexString());

Paramètres

Nom	Type	Description
`bandingTheme`	`BandingTheme`	Thème de couleur à appliquer aux colonnes de la plage.
`showHeader`	`Boolean`	Si la valeur est `true`, la couleur de l'en-tête du thème de bandes est appliquée à la première colonne.
`showFooter`	`Boolean`	Si la valeur est `true`, la couleur du pied de page du thème de bandes est appliquée à la dernière colonne.

Aller-retour

Banding : nouvelle création de bandes.

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

`applyRowBanding()`

Applique un thème de bandes de lignes par défaut à la plage. Par défaut, les bandes ont une couleur pour l'en-tête, mais pas pour le pied de page.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies row banding to rows 1-30.
range.applyRowBanding();

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Aller-retour

Banding : bandes.

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

`applyRowBanding(bandingTheme)`

Applique un thème de bandes de lignes spécifié à la plage. Par défaut, les bandes ont une couleur pour l'en-tête, mais pas pour le pied de page.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding theme to rows 1-30.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO);

// Gets the hex color of the second banded row.
const secondRowColor = range.getBandings()[0]
                            .getSecondRowColorObject()
                            .asRgbColor()
                            .asHexString();

// Logs the hex color to console.
console.log(secondRowColor);

Paramètres

Nom	Type	Description
`bandingTheme`	`BandingTheme`	Thème de couleur à appliquer aux lignes de la plage.

Aller-retour

Banding : nouvelle création de bandes.

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

`applyRowBanding(bandingTheme, showHeader, showFooter)`

Applique un thème de bandes de lignes spécifié à la plage avec des paramètres d'en-tête et de pied de page spécifiés.

// Opens the spreadsheet 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 rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

// Applies the INDIGO row banding to rows 1-30 and
// specifies to hide the header and show the footer.
range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);

Paramètres

Nom	Type	Description
`bandingTheme`	`BandingTheme`	Thème de couleur à appliquer aux lignes de la plage.
`showHeader`	`Boolean`	Si la valeur est `true`, la couleur de l'en-tête du thème de bandes est appliquée à la première ligne.
`showFooter`	`Boolean`	Si la valeur est `true`, la couleur du pied de page du thème des bandes est appliquée à la dernière ligne.

Aller-retour

Banding : nouvelle création de bandes.

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

`autoFill(destination, series)`

Remplis le destinationRange avec des données basées sur les données de cette plage. Les nouvelles valeurs sont également déterminées par le type series spécifié. La plage de destination doit contenir cette plage et l'étendre dans une seule direction. Par exemple, le code suivant remplit A1:A20 avec une série de nombres croissants en fonction des valeurs actuelles de A1:A4:

var sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
var sourceRange = sheet.getRange("A1:A4");
// The range to fill with values.
var destination = sheet.getRange("A1:A20");

// Inserts new values in A5:A20, continuing the pattern expressed in A1:A4
sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Paramètres

Nom	Type	Description
`destination`	`Range`	Plage à remplir automatiquement avec des valeurs. La plage de destination doit contenir cette plage et l'étendre dans une seule direction (vers le haut, le bas, la gauche ou la droite).
`series`	`AutoFillSeries`	Type de série autoFill à utiliser pour calculer les nouvelles valeurs. L'effet de cette série diffère en fonction du type et de la quantité de données sources.

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

`autoFillToNeighbor(series)`

Calcule une plage à remplir avec de nouvelles données en fonction des cellules voisines, puis la remplit automatiquement avec de nouvelles valeurs en fonction des données qu'elle contient. Ces nouvelles valeurs sont également déterminées par le type series spécifié.

La plage de destination calculée prend en compte les données environnantes pour déterminer où insérer les nouvelles valeurs: si des données se trouvent immédiatement à gauche ou à droite d'une colonne en cours de saisie automatique, les nouvelles valeurs ne s'étendent que jusqu'à ces données adjacentes.

Par exemple, si A1:A20 est rempli avec une série de nombres croissants et que cette méthode est appelée sur la plage B1:B4 qui contient une série de dates, les nouvelles valeurs ne sont insérées que dans B5:B20. De cette manière, ces nouvelles valeurs "s'en tiennent" aux cellules qui contiennent des valeurs dans la colonne A.

var sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
var sourceRange = sheet.getRange("B1:B4");

// Results in B5:B20 having values [1/5/2017, ... 1/20/2017]
sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);

Paramètres

Nom	Type	Description
`series`	`AutoFillSeries`	Type de série autoFill à utiliser pour calculer les nouvelles valeurs. L'effet de cette série diffère en fonction du type et de la quantité de données sources.

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

`breakApart()`

Divisez à nouveau les cellules à plusieurs colonnes de la plage en cellules individuelles.

L'appel de cette fonction sur une plage équivaut à sélectionner une plage et à cliquer sur Format > Fusionner les cellules > Annuler la fusion.

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Unmerges the range A1:C6 into individual cells.
range.breakApart();

Aller-retour

Range : plage 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

`canEdit()`

Détermine si l'utilisateur est autorisé ou non à modifier chaque cellule de la plage. Le propriétaire de la feuille de calcul peut toujours modifier les plages et les feuilles protégées.

// Opens the spreadsheet 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 range A1:C6 on Sheet1.
const range = sheet.getRange('A1:C6');

// Logs whether the user has permission to edit every cell in the range.
console.log(range.canEdit());

Aller-retour

Boolean : true si l'utilisateur est autorisé à modifier chaque cellule de la plage, ou 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

`check()`

Redéfinit l'état des cases à cocher de la plage sur "cochées". Ignore les cellules de la plage qui ne contiennent actuellement ni la valeur cochée, ni la valeur décochée.

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'checked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

Aller-retour

Range : plage 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 la plage de contenus et de formats.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clear();

Aller-retour

Range : plage 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(options)`

Efface la plage de contenus, le format, les règles de validation des données et/ou les commentaires, comme spécifié avec les options avancées données. Par défaut, toutes les données sont effacées.

// The code below clears range C2:G7 in the active sheet, but preserves the format,
// data validation rules, and comments.
SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({contentsOnly: true});

Paramètres

Nom	Type	Description
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`commentsOnly`	`Boolean`	Permet de choisir d'effacer uniquement les commentaires.
`contentsOnly`	`Boolean`	Permet de spécifier si le contenu doit être effacé uniquement.
`formatOnly`	`Boolean`	Indique s'il faut effacer uniquement le format. Notez que cette opération efface également les règles de validation des données.
`validationsOnly`	`Boolean`	Indique s'il faut effacer uniquement les règles de validation des données.
`skipFilteredRows`	`Boolean`	Indique s'il faut éviter d'effacer les lignes filtrées.

Aller-retour

Range : plage 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

`clearContent()`

Efface le contenu de la plage, sans modifier la mise en forme.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearContent();

Aller-retour

Range : plage 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

`clearDataValidations()`

Efface les règles de validation des données pour la plage.

// Clear the data validation rules for cells A1:B5.
var range = SpreadsheetApp.getActive().getRange('A1:B5');
range.clearDataValidations();

Aller-retour

Range : plage 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

`clearFormat()`

Efface la mise en forme de cette plage.

Cette action efface la mise en forme du texte de la ou des cellules de la plage, mais ne réinitialise aucune règle de mise en forme des nombres.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearFormat();

Aller-retour

Range : plage 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

`clearNote()`

Efface la note dans la ou les cellules spécifiées.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.clearNote();

Aller-retour

Range : plage 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

`collapseGroups()`

Réduit tous les groupes entièrement contenus dans la plage. Si aucun groupe n'est entièrement compris dans la plage, le groupe développé le plus profond qui est partiellement compris dans la plage est réduit.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// All row and column groups within the range are collapsed.
range.collapseGroups();

Aller-retour

Range : plage 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

`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`

Copiez la mise en forme de la plage à l'emplacement indiqué. Si la destination est supérieure ou inférieure à la plage source, elle est répétée ou tronquée en conséquence. Notez que cette méthode ne copie que la mise en forme.

Pour obtenir une description détaillée du paramètre "gridId", consultez la page sur getGridId().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId
// of a sheet by calling sheet.getSheetId() or range.getGridId().
range.copyFormatToRange(1555299895, 4, 6, 4, 6);

Paramètres

Nom	Type	Description
`gridId`	`Integer`	Identifiant unique de la feuille au sein de la feuille de calcul, quelle que soit sa position.
`column`	`Integer`	Première colonne de la plage cible.
`columnEnd`	`Integer`	Colonne de fin de la plage cible.
`row`	`Integer`	Ligne de début de la plage cible.
`rowEnd`	`Integer`	Ligne de fin de la plage cible.

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

getGridId()

`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the formatting in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyFormatToRange(destination, 4, 6, 4, 6);

Paramètres

Nom	Type	Description
`sheet`	`Sheet`	Feuille cible.
`column`	`Integer`	Première colonne de la plage cible.
`columnEnd`	`Integer`	Colonne de fin de la plage cible.
`row`	`Integer`	Ligne de début de la plage cible.
`rowEnd`	`Integer`	Ligne de fin de la plage cible.

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(destination)`

Copie les données d'une plage de cellules vers une autre plage de cellules. Les valeurs et la mise en forme sont copiées.

// The code below copies the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5);
rangeToCopy.copyTo(sheet.getRange(1, 6));

Paramètres

Nom	Type	Description
`destination`	`Range`	Une plage de destination vers laquelle effectuer la copie. Seule la position supérieure gauche de la cellule est prise en compte.

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(destination, copyPasteType, transposed)`

Copie les données d'une plage de cellules vers une autre plage de cellules.

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES,
false);

Paramètres

Nom	Type	Description
`destination`	`Range`	Une plage de destination vers laquelle effectuer la copie. Seule la position supérieure gauche de la cellule est prise en compte.
`copyPasteType`	`CopyPasteType`	Type qui spécifie la manière dont le contenu de la plage est collé dans la destination.
`transposed`	`Boolean`	Indique si la plage doit être collée dans son orientation transposé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

`copyTo(destination, options)`

Copie les données d'une plage de cellules vers une autre plage de cellules. Par défaut, les valeurs et la mise en forme sont copiées, mais vous pouvez utiliser des arguments avancés pour les remplacer.

// The code below copies only the values of the first 5 columns over to the 6th column.
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});

Paramètres

Nom	Type	Description
`destination`	`Range`	Une plage de destination vers laquelle effectuer la copie. Seule la position supérieure gauche de la cellule est prise en compte.
`options`	`Object`	Objet JavaScript qui spécifie les paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`formatOnly`	`Boolean`	indique que seul le format doit être copié
`contentsOnly`	`Boolean`	indique que seul le contenu doit être copié

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

`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`

Copier le contenu de la plage à l'emplacement indiqué. Si la destination est supérieure ou inférieure à la plage source, elle est répétée ou tronquée en conséquence.

Pour obtenir une description détaillée du paramètre "gridId", consultez la page sur getGridId().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the sheet with gridId 0
range.copyValuesToRange(0, 4, 6, 4, 6);

Paramètres

Nom	Type	Description
`gridId`	`Integer`	Identifiant unique de la feuille au sein de la feuille de calcul, quelle que soit sa position.
`column`	`Integer`	Première colonne de la plage cible.
`columnEnd`	`Integer`	Colonne de fin de la plage cible.
`row`	`Integer`	Ligne de début de la plage cible.
`rowEnd`	`Integer`	Ligne de fin de la plage cible.

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

getGridId()

`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`

Copier le contenu de la plage à l'emplacement indiqué. Si la destination est supérieure ou inférieure à la plage source, elle est répétée ou tronquée en conséquence.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var source = ss.getSheets()[0];
var destination = ss.getSheets()[1];

var range = source.getRange("B2:D4");

// This copies the data in B2:D4 in the source sheet to
// D4:F6 in the second sheet
range.copyValuesToRange(destination, 4, 6, 4, 6);

Paramètres

Nom	Type	Description
`sheet`	`Sheet`	Feuille cible.
`column`	`Integer`	Première colonne de la plage cible.
`columnEnd`	`Integer`	Colonne de fin de la plage cible.
`row`	`Integer`	Ligne de début de la plage cible.
`rowEnd`	`Integer`	Ligne de fin de la plage cible.

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

`createDataSourcePivotTable(dataSource)`

Crée un tableau croisé dynamique de source de données vide à partir de la source de données, ancré à la première cellule de cette plage.

Cet exemple montre comment créer et configurer un tableau croisé dynamique de source de données.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var pivotTable = anchorCell.createDataSourcePivotTable(dataSource);
pivotTable.addRowGroup('dataColumnA');
pivotTable.addColumnGroup('dataColumnB');
pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM);
pivotTable.addFilter('dataColumnA',
                     SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());

Paramètres

Nom	Type	Description
`dataSource`	`DataSource`	Source de données à partir de laquelle créer le tableau croisé dynamique.

Aller-retour

DataSourcePivotTable : tableau croisé dynamique de la source de données que vous venez de créer.

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

`createDataSourceTable(dataSource)`

Crée une table de source de données vide à partir de la source de données, ancrée à la première cellule de cette plage.

Cet exemple montre comment créer et configurer une table de source de données.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var anchorCell = spreadsheet.getSheets()[0].getRange('A1');
var dataSource = spreadsheet.getDataSources()[0];

var dataSourceTable = anchorCell.createDataSourceTable(dataSource);
    .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC')
    .addSortSpec('dataColumnA', /* ascending= *\/ true)
    .addSortSpec('dataColumnB', /* ascending= *\/ false);

Paramètres

Nom	Type	Description
`dataSource`	`DataSource`	Source de données à partir de laquelle créer le tableau croisé dynamique.

Aller-retour

DataSourceTable : nouvelle table de 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

`createDeveloperMetadataFinder()`

Renvoie une DeveloperMetadataFinderApi pour la recherche de métadonnées de développeur dans le champ d'application de cette plage. Les métadonnées n'entrent dans le champ d'application de la plage que si elles sont entièrement contenues dans celle-ci. Par exemple, les métadonnées associées à la ligne "3:3" ne sont pas incluses dans la plage "A1:D5", mais dans la plage "1:5".

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:C6.
const range = sheet.getRange('A1:C6');

// Creates a developer metadata finder to search for metadata in the scope of this range.
const developerMetaDataFinder = range.createDeveloperMetadataFinder();

// Logs information about the developer metadata finder to the console.
const developerMetaData = developerMetaDataFinder.find()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Aller-retour

DeveloperMetadataFinder : outil de recherche de métadonnées pour les développeurs, permettant de rechercher les métadonnées comprises dans cette plage.

`createFilter()`

Crée un filtre et l'applique à la plage spécifiée dans la feuille. Vous ne pouvez pas créer plusieurs filtres sur une feuille. Pour accéder à votre filtre et le modifier après l'avoir créé, utilisez getFilter() ou Sheet.getFilter().

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}

Utilisez cette méthode pour créer des filtres pour les feuilles Grid, le type de feuille par défaut. Les feuilles de grille sont des feuilles qui ne sont pas connectées à une base de données. Pour créer d'autres types de filtres, reportez-vous à ce qui suit :

Créer un filtre de tableau croisé dynamique avec PivotTable.addFilter(sourceDataColumn, filterCriteria)
Créer un filtre pour une feuille connectée à une base de données avec DataSourceSheet.addFilter(columnName, filterCriteria)
Créer un filtre pour un tableau croisé dynamique connecté à une base de données avec DataSourcePivotTable.addFilter(columnName, filterCriteria)

Aller-retour

Filter : nouveau 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

`createPivotTable(sourceData)`

Crée un tableau croisé dynamique vide à partir de la valeur sourceData spécifiée, ancré à la première cellule de cette plage.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 as a range in order to place the pivot table.
const range = sheet.getRange('A1');

// Gets the range of the source data for the pivot table.
const dataRange = sheet.getRange('E12:G20');

// Creates an empty pivot table from the specified source data.
const pivotTable = range.createPivotTable(dataRange);

// Logs the values from the pivot table's source data to the console.
console.log(pivotTable.getSourceDataRange().getValues());

Paramètres

Nom	Type	Description
`sourceData`	`Range`	Données à partir desquelles créer le tableau croisé dynamique.

Aller-retour

PivotTable : PivotTable que vous venez de créer.

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

`createTextFinder(findText)`

Crée un outil de recherche de texte pour la plage, qui peut rechercher et remplacer du texte dans cette plage.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// Creates  a text finder for the range.
var textFinder = range.createTextFinder('dog');

// Returns the first occurrence of 'dog'.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = textFinder.replaceWith('cat');

Paramètres

Nom	Type	Description
`findText`	`String`	Texte à rechercher.

Aller-retour

TextFinder : TextFinder de la plage

`deleteCells(shiftDimension)`

Supprime cette plage de cellules. Les données existantes de la feuille en fonction de la dimension fournie sont déplacées vers la plage supprimée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

Paramètres

Nom	Type	Description
`shiftDimension`	`Dimension`	Dimension selon laquelle déplacer les données existantes.

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

`expandGroups()`

Développe les groupes réduits dont le bouton d'activation de plage ou de commande présente une intersection avec cette plage. L'emplacement du bouton d'activation des commandes est l'index auquel celui-ci s'affiche, directement avant ou après le groupe, en fonction des paramètres. S'il y a plusieurs groupes au même emplacement, le groupe le plus superficiel est développé.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// All row and column groups within the range are expanded.
range.expandGroups();

Aller-retour

Range : plage 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

`getA1Notation()`

Renvoie une description de la plage sous forme de chaîne, au format A1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange(1, 1, 2, 5);

// Logs "A1:E2"
Logger.log(range.getA1Notation());

Aller-retour

String : description de la plage sous forme de chaîne en notation A1.

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

`getBackground()`

Renvoie la couleur d'arrière-plan de la cellule en haut à gauche de la plage (par exemple, '#ffffff').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
Logger.log(cell.getBackground());

Aller-retour

String : code couleur de l'arrière-plan.

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

`getBackgroundObject()`

Renvoie la couleur d'arrière-plan de la cellule en haut à gauche de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

Aller-retour

Color : couleur d'arrière-plan de la cellule supérieure gauche de la plage.

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

`getBackgroundObjects()`

Renvoie les couleurs d'arrière-plan des cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgroundObjects();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j].asRgbColor().asHexString());
  }
}

Aller-retour

Color[][] : tableau bidimensionnel de couleurs d'arrière-plan.

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

`getBackgrounds()`

Renvoie les couleurs d'arrière-plan des cellules de la plage (par exemple, '#ffffff').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var bgColors = range.getBackgrounds();
for (var i in bgColors) {
  for (var j in bgColors[i]) {
    Logger.log(bgColors[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel des codes de couleur des arrière-plans.

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

`getBandings()`

Renvoie toutes les bandes appliquées aux cellules de cette plage.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets a range.
const range = sheet.getRange('A1:K50');

// Gets the banding info for the range.
const bandings = range.getBandings();

// Logs the second row color for each banding to the console.
for (let banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Aller-retour

Banding[] : toutes les bandes appliquées aux cellules de cette plage.

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

`getCell(row, column)`

Renvoie une cellule donnée dans une plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");

// The row and column here are relative to the range
// getCell(1,1) in this code returns the cell at B2
var cell = range.getCell(1, 1);
Logger.log(cell.getValue());

Paramètres

Nom	Type	Description
`row`	`Integer`	Ligne de la cellule par rapport à la plage.
`column`	`Integer`	Colonne de la cellule par rapport à la plage.

Aller-retour

Range : plage contenant une seule cellule aux coordonnées spécifié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

`getColumn()`

Renvoie la position de départ de la colonne pour cette plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "2.0"
Logger.log(range.getColumn());

Aller-retour

Integer : position de départ de la colonne dans 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

`getDataRegion()`

Renvoie une copie de la plage étendue dans les quatre Direction cardinaux pour couvrir toutes les cellules adjacentes contenant des données. Si la plage est entourée de cellules vides à l'exception de celles situées en diagonale, la plage elle-même est renvoyée. Cela revient à sélectionner la plage et à saisir Ctrl+A dans l'éditeur.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "B2:D4"
Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());

Aller-retour

Range : région de données de la plage ou plage pour l'ensemble 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

`getDataRegion(dimension)`

Renvoie une copie de la plage étendue Direction.UP et Direction.DOWN si la dimension spécifiée est Dimension.ROWS, ou Direction.NEXT et Direction.PREVIOUS si la dimension est Dimension.COLUMNS. L'élargissement de la plage est basé sur la détection de données à côté de la plage organisées sous la forme d'un tableau. La plage étendue couvre toutes les cellules adjacentes contenant des données le long de la dimension spécifiée, y compris les limites du tableau. Si la plage d'origine est entourée de cellules vides le long de la dimension spécifiée, la plage elle-même est renvoyée. Cette méthode est semblable à la sélection de la plage et à la saisie de Ctrl+Space pour les colonnes ou de Shift+Space pour les lignes dans l'éditeur.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
sheet.getRange("C2").setValue(100);
sheet.getRange("B3").setValue(100);
sheet.getRange("D3").setValue(100);
sheet.getRange("C4").setValue(100);
// Logs "C2:C4"
Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation());
// Logs "B3:D3"
Logger.log(
    sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());

Paramètres

Nom	Type	Description
`dimension`	`Dimension`	Dimension selon laquelle étendre la plage.

Aller-retour

Range : région de données de la plage ou plage couvrant chaque colonne ou chaque ligne couverte par la plage d'origine.

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

`getDataSourceFormula()`

Renvoie la valeur DataSourceFormula pour la première cellule de la plage, ou null si la cellule ne contient pas de formule de 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 the range A1 on Sheet1.
const range = sheet.getRange('A1');

// Gets the data source formula from cell A1.
const dataSourceFormula = range.getDataSourceFormula();

// Gets the formula.
const formula = dataSourceFormula.getFormula();

// Logs the formula.
console.log(formula);

Aller-retour

DataSourceFormula : DataSourceFormula de la 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

`getDataSourceFormulas()`

Renvoie les valeurs DataSourceFormula des cellules de la plage.

// 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 the range A1:B5 on Sheet1.
const range = sheet.getRange('A1:B5');

// Gets an array of the data source formulas in the range A1:B5.
const dataSourceFormulas = range.getDataSourceFormulas();

// Logs the first formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Aller-retour

DataSourceFormula[] : tableau de valeurs DataSourceFormula.

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 présentant une intersection avec la plage.

// 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets an array of the data source pivot tables in the range A1:G50.
const dataSourcePivotTables = range.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Aller-retour

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 sources de données qui présentent une intersection avec la plage.

// 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 the range A1:G50 on Sheet1.
const range = sheet.getRange('A1:G50');

// Gets the first data source table in the range A1:G50.
const dataSourceTable = range.getDataSourceTables()[0];

// Logs the time of the last completed data execution on the data source table.
console.log(dataSourceTable.getStatus().getLastExecutionTime());

Aller-retour

DataSourceTable[] : liste des tables de 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

`getDataSourceUrl()`

Renvoie une URL pour les données de cette plage, qui peut être utilisée pour créer des graphiques et des requêtes.

Code.gs

function doGet() {
  var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c');
  var sheet = ss.getSheetByName('ContinentData');
  var range = sheet.getRange('A1:B8');

  var template = HtmlService.createTemplateFromFile('piechart');
  template.dataSourceUrl = range.getDataSourceUrl();
  return template.evaluate();
}

camembert.html

<!DOCTYPE html>
<html>
  <head>
    <!--Load the AJAX API-->
    <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script>
    <script type="text/javascript">
      // Load the Visualization API and the corechart package.
      google.charts.load('current', {'packages': ['corechart']});

      // Set a callback to run when the Google Visualization API is loaded.
      google.charts.setOnLoadCallback(queryData);

      function queryData() {
        var query = new google.visualization.Query('<?= dataSourceUrl ?>');
        query.send(drawChart);
      }

      // Callback that creates and populates a data table,
      // instantiates the pie chart, passes in the data and
      // draws it.
      function drawChart(response) {
        if (response.isError()) {
          alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage());
          return;
        }
        var data = response.getDataTable();

        // Set chart options.
        var options = {
          title: 'Population by Continent',
          width: 400,
          height: 300
        };

        // Instantiate and draw the chart, passing in some options.
        var chart = new google.visualization.PieChart(document.getElementById('chart_div'));
        chart.draw(data, options);
      }
    </script>
  </head>
  <body>
    <!-- Div that holds the pie chart. -->
    <div id="chart_div"></div>
  </body>
</html>

Aller-retour

String : URL pour cette plage en tant que source de données pouvant être transmise à d'autres API telles que des 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

`getDataTable()`

Renvoyez les données contenues dans cet objet en tant que DataTable.

// 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 the range A1:B7 on Sheet1.
const range = sheet.getRange('A1:B7');

// Gets the range A1:B7 as a data table. The values in each column must be of the same type.
const datatable = range.getDataTable();

// Uses the Charts service to build a bar chart from the data table.
// This doesn't build an embedded chart. To do that, use sheet.newChart().addRange() instead.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Chart Title Here')
                  .build();

Aller-retour

DataTable : données sous forme de table de données

`getDataTable(firstRowIsHeader)`

Renvoyez les données de cette plage en tant que DataTable.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:B7");

// Calling this method with "true" sets the first line to be the title of the axes
var datatable = range.getDataTable(true);

// Note that this doesn't build an EmbeddedChart, so you can't just use
// Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead.
var chart = Charts.newBarChart()
    .setDataTable(datatable)
    .setOption("title", "Your Title Here")
    .build();

Paramètres

Nom	Type	Description
`firstRowIsHeader`	`Boolean`	Indique s'il faut traiter la première ligne comme un en-tête.

Aller-retour

DataTable : données sous forme de table 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

`getDataValidation()`

Renvoie la règle de validation des données pour la cellule supérieure gauche de la plage. Si la validation des données n'a pas été définie sur la cellule, cette méthode renvoie null.

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

Aller-retour

DataValidation : règle de validation des données pour la cellule supérieure gauche de la plage.

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

`getDataValidations()`

Affiche les règles de validation des données pour toutes les cellules de la plage. Si la validation des données n'a pas été définie sur une cellule donnée, cette méthode renvoie null pour la position de cette cellule dans le tableau.

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

Aller-retour

DataValidation[][] : tableau bidimensionnel de règles de validation des données associées aux cellules de la plage.

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()`

Récupère les métadonnées de développement associées à cette plage.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets row 2 on Sheet1.
const range = sheet.getRange('2:2');

// Adds metadata to row 2.
range.addDeveloperMetadata('NAME', 'GOOGLE');

// Logs the metadata to console.
for (const metadata of range.getDeveloperMetadata()) {
  console.log(`${metadata.getKey()}: ${metadata.getValue()}`);
}

Aller-retour

DeveloperMetadata[] : métadonnées de développement associées à cette plage.

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

`getDisplayValue()`

Renvoie la valeur affichée de la cellule supérieure gauche de la plage. Sa valeur est un String. La valeur affichée tient compte de la mise en forme de la date, de l'heure et de la devise, y compris les formats appliqués automatiquement par les paramètres régionaux de la feuille de calcul. Les cellules vides renvoient une chaîne vide.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its value to 'Test code.'
const cell = sheet.getRange('A30');
cell.setValue('Test code');

// Gets the value and logs it to the console.
console.log(cell.getDisplayValue());

Aller-retour

String : valeur affichée dans 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

`getDisplayValues()`

Renvoie la grille rectangulaire de valeurs pour cette plage.

Renvoie un tableau bidimensionnel de valeurs affichées, indexées par ligne, puis par colonne. Les valeurs sont des objets String. La valeur affichée tient compte du format de la date, de l'heure et de la devise, y compris des formats appliqués automatiquement par les paramètres régionaux de la feuille de calcul. Les cellules vides sont représentées par une chaîne vide dans le tableau. N'oubliez pas que si un index de plage commence à 1, 1, le tableau JavaScript est indexé à partir de [0][0].

// The code below gets the displayed values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

Aller-retour

String[][] : 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

`getFilter()`

Renvoie le filtre sur la feuille à laquelle cette plage appartient, ou null si la feuille ne contient pas de filtre.

let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Gets the existing filter on the sheet that the given range belongs to.
let filter = range.getFilter();

Aller-retour

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

`getFontColorObject()`

Renvoie la couleur de police de la cellule dans le coin supérieur gauche de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontColorObject().asRgbColor().asHexString());

Aller-retour

Color : couleur de police de la cellule supérieure gauche de la plage.

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

`getFontColorObjects()`

Renvoie les couleurs de police des cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColorObjects();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j].asRgbColor().asHexString());
  }
}

Aller-retour

Color[][] : tableau bidimensionnel de couleurs de police associées aux cellules de la plage.

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

`getFontFamilies()`

Renvoie les familles de polices des cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontFamilies();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel des familles de polices associées aux cellules de la plage.

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

`getFontFamily()`

Renvoie la famille de polices de la cellule dans le coin supérieur gauche de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontFamily());

Aller-retour

String : famille de polices de la 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

`getFontLine()`

Récupère le style de ligne de la cellule située dans l'angle supérieur gauche de la plage ('underline', 'line-through' ou 'none').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontLine());

Aller-retour

String : ligne de police.

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

`getFontLines()`

Récupère le style de ligne des cellules de la plage ('underline', 'line-through' ou 'none').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontLines();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel de lignes de police associées aux cellules de la plage.

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

`getFontSize()`

Renvoie la taille de la police en points de la cellule située dans l'angle supérieur gauche de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontSize());

Aller-retour

Integer : taille de la police en point.

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

`getFontSizes()`

Renvoie les tailles de police des cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontSizes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

Integer[][] : tableau bidimensionnel des tailles de police des textes associés aux cellules de la plage.

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

`getFontStyle()`

Renvoie le style de police ('italic' ou 'normal') de la cellule dans l'angle supérieur gauche de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontStyle());

Aller-retour

String : style de police du texte de la 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

`getFontStyles()`

Renvoie les styles de police des cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontStyles();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel des styles de police des textes associés aux cellules de la plage.

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

`getFontWeight()`

Renvoie l'épaisseur de la police (normal/gras) de la cellule dans l'angle supérieur gauche de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontWeight());

Aller-retour

String : épaisseur de la police du texte dans la 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

`getFontWeights()`

Renvoie l'épaisseur de police des cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontWeights();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel des épaisseurs de police du texte associé aux cellules de la plage.

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

`getFormula()`

Renvoie la formule (notation A1) de la cellule supérieure gauche de la plage, ou une chaîne vide si la cellule est vide ou ne contient pas de formule.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This assumes you have a function in B5 that sums up
// B2:B4
var range = sheet.getRange("B5");

// Logs the calculated value and the formula
Logger.log("Calculated value: %s Formula: %s",
           range.getValue(),
           range.getFormula());

Aller-retour

String : formule de la 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

`getFormulaR1C1()`

Renvoie la formule (notation R1C1) pour une cellule donnée, ou null si aucune.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5");
var formula = range.getFormulaR1C1();
Logger.log(formula);

Aller-retour

String : formule au format R1C1.

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

`getFormulas()`

Renvoie les formules (notation A1) des cellules dans la plage. Les entrées dans le tableau bidimensionnel sont des chaînes vides pour les cellules sans formule.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulas();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

Aller-retour

String[][] : tableau de formules à deux dimensions au format de chaîne.

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

`getFormulasR1C1()`

Renvoie les formules (notation R1C1) des cellules dans la plage. Les entrées du tableau 2D sont null pour les cellules sans formule.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formulas = range.getFormulasR1C1();
for (var i in formulas) {
  for (var j in formulas[i]) {
    Logger.log(formulas[i][j]);
  }
}

Aller-retour

String[][] : tableau de formules à deux dimensions en notation R1C1.

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

`getGridId()`

Renvoie l'ID de grille de la feuille parente de la plage. Les ID sont des valeurs entières non négatives aléatoires.

// Log the grid ID of the first sheet (by tab position) in the spreadsheet.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getGridId());

Aller-retour

Integer : ID de grille de la feuille 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

`getHeight()`

Renvoie la hauteur de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// logs 3.0
Logger.log(range.getHeight());

Aller-retour

Integer : hauteur de la plage.

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

`getHorizontalAlignment()`

Renvoie l'alignement horizontal du texte (à gauche/au centre/à droite) de la cellule dans l'angle supérieur gauche de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getHorizontalAlignment());

Aller-retour

String : alignement horizontal du texte dans la 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

`getHorizontalAlignments()`

Renvoie les alignements horizontaux des cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getHorizontalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel d'alignements horizontaux de texte associé aux cellules de la plage.

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 fin de la colonne.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "4.0"
Logger.log(range.getLastColumn());

Aller-retour

Integer : position de fin de colonne de la plage dans 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

`getLastRow()`

Renvoie la position de la ligne de fin.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D4");
// Logs "4.0"
Logger.log(range.getLastRow());

Aller-retour

Integer : position de fin de la ligne dans 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

`getMergedRanges()`

Renvoie un tableau d'objets Range représentant des cellules fusionnées qui sont entièrement dans la plage actuelle ou qui contiennent au moins une cellule de la plage actuelle.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B3");

var mergedRanges = range.getMergedRanges();
for (var i = 0; i < mergedRanges.length; i++) {
  Logger.log(mergedRanges[i].getA1Notation());
  Logger.log(mergedRanges[i].getDisplayValue());
}

Aller-retour

Range[] : tableau d'objets Range représentant des cellules fusionnées chevauchant la plage.

`getNextDataCell(direction)`

En commençant par la cellule de la première colonne et de la première ligne de la plage, elle renvoie la cellule suivante dans la direction donnée, à savoir le bord d'une plage contiguë de cellules contenant des données ou la cellule située au bord de la feuille de calcul dans cette direction. Cela équivaut à saisir Ctrl+[arrow key] dans l'éditeur.

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("C3:E5");
// Logs "C1"
Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());

Paramètres

Nom	Type	Description
`direction`	`Direction`	Direction dans laquelle trouver la cellule périphérique suivante pour la région de données.

Aller-retour

Range : cellule périphérique de la région de données ou cellule située au bord 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

`getNote()`

Renvoie la note associée à la plage donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getNote());

Aller-retour

String : note associée à la cellule donnée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

`getNotes()`

Affiche les notes associées aux cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getNotes();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel de notes associées aux cellules de la plage.

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

`getNumColumns()`

Renvoie le nombre de colonnes dans cette plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumColumns());

Aller-retour

Integer : nombre de colonnes dans cette plage.

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

`getNumRows()`

Renvoie le nombre de lignes dans cette plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
Logger.log(range.getNumRows());

Aller-retour

Integer : nombre de lignes dans cette plage.

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

`getNumberFormat()`

Permet d'obtenir le format des nombres ou des dates dans la cellule supérieure gauche de la plage donnée. Les formats de format renvoyés sont décrits dans la documentation de l'API Sheets.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("C4");
Logger.log(cell.getNumberFormat());

Aller-retour

String : format numérique de la cellule supérieure gauche de la plage.

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

`getNumberFormats()`

Renvoie le format numérique ou de date des cellules dans la plage. Les modèles de format renvoyés sont décrits dans la documentation de l'API Sheets.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B5:C6");
var formats = range.getNumberFormats();
for (var i in formats) {
  for (var j in formats[i]) {
    Logger.log(formats[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel de formats numériques.

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

`getRichTextValue()`

Renvoie la valeur de texte enrichi de la cellule supérieure gauche de la plage ou null si la valeur de la cellule n'est pas du texte.

// Gets the Rich Text value of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var richText = range.getRichTextValue();
console.log(richText.getText());

Aller-retour

RichTextValue : valeur de texte enrichi de la cellule supérieure gauche de la plage ou null si la valeur de la cellule n'est pas du texte.

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

`getRichTextValues()`

Renvoie les valeurs de texte enrichi des cellules dans la plage.

// Gets the Rich Text values for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var values = range.getRichTextValues();

for (var i = 0; i < values.length; i++) {
  for (var j = 0; j < values[i].length; j++) {
    console.log(values[i][j].getText());
  }
}

Aller-retour

RichTextValue[][] : tableau bidimensionnel de valeurs de texte enrichi.

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

`getRow()`

Renvoie la position de la ligne pour cette plage. Identique à getRowIndex().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2");
Logger.log(range.getRow());

Aller-retour

Integer : position de ligne de la plage.

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

`getRowIndex()`

Renvoie la position de la ligne pour cette plage. Identique à getRow().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2");
Logger.log(range.getRowIndex());

Aller-retour

Integer : position de ligne de la plage.

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

getRow()

`getSheet()`

Renvoie la feuille à laquelle cette plage appartient.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the sheet that the range belongs to.
const rangeSheet = range.getSheet();

// Gets the sheet name and logs it to the console.
console.log(rangeSheet.getName());

Aller-retour

Sheet : feuille à laquelle cette plage appartient.

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

`getTextDirection()`

Renvoie l'orientation du texte de la cellule supérieure gauche de la plage. Renvoie null si l'orientation du texte de la cellule est déterminée par la détection automatique.

// Get the text direction of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getTextDirection());

Aller-retour

TextDirection : orientation du texte de la cellule supérieure gauche de la plage.

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

`getTextDirections()`

Renvoie le sens du texte des cellules de la plage. Les entrées du tableau bidimensionnel sont null pour les cellules utilisant la détection automatique.

// Get the text directions for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var directions = range.getTextDirections();

for (var i = 0; i < directions.length; i++) {
  for (var j = 0; j < directions[i].length; j++) {
    Logger.log(directions[i][j]);
  }
}

Aller-retour

TextDirection[][] : tableau bidimensionnel d'orientations de texte.

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

`getTextRotation()`

Renvoie les paramètres de rotation du texte pour la cellule supérieure gauche de la plage.

// Log the text rotation settings for a cell.
var sheet = SpreadsheetApp.getActiveSheet();

var cell = sheet.getRange("A1");
Logger.log(cell.getTextRotation());

Aller-retour

TextRotation : paramètres de rotation du texte.

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

`getTextRotations()`

Renvoie les paramètres de rotation du texte pour les cellules de la plage.

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

var results = range.getTextRotations();

for (var i in results) {
  for (var j in results[i]) {
    var rotation = results[i][j];
    Logger.log("Cell [%s, %s] has text rotation: %v", i, j, rotation);
  }
}

Aller-retour

TextRotation[][] : tableau bidimensionnel de rotations de texte associées aux cellules de la plage.

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

`getTextStyle()`

Renvoie le style de texte de la cellule supérieure gauche de la plage.

// Get the text style of cell D4.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("D4:F6");
var style = range.getTextStyle();
Logger.log(style);

Aller-retour

TextStyle : style de texte de la cellule supérieure gauche de la plage.

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

`getTextStyles()`

Renvoie les styles de texte des cellules de la plage.

// Get the text styles for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var styles = range.getTextStyles();

for (var i = 0; i < styles.length; i++) {
  for (var j = 0; j < styles[i].length; j++) {
    Logger.log(styles[i][j]);
  }
}

Aller-retour

TextStyle[][] : tableau bidimensionnel de styles de texte.

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

`getValue()`

Renvoie la valeur de la cellule supérieure gauche de la plage. La valeur peut être de type Number, Boolean, Date ou String, selon la valeur de la cellule. Les cellules vides renvoient une chaîne vide.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the value of the top-left cell in the range and logs it to the console.
console.log(range.getValue());

Aller-retour

Object : valeur de 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

`getValues()`

Renvoie la grille rectangulaire de valeurs pour cette plage.

Renvoie un tableau de valeurs bidimensionnel, indexé par ligne, puis par colonne. Les valeurs peuvent être de type Number, Boolean, Date ou String, en fonction de la valeur de la cellule. Les cellules vides sont représentées par une chaîne vide dans le tableau. N'oubliez pas que même si un index de plage commence à 1, 1, le tableau JavaScript est indexé à partir de [0][0].

// The code below gets the values for the range C2:G8
// in the active spreadsheet.  Note that this is a JavaScript array.
var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues();
Logger.log(values[0][0]);

Dans les applications Web, une valeur Date n'est pas un paramètre légal. getValues() ne parvient pas à renvoyer de données à une application Web si la plage contient une cellule avec une valeur Date. À la place, transformez toutes les valeurs extraites de la feuille en une primitive JavaScript compatible, telle que Number, Boolean ou String.

Aller-retour

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

`getVerticalAlignment()`

Renvoie l'alignement vertical (haut/milieu/bas) de la cellule dans l'angle supérieur gauche de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getVerticalAlignment());

Aller-retour

String : alignement vertical du texte dans la 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

`getVerticalAlignments()`

Renvoie les alignements verticaux des cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel d'alignements verticaux de texte associé aux cellules de la plage.

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

`getWidth()`

Renvoie la largeur de la plage en colonnes.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Gets the width of the range in number of columns and logs it to the console.
console.log(range.getWidth());

Aller-retour

Integer : nombre de colonnes dans la plage.

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

`getWrap()`

Indique si le texte contenu dans la cellule doit être renvoyé à la ligne. Pour obtenir une stratégie d'encapsulation plus précise, utilisez getWrapStrategy().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getWrap());

Aller-retour

Boolean : indique si le texte de cette cellule doit être renvoyé à la ligne ou non.

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

`getWrapStrategies()`

Renvoie les stratégies de retour automatique à la ligne pour les cellules de la plage.

// Get the text wrapping strategies for all cells in range B5:C6
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
var strategies = range.getWrapStrategies();

for (var i = 0; i < strategies.length; i++) {
  for (var j = 0; j < strategies[i].length; j++) {
    Logger.log(strategies[i][j]);
  }
}

Aller-retour

WrapStrategy[][] : tableau bidimensionnel de stratégies de renvoi à la ligne du texte.

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

`getWrapStrategy()`

Renvoie la stratégie de retour à la ligne automatique pour la cellule supérieure gauche de la plage.

// Get the text wrapping strategy of cell B1.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B1:D4");
Logger.log(range.getWrapStrategy());

Aller-retour

WrapStrategy : stratégie de retour à la ligne automatique de la cellule supérieure gauche de la plage.

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

`getWraps()`

Indique si le texte contenu dans les cellules est renvoyé à la ligne. Pour obtenir une stratégie d'encapsulation plus précise, utilisez getWrapStrategies().

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getVerticalAlignments();

for (var i in results) {
  for (var j in results[i]) {
    var isWrapped = results[i][j];
    if (isWrapped) {
       Logger.log("Cell [%s, %s] has wrapped text", i, j);
    }
  }
}

Aller-retour

Boolean[][] : tableau bidimensionnel d'alignements verticaux de texte associé aux cellules de la plage.

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

`insertCells(shiftDimension)`

Insère des cellules vides dans cette plage. Les nouvelles cellules conservent la mise en forme présente dans les cellules qui occupent auparavant cette plage. Les données existantes de la feuille en fonction de la dimension fournie sont décalées de la plage insérée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D10");
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

Paramètres

Nom	Type	Description
`shiftDimension`	`Dimension`	Dimension selon laquelle déplacer les données existantes.

Aller-retour

Range : plage 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

`insertCheckboxes()`

Insère des cases à cocher dans chaque cellule de la plage, configurées avec true pour les cases cochées et false pour les cases non cochées. Définit la valeur de toutes les cellules de la plage sur false.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'true' for checked
// and 'false' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'false'.
range.insertCheckboxes();

Aller-retour

Range : plage 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

`insertCheckboxes(checkedValue)`

Insère des cases à cocher dans chaque cellule de la plage, configurées avec une valeur personnalisée pour "coché" et la chaîne vide pour "décochée". Définit la valeur de chaque cellule de la plage sur une chaîne vide.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and the empty string for unchecked. Also, sets the value of each cell in the range A1:B10 to
//  the empty string.
range.insertCheckboxes('yes');

Paramètres

Nom	Type	Description
`checkedValue`	`Object`	Valeur cochée pour la validation des données de la case à cocher.

Aller-retour

Range : plage 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

`insertCheckboxes(checkedValue, uncheckedValue)`

Insère des cases à cocher dans chaque cellule de la plage, configurées avec des valeurs personnalisées pour les états cochés et non cochés. Définit la valeur de chaque cellule de la plage sur la valeur personnalisée décochée.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked
// and 'no' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'no'.
range.insertCheckboxes('yes', 'no');

Paramètres

Nom	Type	Description
`checkedValue`	`Object`	Valeur cochée pour la validation des données de la case à cocher.
`uncheckedValue`	`Object`	Valeur décochée pour la validation des données de la case à cocher.

Aller-retour

Range : plage 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

`isBlank()`

Renvoie true si la plage est totalement vide.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.isBlank());

Aller-retour

Boolean : true si la plage est vide, 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

`isChecked()`

Indique si toutes les cellules de la plage sont cochées. Renvoie null si certaines cellules sont cochées et que le reste n'est pas coché, ou si certaines cellules ne disposent pas de la validation des données de case à cocher.

var range = SpreadsheetApp.getActive().getRange('A1:A3');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:A3.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Sets the value of isRange1Checked as true as it contains the checked value.
var isRange1Checked = range1.isChecked();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('no');
// Sets the value of isRange2Checked as false as it contains the unchecked value.
var isRange2Checked = range2.isChecked();

var range3 = SpreadsheetApp.getActive().getRange('A3');
range3.setValue('random');
// Sets the value of isRange3Checked as null, as it contains an invalid checkbox value.
var isRange3Checked = range3.isChecked();

Aller-retour

Boolean : true, si toutes les cellules de la plage sont cochées, false si toutes les cellules de la plage sont décochées ou null si l'une des cellules est décochée ou n'a pas de case à cocher de validation des 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

`isEndColumnBounded()`

Détermine si la fin de la plage est liée à une colonne spécifique. Par exemple, pour les plages A1:B10 ou B:B, qui sont liées aux colonnes en fin de plage, cette méthode renvoie true. Pour les plages 3:7 ou A1:5, qui ne sont liées qu'à des lignes particulières en fin de plage, cette méthode renvoie false.

 // Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular column and logs it to the
// console.
console.log(range.isEndColumnBounded());

Aller-retour

Boolean : true si la fin de la plage est liée à une colonne particulière, 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

`isEndRowBounded()`

Détermine si la fin de la plage est liée à une ligne spécifique. Par exemple, pour les plages A1:B10 ou 3:7, qui sont liées aux lignes en fin de plage, cette méthode renvoie true. Pour les plages B:B ou A1:C, qui ne sont liées qu'à des colonnes particulières en fin de plage, cette méthode renvoie false.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the end of the range is bound to a particular row and logs it to the console.
console.log(range.isEndRowBounded());

Aller-retour

Boolean : true si la fin de la plage est liée à une ligne particulière, 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

`isPartOfMerge()`

Renvoie true si les cellules de la plage actuelle chevauchent des cellules fusionnées.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B3");

// True if any of the cells in A1:B3 is included in a merge.
var isPartOfMerge = range.isPartOfMerge();

Aller-retour

Boolean : true si la plage chevauche des cellules fusionnées. Sinon, renvoie false.

`isStartColumnBounded()`

Détermine si le début de la plage est lié à une colonne spécifique. Par exemple, pour les plages A1:B10 ou B:B, qui sont liées à des colonnes au début de la plage, cette méthode renvoie true. Pour la plage 3:7, qui n'est liée qu'à une ligne située au début de la plage, cette méthode renvoie false.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular column and logs it to the
// console.
console.log(range.isStartColumnBounded());

Aller-retour

Boolean : true si le début de la plage est lié à une colonne particulière, 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

`isStartRowBounded()`

Détermine si le début de la plage est lié à une ligne spécifique. Par exemple, pour les plages A1:B10 ou 3:7, qui sont liées aux lignes au début de la plage, cette méthode renvoie true. Pour la plage B:B, qui n'est liée qu'à une colonne spécifique au début de la plage, cette méthode renvoie false.

// Opens the spreadsheet file by its URL. If you created your script from within a
// Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range A1:D10 on Sheet1.
const range = sheet.getRange('A1:D10');

// Determines if the start of the range is bound to a particular row and logs it to the
// console.
console.log(range.isStartRowBounded());

Aller-retour

Boolean : true si le début de la plage est lié à une ligne particulière, 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

`merge()`

Fusionne les cellules de la plage en un seul bloc.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below 2-dimensionally merges the cells in A1 to B3
sheet.getRange('A1:B3').merge();

Aller-retour

Range : plage 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

`mergeAcross()`

Fusionne les cellules de la plage dans les colonnes de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The code below merges cells C5:E5 into one cell
var range1 = sheet.getRange("C5:E5");
range1.mergeAcross();

// The code below creates 2 horizontal cells, F5:H5 and F6:H6
var range2 = sheet.getRange("F5:H6");
range2.mergeAcross();

Aller-retour

Range : plage 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

`mergeVertically()`

Fusionne les cellules de la plage.

var sheet = SpreadsheetApp.getActiveSheet();

// The code below vertically merges the cells in A1 to A10
sheet.getRange('A1:A10').mergeVertically();

// The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10
sheet.getRange('B1:D10').mergeVertically();

Aller-retour

Range : plage 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

`moveTo(target)`

Coupez et collez (format et valeurs) de cette plage dans la plage cible.

// The code below moves the first 5 columns over to the 6th column
var sheet = SpreadsheetApp.getActiveSheet()
sheet.getRange("A1:E").moveTo(sheet.getRange("F1"));

Paramètres

Nom	Type	Description
`target`	`Range`	Plage cible dans laquelle copier cette plage. Seule la position de cellule supérieure gauche est pertinente.

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

`offset(rowOffset, columnOffset)`

Renvoie une nouvelle plage qui est décalée par rapport au nombre donné de lignes et de colonnes (qui peut être négatif). La nouvelle plage a la même taille que la plage d'origine.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2
var newCell = cell.offset(1, 1);

Paramètres

Nom	Type	Description
`rowOffset`	`Integer`	Nombre de lignes vers le bas à partir de la cellule supérieure gauche de la plage. Les valeurs négatives représentent les lignes situées en haut à partir de la cellule supérieure gauche de la plage.
`columnOffset`	`Integer`	Nombre de colonnes à droite de la cellule supérieure gauche de la plage. Les valeurs négatives représentent les colonnes à gauche de la cellule supérieure gauche de la plage.

Aller-retour

Range : plage pour le chaînage.

`offset(rowOffset, columnOffset, numRows)`

Renvoie une nouvelle plage relative à la plage actuelle, dont le point supérieur gauche est décalé par rapport à la plage actuelle par les lignes et colonnes données, et par la hauteur indiquée en cellules.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2:B3
var newRange = cell.offset(1, 1, 2);

Paramètres

Nom	Type	Description
`rowOffset`	`Integer`	Nombre de lignes vers le bas à partir de la cellule supérieure gauche de la plage. Les valeurs négatives représentent les lignes situées en haut à partir de la cellule supérieure gauche de la plage.
`columnOffset`	`Integer`	Nombre de colonnes à droite de la cellule supérieure gauche de la plage. Les valeurs négatives représentent les colonnes à gauche de la cellule supérieure gauche de la plage.
`numRows`	`Integer`	Hauteur en lignes de la nouvelle plage.

Aller-retour

Range : plage pour le chaînage.

`offset(rowOffset, columnOffset, numRows, numColumns)`

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("A1");

// newCell references B2:C3
var newRange = cell.offset(1, 1, 2, 2);

Paramètres

Nom	Type	Description
`rowOffset`	`Integer`	Nombre de lignes vers le bas à partir de la cellule supérieure gauche de la plage. Les valeurs négatives représentent les lignes situées en haut à partir de la cellule supérieure gauche de la plage.
`columnOffset`	`Integer`	Nombre de colonnes à droite de la cellule supérieure gauche de la plage. Les valeurs négatives représentent les colonnes à gauche de la cellule supérieure gauche de la plage.
`numRows`	`Integer`	Hauteur en lignes de la nouvelle plage.
`numColumns`	`Integer`	Largeur en colonnes de la nouvelle plage.

Aller-retour

Range : plage pour le chaînage.

`protect()`

Crée un objet pouvant empêcher la modification de la plage d'être modifiée, sauf par les utilisateurs autorisés. Tant que le script ne modifie pas réellement la liste des éditeurs de la plage (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 plage reste non protégée. Si la plage est déjà protégée, cette méthode crée une plage protégée qui chevauche la plage existante. Si une cellule est protégée par plusieurs plages protégées et que l'une d'entre elles empêche un utilisateur particulier de la modifier, cet utilisateur n'est pas autorisé à la modifier.

// Protect range A1:B10, then remove all other users from the list of editors.
var ss = SpreadsheetApp.getActive();
var range = ss.getRange('A1:B10');
var protection = range.protect().setDescription('Sample protected range');

// 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);
}

Aller-retour

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

`randomize()`

Donne l'ordre des lignes de façon aléatoire dans la plage donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Randomizes the range
range.randomize();

Aller-retour

Range : plage 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

`removeCheckboxes()`

Supprime toutes les cases à cocher de la plage. Efface la validation des données de chaque cellule et efface également sa valeur si la cellule contient la valeur cochée ou décochée.

var range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

var range1 = SpreadsheetApp.getActive().getRange('A1');
range1.setValue('yes');
// Removes the checkbox data validation in cell A1 and clears its value.
range1.removeCheckboxes();

var range2 = SpreadsheetApp.getActive().getRange('A2');
range2.setValue('random');
// Removes the checkbox data validation in cell A2 but does not clear its value.
range2.removeCheckboxes();

Aller-retour

Range : plage 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

`removeDuplicates()`

Supprime les lignes de cette plage qui contiennent des valeurs en double de n'importe quelle ligne précédente. Les lignes contenant des valeurs identiques, mais dont la casse, la mise en forme ou les formules sont différentes sont considérées comme des doublons. Cette méthode supprime également les lignes en double masquées (par exemple, en raison d'un filtre). Les contenus en dehors de cette plage ne sont pas supprimés.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B1:D7");

// Remove duplicate rows in the range.
range.removeDuplicates();

Aller-retour

Range : plage obtenue après la suppression des doublons. La taille de la plage est réduite d'une ligne pour chaque ligne supprimé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

`removeDuplicates(columnsToCompare)`

Supprime les lignes de cette plage qui contiennent des valeurs dans les colonnes spécifiées qui sont des doublons de valeurs de toute ligne précédente. Les lignes contenant des valeurs identiques, mais dont la casse, la mise en forme ou les formules sont différentes sont considérées comme des doublons. Cette méthode supprime également les lignes en double masquées (par exemple, en raison d'un filtre). Les contenus en dehors de cette plage ne sont pas supprimés.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B1:D7");

// Remove rows which have duplicate values in column B.
range.removeDuplicates([2]);

// Remove rows which have duplicate values in both columns B and D.
range.removeDuplicates([2,4]);

Paramètres

Nom	Type	Description
`columnsToCompare`	`Integer[]`	Colonnes à analyser pour détecter les valeurs en double. Si aucune colonne n'est fournie, toutes les colonnes sont analysées afin de détecter les doublons.

Aller-retour

Range : plage obtenue après la suppression des doublons. La taille de la plage est réduite d'une ligne pour chaque ligne supprimé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

`setBackground(color)`

Définit la couleur d'arrière-plan de toutes les cellules de la plage au format CSS ('#ffffff' ou 'white', par exemple).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("B2:D5");
range.setBackground("red");

Paramètres

Nom	Type	Description
`color`	`String`	Code couleur au format CSS (par exemple, `'#ffffff'` ou `'white'`) ; une valeur `null` réinitialise la couleur.

Aller-retour

Range : plage 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

`setBackgroundObject(color)`

Définit la couleur d'arrière-plan de toutes les cellules de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var bgColor = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND)
    .build();

var range = sheet.getRange("B2:D5");
range.setBackgroundObject(bgColor);

Paramètres

Nom	Type	Description
`color`	`Color`	Couleur d'arrière-plan à définir. La valeur `null` réinitialise la couleur d'arrière-plan.

Aller-retour

Range : plage 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

`setBackgroundObjects(color)`

Définit une grille rectangulaire de couleurs d'arrière-plan (doit correspondre aux dimensions de cette plage).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setBackgroundObjects(colors);

Paramètres

Nom	Type	Description
`color`	`Color[][]`	Tableau de couleurs bidimensionnel ; les valeurs `null` réinitialisent la couleur.

Aller-retour

Range : plage 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

`setBackgroundRGB(red, green, blue)`

Définit l'arrière-plan sur la couleur indiquée à l'aide de valeurs RVB (entiers compris entre 0 et 255 inclus).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");

// Sets the background to white
cell.setBackgroundRGB(255, 255, 255);

// Sets the background to red
cell.setBackgroundRGB(255, 0, 0);

Paramètres

Nom	Type	Description
`red`	`Integer`	Valeur rouge au format RVB.
`green`	`Integer`	Valeur verte au format RVB.
`blue`	`Integer`	Valeur bleue au format RVB.

Aller-retour

Range : plage 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

`setBackgrounds(color)`

Définit une grille rectangulaire de couleurs d'arrière-plan (doit correspondre aux dimensions de cette plage). Les couleurs sont au format CSS (par exemple, '#ffffff' ou 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setBackgrounds(colors);

Paramètres

Nom	Type	Description
`color`	`String[][]`	Tableau de couleurs bidimensionnel au format CSS (par exemple, `'#ffffff'` ou `'white'`). Les valeurs `null` réinitialisent la couleur.

Aller-retour

Range : plage 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

`setBorder(top, left, bottom, right, vertical, horizontal)`

Définit la propriété de la bordure. Les valeurs valides sont true (activé), false (désactivé) et null (pas de changement).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
cell.setBorder(true, null, true, null, false, false);

Paramètres

Nom	Type	Description
`top`	`Boolean`	`true` pour la bordure, `false` pour aucune valeur, `null` pour aucune modification.
`left`	`Boolean`	`true` pour la bordure, `false` pour aucune valeur, `null` pour aucune modification.
`bottom`	`Boolean`	`true` pour la bordure, `false` pour aucune valeur, `null` pour aucune modification.
`right`	`Boolean`	`true` pour la bordure, `false` pour aucune valeur, `null` pour aucune modification.
`vertical`	`Boolean`	`true` pour les bordures verticales internes, `false` pour aucun, `null` pour aucune modification.
`horizontal`	`Boolean`	`true` pour les bordures horizontales internes, `false` pour aucune, `null` pour aucune modification.

Aller-retour

Range : plage 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

`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`

Définit la propriété de la bordure avec une couleur et/ou un style. Les valeurs valides sont true (activé), false (désactivé) et null (pas de changement). Pour la couleur, utilisez la couleur en notation CSS ('#ffffff' ou 'white', par exemple).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Sets borders on the top and bottom, but leaves the left and right unchanged
// Also sets the color to "red", and the border to "DASHED".
cell.setBorder(true, null, true, null, false, false, "red", SpreadsheetApp.BorderStyle.DASHED);

Paramètres

Nom	Type	Description
`top`	`Boolean`	`true` pour la bordure, `false` pour aucune valeur, `null` pour aucune modification.
`left`	`Boolean`	`true` pour la bordure, `false` pour aucune valeur, `null` pour aucune modification.
`bottom`	`Boolean`	`true` pour la bordure, `false` pour aucune valeur, `null` pour aucune modification.
`right`	`Boolean`	`true` pour la bordure, `false` pour aucune valeur, `null` pour aucune modification.
`vertical`	`Boolean`	`true` pour les bordures verticales internes, `false` pour aucun, `null` pour aucune modification.
`horizontal`	`Boolean`	`true` pour les bordures horizontales internes, `false` pour aucune, `null` pour aucune modification.
`color`	`String`	Couleur en notation CSS (par exemple, `'#ffffff'` ou `'white'`), `null` pour la couleur par défaut (noir).
`style`	`BorderStyle`	Style pour les bordures, `null` pour le style par défaut (plein).

Aller-retour

Range : plage 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

`setDataValidation(rule)`

Définit une règle de validation des données pour toutes les cellules de la plage.

// Set the data validation rule for cell A1 to require a value from B1:B10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

Paramètres

Nom	Type	Description
`rule`	`DataValidation`	Règle de validation des données à définir, ou `null` pour supprimer la validation des données.

Aller-retour

Range : plage 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

`setDataValidations(rules)`

Définit les règles de validation des données pour toutes les cellules de la plage. Cette méthode utilise un tableau bidimensionnel de validations de données, indexées par ligne puis par colonne. Les dimensions du tableau doivent correspondre aux dimensions de la plage.

// Set the data validation rules for Sheet1!A1:B5 to require a value from Sheet2!A1:A10.
var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
var rules = destinationRange.getDataValidations();
for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

Paramètres

Nom	Type	Description
`rules`	`DataValidation[][]`	Tableau bidimensionnel des règles de validation des données à définir. Les valeurs `null` suppriment la validation des données.

Aller-retour

Range : plage 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

`setFontColor(color)`

Définit la couleur de la police au format CSS ('#ffffff' ou 'white', par exemple).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontColor("red");

Paramètres

Nom	Type	Description
`color`	`String`	Couleur de la police en notation CSS (par exemple, `'#ffffff'` ou `'white'`). Une valeur `null` réinitialise la couleur.

Aller-retour

Range : plage 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

`setFontColorObject(color)`

Définit la couleur de police de la plage donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var color = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT)
    .build();

var cell = sheet.getRange("B2");
cell.setFontColor(color);

Paramètres

Nom	Type	Description
`color`	`Color`	Couleur de police à définir. La valeur `null` réinitialise la couleur.

Aller-retour

Range : plage 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

`setFontColorObjects(colors)`

Définit une grille rectangulaire de couleurs de police (doit correspondre aux dimensions de cette plage).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colorAccent1 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
    .build();
var colorAccent2 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2)
    .build();
var colorAccent3 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3)
    .build();
var colorAccent4 = SpreadsheetApp.newColor()
    .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4)
    .build();

var colors = [
  [colorAccent1, colorAccent2],
  [colorAccent3, colorAccent4]
];

var cell = sheet.getRange("B5:C6");
cell.setFontColorObjects(colors);

Paramètres

Nom	Type	Description
`colors`	`Color[][]`	Tableau de couleurs bidimensionnel ; les valeurs `null` réinitialisent la couleur de la police.

Aller-retour

Range : plage 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

`setFontColors(colors)`

Définit une grille rectangulaire de couleurs de police (doit correspondre aux dimensions de cette plage). Les couleurs sont au format CSS (par exemple, '#ffffff' ou 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var colors = [
  ["red", "white", "blue"],
  ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents
];

var cell = sheet.getRange("B5:D6");
cell.setFontColors(colors);

Paramètres

Nom	Type	Description
`colors`	`Object[][]`	Tableau de couleurs bidimensionnel au format CSS (par exemple, `'#ffffff'` ou `'white'`). Les valeurs `null` réinitialisent la couleur.

Aller-retour

Range : plage 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

`setFontFamilies(fontFamilies)`

Définit une grille rectangulaire de familles de polices (doit correspondre aux dimensions de cette plage). Exemples de familles de polices : " Arial" ou "Helvetica".

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var fonts = [
  ["Arial", "Helvetica", "Verdana"],
  ["Courier New", "Arial", "Helvetica]
];

var cell = sheet.getRange("B2:D3");
cell.setFontFamilies(fonts);

Paramètres

Nom	Type	Description
`fontFamilies`	`Object[][]`	Tableau bidimensionnel de familles de polices ; les valeurs `null` réinitialisent la famille de polices.

Aller-retour

Range : plage 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

`setFontFamily(fontFamily)`

Définit la famille de polices, telle que " Arial" ou "Helvetica".

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontFamily("Helvetica");

Paramètres

Nom	Type	Description
`fontFamily`	`String`	Famille de polices à définir ; une valeur `null` réinitialise la famille de polices.

Aller-retour

Range : plage 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

`setFontLine(fontLine)`

Définit le style de ligne de la police de la plage donnée ('underline', 'line-through' ou 'none').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontLine("line-through");

Paramètres

Nom	Type	Description
`fontLine`	`String`	Style de ligne de la police (`'underline'`, `'line-through'` ou `'none'`). Une valeur `null` réinitialise le style de ligne de la police.

Aller-retour

Range : plage 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

`setFontLines(fontLines)`

Définit une grille rectangulaire de styles de ligne (doit correspondre aux dimensions de cette plage).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontLines = [
  ["underline", "line-through", "none"]
];

var range = sheet.getRange("B2:D2");
range.setFontLines(fontLines);

Paramètres

Nom	Type	Description
`fontLines`	`Object[][]`	Tableau bidimensionnel de styles de ligne de police (`'underline'`, `'line-through'` ou `'none'`). Les valeurs `null` réinitialisent le style de ligne de la police.

Aller-retour

Range : plage 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

`setFontSize(size)`

Définit la taille de la police, qui correspond à la taille en points à utiliser.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontSize(20);

Paramètres

Nom	Type	Description
`size`	`Integer`	Taille de la police en points.

Aller-retour

Range : plage 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

`setFontSizes(sizes)`

Définit une grille rectangulaire des tailles de police (elles doivent correspondre aux dimensions de cette plage). Les tailles sont exprimées en points.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontSizes = [
  [16, 20, 24]
];

var range = sheet.getRange("B2:D2");
range.setFontSizes(fontSizes);

Paramètres

Nom	Type	Description
`sizes`	`Object[][]`	Tableau bidimensionnel de tailles.

Aller-retour

Range : plage 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

`setFontStyle(fontStyle)`

Définissez le style de police pour la plage donnée ('italic' ou 'normal').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontStyle("italic");

Paramètres

Nom	Type	Description
`fontStyle`	`String`	Style de police, `'italic'` ou `'normal'`. Une valeur `null` réinitialise le style de police.

Aller-retour

Range : plage 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

`setFontStyles(fontStyles)`

Définit une grille rectangulaire de styles de police (doit correspondre aux dimensions de cette plage).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  ["italic", "normal"]
];

var range = sheet.getRange("B2:C2");
range.setFontStyles(fontStyles);

Paramètres

Nom	Type	Description
`fontStyles`	`Object[][]`	Tableau bidimensionnel de styles de police, `'italic'` ou `'normal'`. Les valeurs `null` réinitialisent le style de police.

Aller-retour

Range : plage 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

`setFontWeight(fontWeight)`

Définissez l'épaisseur de la police pour la plage donnée (normal/gras).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setFontWeight("bold");

Paramètres

Nom	Type	Description
`fontWeight`	`String`	Épaisseur de la police, `'bold'` ou `'normal'`. Une valeur `null` réinitialise l'épaisseur de police.

Aller-retour

Range : plage 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

`setFontWeights(fontWeights)`

Définit une grille rectangulaire d'épaisseurs de police (doit correspondre aux dimensions de cette plage). La valeur "gras" est un exemple d'épaisseur de police.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var fontStyles = [
  [ "bold", "bold", "normal" ]
];

var range = sheet.getRange("B2:D2");
range.setFontWeights(fontStyles);

Paramètres

Nom	Type	Description
`fontWeights`	`Object[][]`	Tableau bidimensionnel des épaisseurs de police, `'bold'` ou `'normal'`. Les valeurs `null` réinitialisent l'épaisseur de police.

Aller-retour

Range : plage 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

`setFormula(formula)`

Met à jour la formule pour cette plage. La formule donnée doit utiliser la notation A1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
cell.setFormula("=SUM(B3:B4)");

Paramètres

Nom	Type	Description
`formula`	`String`	Chaîne représentant la formule à définir pour la cellule.

Aller-retour

Range : plage 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

`setFormulaR1C1(formula)`

Met à jour la formule pour cette plage. La formule donnée doit utiliser la notation R1C1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B5");
// This sets the formula to be the sum of the 3 rows above B5
cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");

Paramètres

Nom	Type	Description
`formula`	`String`	Formule de chaîne.

Aller-retour

Range : plage 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

`setFormulas(formulas)`

Définit une grille rectangulaire de formules (doit correspondre aux dimensions de cette plage). Les formules données doivent utiliser la notation A1. Cette méthode utilise un tableau de formules à deux dimensions, indexé par ligne, puis par colonne. Les dimensions du tableau doivent correspondre à celles de la plage.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This sets the formulas to be a row of sums, followed by a row of averages right below.
// The size of the two-dimensional array must match the size of the range.
var formulas = [
  ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"],
  ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"]
];

var cell = sheet.getRange("B5:D6");
cell.setFormulas(formulas);

Paramètres

Nom	Type	Description
`formulas`	`String[][]`	Tableau de formules à deux dimensions sous forme de chaîne.

Aller-retour

Range : plage 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

`setFormulasR1C1(formulas)`

Définit une grille rectangulaire de formules (doit correspondre aux dimensions de cette plage). Les formules données doivent utiliser la notation R1C1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This creates formulas for a row of sums, followed by a row of averages.
var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])";
var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])";

// The size of the two-dimensional array must match the size of the range.
var formulas = [
  [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove],
  [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove]
];

var cell = sheet.getRange("B5:D6");
// This sets the formula to be the sum of the 3 rows above B5.
cell.setFormulasR1C1(formulas);

Paramètres

Nom	Type	Description
`formulas`	`String[][]`	Tableau de formules bidimensionnel au format R1C1.

Aller-retour

Range : plage 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

`setHorizontalAlignment(alignment)`

Définissez l'alignement horizontal (de gauche à droite) pour la plage donnée (gauche/centre/droite).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setHorizontalAlignment("center");

Paramètres

Nom	Type	Description
`alignment`	`String`	Alignement (`'left'`, `'center'` ou `'normal'`). Une valeur `null` réinitialise l'alignement.

Aller-retour

Range : plage 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

`setHorizontalAlignments(alignments)`

Définit une grille rectangulaire d'alignements horizontaux. Voir setHorizontalAlignment(alignment)

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var horizontalAlignments = [
  [ "left", "right", "center" ]
];

var range = sheet.getRange("B2:D2");
range.setHorizontalAlignments(horizontalAlignments);

Paramètres

Nom	Type	Description
`alignments`	`Object[][]`	Tableau d'alignements à deux dimensions, `'left'`, `'center'` ou `'normal'`. La valeur `null` réinitialise l'alignement.

Aller-retour

Range : plage 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

Voir aussi

setHorizontalAlignment(alignment)

`setNote(note)`

Définit la note sur la valeur donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setNote("This is a note");

Paramètres

Nom	Type	Description
`note`	`String`	Valeur de note à définir pour la plage. Une valeur `null` supprime la note.

Aller-retour

Range : plage 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

`setNotes(notes)`

Définit une grille de notes rectangulaire (doit correspondre aux dimensions de cette plage).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var notes = [
  ["it goes", "like this", "the fourth, the fifth"],
  ["the minor fall", "and the", "major lift"]
];

var cell = sheet.getRange("B2:D3");
cell.setNotes(notes)

Paramètres

Nom	Type	Description
`notes`	`Object[][]`	Tableau de notes à deux dimensions ; les valeurs `null` suppriment la note.

Aller-retour

Range : plage 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

Voir aussi

setNote(note)

`setNumberFormat(numberFormat)`

Définit le format du nombre ou de la date sur la chaîne de mise en forme indiquée. Les modèles de format acceptés sont décrits dans la documentation de l'API Sheets.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
// Always show 3 decimal points
cell.setNumberFormat("0.000");

Paramètres

Nom	Type	Description
`numberFormat`	`String`	Chaîne de format numérique.

Aller-retour

Range : plage 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

`setNumberFormats(numberFormats)`

Définit une grille rectangulaire de formats numériques ou de dates (doit correspondre aux dimensions de cette plage). Les valeurs sont des chaînes de modèle de format, comme décrit dans la documentation de l'API Sheets.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var formats = [
  [ "0.000", "0,000,000", "$0.00" ]
];

var range = sheet.getRange("B2:D2");
range.setNumberFormats(formats);

Paramètres

Nom	Type	Description
`numberFormats`	`Object[][]`	Tableau bidimensionnel de formats numériques.

Aller-retour

Range : plage 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

`setRichTextValue(value)`

Définit la valeur du texte enrichi pour les cellules de la plage.

// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var richText = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
range.setRichTextValue(richText);

Paramètres

Nom	Type	Description
`value`	`RichTextValue`	Valeur de texte enrichi souhaitée.

Aller-retour

Range : plage 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

`setRichTextValues(values)`

Définit une grille rectangulaire de valeurs de texte enrichi.

// Sets the cells in range A1:A2 to have Rich Text values.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:A2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var italic = SpreadsheetApp.newTextStyle()
    .setItalic(true)
    .build();
var richTextA1 = SpreadsheetApp.newRichTextValue()
    .setText("This cell is bold")
    .setTextStyle(bold)
    .build();
var richTextA2 = SpreadsheetApp.newRichTextValue()
    .setText("bold words, italic words")
    .setTextStyle(0, 11, bold)
    .setTextStyle(12, 24, italic)
    .build();
range.setRichTextValues([[richTextA1], [richTextA2]]);

Paramètres

Nom	Type	Description
`values`	`RichTextValue[][]`	Valeurs du texte enrichi souhaité.

Aller-retour

Range : plage 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

`setShowHyperlink(showHyperlink)`

Détermine si la plage doit afficher des liens hypertextes.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A30 and sets its hyperlink value.
const range = sheet.getRange('A30');
range.setValue('https://www.example.com');

// Sets cell A30 to show hyperlinks.
range.setShowHyperlink(true);

Paramètres

Nom	Type	Description
`showHyperlink`	`Boolean`	Afficher ou non le lien hypertexte.

Aller-retour

Range : plage 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

`setTextDirection(direction)`

Définit l'orientation du texte des cellules de la plage. Si une direction spécifiée est null, elle est déduite, puis définie.

// Sets right-to-left text direction for the range.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B5:C6");
range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Paramètres

Nom	Type	Description
`direction`	`TextDirection`	Orientation du texte souhaitée. Si la valeur est `null`, l'orientation est déduite avant la définition.

Aller-retour

Range : plage 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

`setTextDirections(directions)`

Définit une grille rectangulaire d'orientations de texte. Si une direction spécifiée est null, elle est déduite, puis définie.

// Copies all of the text directions from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextDirections());

Paramètres

Nom	Type	Description
`directions`	`TextDirection[][]`	Orientation du texte souhaitée. Si vous spécifiez l'orientation `null`, elle est déduite avant le réglage.

Aller-retour

Range : plage 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

`setTextRotation(degrees)`

Définit les paramètres de rotation du texte pour les cellules de la plage. L'entrée correspond à l'angle entre l'orientation du texte standard et l'orientation souhaitée. Une entrée égale à zéro indique que le texte est défini sur l'orientation standard.

Pour le texte de gauche à droite, les angles positifs sont dans le sens antihoraire.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setTextRotation(45);

Paramètres

Nom	Type	Description
`degrees`	`Integer`	Angle souhaité entre l'orientation standard et l'orientation souhaitée. Pour le texte de gauche à droite, les angles positifs sont dans le sens inverse des aiguilles d'une montre.

Aller-retour

Range : plage 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

`setTextRotation(rotation)`

Définit les paramètres de rotation du texte pour les cellules de la plage.

// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1.
var sheet = SpreadsheetApp.getActiveSheet();

var rotation = sheet.getRange("A1").getTextRotation();

sheet.getRange("B2:D4").setTextRotation(rotation);

Paramètres

Nom	Type	Description
`rotation`	`TextRotation`	Paramètres de rotation du texte souhaités.

Aller-retour

Range : plage 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

`setTextRotations(rotations)`

Définit une grille rectangulaire des rotations de texte.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setTextRotations(range1.getTextRotations());

Paramètres

Nom	Type	Description
`rotations`	`TextRotation[][]`	Paramètres de rotation du texte souhaités.

Aller-retour

Range : plage 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

`setTextStyle(style)`

Définit le style du texte des cellules de la plage.

// Sets the cells in range C5:D6 to have underlined size 15 font.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("C5:D6");
var style = SpreadsheetApp.newTextStyle()
    .setFontSize(15)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

Paramètres

Nom	Type	Description
`style`	`TextStyle`	Style de texte souhaité.

Aller-retour

Range : plage 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

`setTextStyles(styles)`

Définit une grille rectangulaire de styles de texte.

// Sets text styles for cells in range A1:B2
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B2");
var bold = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .build();
var otherStyle = SpreadsheetApp.newTextStyle()
    .setBold(true)
    .setUnderline(true)
    .setItalic(true)
    .setForegroundColor("#335522")
    .setFontSize(44)
    .build();
range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);

Paramètres

Nom	Type	Description
`styles`	`TextStyle[][]`	Styles de texte souhaités

Aller-retour

Range : plage 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

`setValue(value)`

Définit la valeur de la plage. Cette valeur peut être numérique, chaîne, booléenne ou date. S'il commence par '=', il est interprété comme une formule.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setValue(100);

Paramètres

Nom	Type	Description
`value`	`Object`	Valeur de la plage.

Aller-retour

Range : plage 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

`setValues(values)`

Définit une grille rectangulaire de valeurs (doit correspondre aux dimensions de cette plage). Si une valeur commence par =, elle est interprétée comme une formule.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var values = [
  [ "2.000", "1,000,000", "$2.99" ]
];

var range = sheet.getRange("B2:D2");
range.setValues(values);

Paramètres

Nom	Type	Description
`values`	`Object[][]`	Tableau de valeurs à deux dimensions.

Aller-retour

Range : plage 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

`setVerticalAlignment(alignment)`

Définissez l'alignement vertical (de haut en bas) pour la plage donnée (haut/milieu/bas).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setVerticalAlignment("middle");

Paramètres

Nom	Type	Description
`alignment`	`String`	Alignement (`'top'`, `'middle'` ou `'bottom'`). Une valeur `null` réinitialise l'alignement.

Aller-retour

Range : plage 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

`setVerticalAlignments(alignments)`

Définit une grille rectangulaire d'alignements verticaux (doit correspondre aux dimensions de cette plage).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var alignments = [
  [ "top", "middle", "bottom" ]
];

var range = sheet.getRange("B2:D2");
range.setVerticalAlignments(alignments);

Paramètres

Nom	Type	Description
`alignments`	`Object[][]`	Tableau d'alignements à deux dimensions, `'top'`, `'middle'` ou `'bottom'`. La valeur `null` réinitialise l'alignement.

Aller-retour

Range : plage 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

Voir aussi

setVerticalAlignment(alignment)

`setVerticalText(isVertical)`

Détermine si le texte des cellules de la plage doit être empilé ou non. Si le texte est empilé verticalement, le paramètre de degré de rotation du texte est ignoré.

// Sets all cell's in range B2:D4 to have vertically stacked text.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setVerticalText(true);

Paramètres

Nom	Type	Description
`isVertical`	`Boolean`	Indique si le texte doit être empilé ou non.

Aller-retour

Range : plage 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

`setWrap(isWrapEnabled)`

Définit le retour automatique à la ligne de la plage donnée.

Les cellules pour lesquelles le retour automatique à la ligne est activé (par défaut) sont redimensionnées pour afficher tout leur contenu. Les cellules pour lesquelles l'encapsulation est désactivé s'affichent autant que possible dans la cellule sans être redimensionnées ni exécutées sur plusieurs lignes.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var cell = sheet.getRange("B2");
cell.setWrap(true);

Paramètres

Nom	Type	Description
`isWrapEnabled`	`Boolean`	Indique si le texte doit être renvoyé à la ligne.

Aller-retour

Range : plage 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

`setWrapStrategies(strategies)`

Définit une grille rectangulaire de stratégies de retour à la ligne.

// Copies all of the wrap strategies from range A1:B2 over to range C5:D6.
var sheet = SpreadsheetApp.getActiveSheet();
var range1 = sheet.getRange("A1:B2");
var range2 = sheet.getRange("C5:D6");

range2.setWrapStrategies(range1.getWrapStrategies());

Paramètres

Nom	Type	Description
`strategies`	`WrapStrategy[][]`	Stratégies d'encapsulation souhaitées.

Aller-retour

Range : plage 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

`setWrapStrategy(strategy)`

Définit la stratégie de retour à la ligne automatique pour les cellules de la plage.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("B2:D4");

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Paramètres

Nom	Type	Description
`strategy`	`WrapStrategy`	Stratégie d'enveloppement souhaitée.

Aller-retour

Range : plage 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

`setWraps(isWrapEnabled)`

Définit une grille rectangulaire de règles de retour à la ligne (doit correspondre aux dimensions de cette plage). Les cellules pour lesquelles l'encapsulation est activée (par défaut) sont redimensionnées pour afficher tout leur contenu. Les cellules pour lesquelles l'encapsulation est désactivé s'affichent autant que possible dans la cellule, sans redimensionnement ni s'exécuter sur plusieurs lignes.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The size of the two-dimensional array must match the size of the range.
var wraps = [
  [ true, true, false ]
];

var range = sheet.getRange("B2:D2");
range.setWraps(wraps);

Paramètres

Nom	Type	Description
`isWrapEnabled`	`Object[][]`	Tableau bidimensionnel de variables d'encapsulation qui déterminent si le texte doit être encapsulé ou non dans une cellule.

Aller-retour

Range : plage 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

Voir aussi

setWrap(isWrapEnabled)

`shiftColumnGroupDepth(delta)`

Modifie la profondeur de regroupement de colonnes de la plage selon la valeur spécifiée.

Cette opération entraîne la création, la modification ou la suppression de groupes qui se recoupent avec la plage. Pour les deltas positifs, les groupes sont créés et/ou modifiés. Pour les deltas négatifs, les groupes sont détruits et/ou modifiés.

Cela n'a aucun effet lorsque la profondeur du groupe passe en dessous de zéro ou au-dessus de huit.

Si column group control position est défini sur BEFORE, une erreur est générée lorsque vous tentez de modifier la profondeur de la première ligne.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The column grouping depth is increased by 1.
range.shiftColumnGroupDepth(1);

// The column grouping depth is decreased by 1.
range.shiftColumnGroupDepth(-1);

Paramètres

Nom	Type	Description
`delta`	`Integer`	Quantité selon laquelle modifier la profondeur du groupe de colonnes pour cette plage.

Aller-retour

Range : plage pour le chaînage.

Génère

Error : lors de la tentative de changement de la profondeur de la première colonne lorsque la position de commande est GroupControlTogglePosition.BEFORE

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

`shiftRowGroupDepth(delta)`

Modifie la profondeur de regroupement des lignes de la plage selon la valeur spécifiée.

Cela n'a aucun effet lorsque la profondeur du groupe passe en dessous de zéro ou au-dessus de huit.

Si row group control position est défini sur BEFORE, une erreur est générée lorsque vous tentez de modifier la profondeur de la première ligne.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getActiveRange();

// The row grouping depth is increased by 1.
range.shiftRowGroupDepth(1);

// The row grouping depth is decreased by 1.
range.shiftRowGroupDepth(-1);

Paramètres

Nom	Type	Description
`delta`	`Integer`	Quantité de modification de la profondeur du groupe de lignes pour cette plage.

Aller-retour

Range : plage pour le chaînage.

Génère

Error : lors d'une tentative de changement de la profondeur de la première ligne lorsque la position de commande est GroupControlTogglePosition.BEFORE

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(sortSpecObj)`

Trie les cellules de la plage donnée, par colonne et par ordre spécifié.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("A1:C7");

// Sorts by the values in the first column (A)
range.sort(1);

// Sorts by the values in the second column (B)
range.sort(2);

// Sorts descending by column B
range.sort({column: 2, ascending: false});

// Sorts descending by column B, then ascending by column A
// Note the use of an array
range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]);

// For rows that are sorted in ascending order, the "ascending" parameter is
// optional, and just an integer with the column can be used instead. Note that
// in general, keeping the sort specification consistent results in more readable
// code. You can express the earlier sort as:
range.sort([{column: 2, ascending: false}, 1]);

// Alternatively, if you want all columns to be in ascending order, you can use
// the following (this makes column 2 ascending)
range.sort([2, 1]);
// ... which is equivalent to
range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);

Paramètres

Nom	Type	Description
`sortSpecObj`	`Object`	Colonnes à utiliser pour le tri.

Aller-retour

Range : plage 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

`splitTextToColumns()`

Divise une colonne de texte en plusieurs colonnes en fonction d'un délimiteur détecté automatiquement.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one,one,one      |                 |                 |
// 2 |two,two,two      |                 |                 |
// 3 |three,three,three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns();

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

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

`splitTextToColumns(delimiter)`

Divise une colonne de texte en plusieurs colonnes en utilisant la chaîne spécifiée comme délimiteur personnalisé.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one#one#one      |                 |                 |
// 2 |two#two#two      |                 |                 |
// 3 |three#three#three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns('#');

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Paramètres

Nom	Type	Description
`delimiter`	`String`	Délimiteur personnalisé à utiliser pour la division.

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

`splitTextToColumns(delimiter)`

Divise une colonne de texte en plusieurs colonnes en fonction du délimiteur spécifié.

// A1:A3 has the following values:
//           A                  B                 C
// 1 |one;one;one      |                 |                 |
// 2 |two;two;two      |                 |                 |
// 3 |three;three;three|                 |                 |

var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3");
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after spliting the text to columns:
//           A                  B                 C
// 1 |one              |one              |one              |
// 2 |two              |two              |two              |
// 3 |three            |three            |three            |

Paramètres

Nom	Type	Description
`delimiter`	`TextToColumnsDelimiter`	Délimiteur prédéfini à utiliser pour la division.

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

`trimWhitespace()`

Supprime les espaces blancs (espaces, tabulations ou sauts de ligne, par exemple) dans chaque cellule de la plage. Supprime tous les espaces au début et à la fin du texte de chaque cellule, et réduit à un seul espace toute sous-séquence de caractères d'espace blanc restants.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange('A1:A4');
range.activate();
range.setValues(
    [' preceding space', 'following space ', 'two  middle  spaces', '   =SUM(1,2)'])

range.trimWhitespace();

var values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']

Aller-retour

Range : plage 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

`uncheck()`

Redéfinit l'état des cases à cocher de la plage sur "Décoché". Ignore les cellules de la plage qui ne contiennent actuellement ni la valeur cochée, ni la valeur décochée.

// Changes the state of cells which currently contain either the checked or unchecked value
// configured in the range A1:B10 to 'unchecked'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.uncheck();

Aller-retour

Range : plage 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

Méthodes obsolètes

`getFontColor()`

Obsolète. Remplacé par getFontColorObject()

Renvoie la couleur de police de la cellule située dans l'angle supérieur gauche de la plage, au format CSS (par exemple, '#ffffff' ou 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

Logger.log(range.getFontColor());

Aller-retour

String : couleur de la police au format CSS (par exemple, '#ffffff' ou 'white').

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

`getFontColors()`

Obsolète. Remplacé par getFontColorObjects()

Renvoie les couleurs de police des cellules de la plage au format CSS (par exemple, '#ffffff' ou 'white').

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
var range = sheet.getRange("B2:D4");

var results = range.getFontColors();

for (var i in results) {
  for (var j in results[i]) {
    Logger.log(results[i][j]);
  }
}

Aller-retour

String[][] : tableau bidimensionnel de couleurs de police associées aux cellules de la plage.

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