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

Class Range

Accéder aux plages de feuilles de calcul et les modifier Une plage peut être une seule cellule 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 comme `active range`, avec la cellule en haut à gauche de la plage comme `current cell`.
`activateAsCurrentCell()`	`Range`	Définit la cellule spécifiée comme `current cell`.
`addDeveloperMetadata(key)`	`Range`	Ajoute des métadonnées de développeur avec la clé spécifiée à la plage.
`addDeveloperMetadata(key, visibility)`	`Range`	Ajoute des métadonnées de développeur avec la clé et la visibilité spécifiées à la plage.
`addDeveloperMetadata(key, value)`	`Range`	Ajoute des métadonnées de développement avec la clé et la valeur spécifiées à la plage.
`addDeveloperMetadata(key, value, visibility)`	`Range`	Ajoute des métadonnées de développement à la plage avec la clé, la valeur et la visibilité spécifiées.
`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 avec les paramètres d'en-tête et de pied de page 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 les paramètres d'en-tête et de pied de page spécifiés.
`autoFill(destination, series)`	`void`	Remplit `destinationRange` avec des données basées sur celles de cette plage.
`autoFillToNeighbor(series)`	`void`	Calcule une plage à remplir avec de nouvelles données en fonction des cellules voisines et remplit automatiquement cette plage avec de nouvelles valeurs en fonction des données qu'elle contient.
`breakApart()`	`Range`	Répartissez à nouveau les cellules multicolonnes de la plage en cellules individuelles.
`canEdit()`	`Boolean`	Détermine si l'utilisateur est autorisé à modifier chaque cellule de la plage.
`check()`	`Range`	Définit l'état des cases à cocher de la plage sur "cochée".
`clear()`	`Range`	Efface la gamme 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, tout en conservant la mise en forme.
`clearDataValidations()`	`Range`	Efface les règles de validation des données pour la plage.
`clearFormat()`	`Range`	Supprime la mise en forme de cette plage.
`clearNote()`	`Range`	Efface la note dans la ou les cellules données.
`collapseGroups()`	`Range`	Réduit tous les groupes entièrement compris dans la plage.
`copyFormatToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copier la mise en forme de la plage à l'emplacement donné
`copyFormatToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copier la mise en forme de la plage à l'emplacement donné
`copyTo(destination)`	`void`	Copier les données d'une plage de cellules vers une autre
`copyTo(destination, copyPasteType, transposed)`	`void`	Copier les données d'une plage de cellules vers une autre
`copyTo(destination, options)`	`void`	Copier les données d'une plage de cellules vers une autre
`copyValuesToRange(gridId, column, columnEnd, row, rowEnd)`	`void`	Copiez le contenu de la plage à l'emplacement donné.
`copyValuesToRange(sheet, column, columnEnd, row, rowEnd)`	`void`	Copiez le contenu de la plage à l'emplacement donné.
`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 un DeveloperMetadataFinderApi pour rechercher des 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 l'`sourceData` spécifié 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 la plage ou le bouton de contrôle intersecte cette plage.
`getA1Notation()`	`String`	Renvoie une description de la plage sous forme de chaîne, dans la notation A1.
`getBackground()`	`String`	Renvoie la couleur d'arrière-plan de la cellule supérieure gauche de la plage (par exemple, `'#ffffff'`).
`getBackgroundObject()`	`Color`	Renvoie la couleur d'arrière-plan de la cellule supérieure 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 tous les bandes appliquées à toutes les cellules de cette plage.
`getCell(row, column)`	`Range`	Affiche 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 développée dans les quatre `Direction`s cardinaux pour couvrir toutes les cellules adjacentes contenant des données.
`getDataRegion(dimension)`	`Range`	Renvoie une copie de la plage développée `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 `DataSourceFormula` de 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 `DataSourceFormula` des cellules de la plage.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Récupère tous les tableaux croisés dynamiques de la source de données qui se croisent avec la plage.
`getDataSourceTables()`	`DataSourceTable[]`	Récupère toutes les tables de sources de données qui se croisent avec la plage.
`getDataSourceUrl()`	`String`	Renvoie une URL pour les données de cette plage, que vous pouvez utiliser pour créer des graphiques et des requêtes.
`getDataTable()`	`DataTable`	Renvoyez les données de cet objet sous la forme d'une DataTable.
`getDataTable(firstRowIsHeader)`	`DataTable`	Renvoie les données de cette plage sous forme de DataTable.
`getDataValidation()`	`DataValidation`	Renvoie la règle de validation des données pour la cellule en haut à gauche de la plage.
`getDataValidations()`	`DataValidation[][]`	Renvoie les règles de validation des données pour toutes les cellules de la plage.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Récupère les métadonnées du développeur 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 de la feuille à laquelle cette plage appartient, ou `null` s'il n'y a pas de filtre sur la feuille.
`getFontColorObject()`	`Color`	Renvoie la couleur de la police de la cellule en haut à 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 située en haut à gauche de la plage.
`getFontLine()`	`String`	Récupère le style de ligne de la cellule en haut à 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 en haut à 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 en haut à gauche de la plage.
`getFontStyles()`	`String[][]`	Renvoie les styles de police des cellules de la plage.
`getFontWeight()`	`String`	Renvoie l'épaisseur de la police (normale/en gras) de la cellule en haut à gauche de la plage.
`getFontWeights()`	`String[][]`	Affiche les épaisseurs de police des cellules de la plage.
`getFormula()`	`String`	Renvoie la formule (notation A1) de la cellule en haut à 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) d'une cellule donnée, ou `null` si aucune formule n'est définie.
`getFormulas()`	`String[][]`	Renvoie les formules (notation A1) des cellules de la plage.
`getFormulasR1C1()`	`String[][]`	Renvoie les formules (notation R1C1) des cellules de la plage.
`getGridId()`	`Integer`	Renvoie l'ID de la 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 en haut à gauche de la plage.
`getHorizontalAlignments()`	`String[][]`	Affiche les alignements horizontaux des cellules de la plage.
`getLastColumn()`	`Integer`	Renvoie la position de la colonne de fin.
`getLastRow()`	`Integer`	Renvoie la position de la dernière ligne.
`getMergedRanges()`	`Range[]`	Renvoie un tableau d'objets `Range` représentant des cellules fusionnées qui se trouvent entièrement dans la plage actuelle ou qui contiennent au moins une cellule de la plage actuelle.
`getNextDataCell(direction)`	`Range`	À partir de la cellule de la première colonne et de la première ligne de la plage, renvoie la cellule suivante dans la direction donnée, qui est le bord d'une plage contiguë de cellules contenant des données ou la cellule au bord de la feuille de calcul dans cette direction.
`getNote()`	`String`	Renvoie la note associée à la plage donnée.
`getNotes()`	`String[][]`	Renvoie les notes associées aux cellules de la plage.
`getNumColumns()`	`Integer`	Renvoie le nombre de colonnes de cette plage.
`getNumRows()`	`Integer`	Renvoie le nombre de lignes dans cette plage.
`getNumberFormat()`	`String`	Obtenez la mise en forme des nombres ou des dates de la cellule en haut à gauche de la plage donnée.
`getNumberFormats()`	`String[][]`	Renvoie les formats de nombre ou de date des cellules de la plage.
`getRichTextValue()`	`RichTextValue`	Renvoie la valeur de texte enrichi pour la cellule en haut à 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 pour les cellules de la plage.
`getRow()`	`Integer`	Renvoie la position de ligne de cette plage.
`getRowIndex()`	`Integer`	Renvoie la position de ligne de cette plage.
`getSheet()`	`Sheet`	Renvoie la feuille à laquelle cette plage appartient.
`getTextDirection()`	`TextDirection`	Renvoie le sens du texte pour la cellule supérieure gauche de la plage.
`getTextDirections()`	`TextDirection[][]`	Renvoie l'orientation du texte pour les 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[][]`	Affiche 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 située en haut à 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 de la cellule est mis en retour à la ligne.
`getWrapStrategies()`	`WrapStrategy[][]`	Renvoie les stratégies de retour à la ligne pour les cellules de la plage.
`getWrapStrategy()`	`WrapStrategy`	Renvoie la stratégie de retour à la ligne pour la cellule supérieure gauche de la plage.
`getWraps()`	`Boolean[][]`	Indique si le texte des cellules est mis en forme avec retour à 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 décochées.
`insertCheckboxes(checkedValue)`	`Range`	Insère des cases à cocher dans chaque cellule de la plage, configurées avec une valeur personnalisée pour les cases cochées et la chaîne vide pour les cases décochées.
`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 décochés.
`isBlank()`	`Boolean`	Renvoie `true` si la plage est totalement vide.
`isChecked()`	`Boolean`	Indique si l'état de la case à cocher de toutes les cellules de la plage est "coché".
`isEndColumnBounded()`	`Boolean`	Détermine si la fin de la plage est liée à une colonne spécifique.
`isEndRowBounded()`	`Boolean`	Indique si la fin de la plage est liée à une ligne spécifique.
`isPartOfMerge()`	`Boolean`	Renvoie `true` si les cellules de la plage active chevauchent des cellules fusionnées.
`isStartColumnBounded()`	`Boolean`	Indique si le début de la plage est lié à une colonne spécifique.
`isStartRowBounded()`	`Boolean`	Indique 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`	Fusionnez 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 (à la fois le format et les valeurs) cette plage dans la plage cible.
`offset(rowOffset, columnOffset)`	`Range`	Renvoie une nouvelle plage décalée par rapport à cette plage du nombre de lignes et de colonnes donné (qui peut être négatif).
`offset(rowOffset, columnOffset, numRows)`	`Range`	Renvoie une nouvelle plage par rapport à la plage actuelle, dont le point en haut à gauche est décalé par rapport à la plage actuelle par les lignes et colonnes données, et avec la hauteur donnée en cellules.
`offset(rowOffset, columnOffset, numRows, numColumns)`	`Range`	Renvoie une nouvelle plage par rapport à 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 avec la hauteur et la largeur données en cellules.
`protect()`	`Protection`	Crée un objet qui peut empêcher la modification de la plage, sauf par les utilisateurs autorisés.
`randomize()`	`Range`	Ordonne de manière aléatoire les lignes de 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 celles d'une 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 d'une ligne précédente.
`setBackground(color)`	`Range`	Définit la couleur d'arrière-plan de toutes les cellules de la plage dans la notation CSS (par exemple, `'#ffffff'` ou `'white'`).
`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 (elle doit correspondre aux dimensions de cette plage).
`setBackgroundRGB(red, green, blue)`	`Range`	Définit l'arrière-plan sur la couleur donné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 (elle doit correspondre aux dimensions de cette plage).
`setBorder(top, left, bottom, right, vertical, horizontal)`	`Range`	Définit la propriété de bordure.
`setBorder(top, left, bottom, right, vertical, horizontal, color, style)`	`Range`	Définit la propriété de 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 en notation CSS (par exemple, `'#ffffff'` ou `'white'`).
`setFontColorObject(color)`	`Range`	Définit la couleur de la police de la plage donnée.
`setFontColorObjects(colors)`	`Range`	Définit une grille rectangulaire de couleurs de police (elle doit correspondre aux dimensions de cette plage).
`setFontColors(colors)`	`Range`	Définit une grille rectangulaire de couleurs de police (elle doit correspondre aux dimensions de cette plage).
`setFontFamilies(fontFamilies)`	`Range`	Définit une grille rectangulaire de familles de polices (elle doit correspondre aux dimensions de cette plage).
`setFontFamily(fontFamily)`	`Range`	Définit la famille de polices, par exemple "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 (elle 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 de tailles de police (elle doit correspondre aux dimensions de cette plage).
`setFontStyle(fontStyle)`	`Range`	Définit le style de police pour la plage donnée (`'italic'` ou `'normal'`).
`setFontStyles(fontStyles)`	`Range`	Définit une grille rectangulaire de styles de police (elle doit correspondre aux dimensions de cette plage).
`setFontWeight(fontWeight)`	`Range`	Définit l'épaisseur de la police pour la plage donnée (normal/gras).
`setFontWeights(fontWeights)`	`Range`	Définit une grille rectangulaire de poids de police (elle doit correspondre aux dimensions de cette plage).
`setFormula(formula)`	`Range`	Met à jour la formule de cette plage.
`setFormulaR1C1(formula)`	`Range`	Met à jour la formule de cette plage.
`setFormulas(formulas)`	`Range`	Définit une grille rectangulaire de formules (elle doit correspondre aux dimensions de cette plage).
`setFormulasR1C1(formulas)`	`Range`	Définit une grille rectangulaire de formules (elle 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 donnée.
`setNotes(notes)`	`Range`	Définit une grille rectangulaire de notes (elle doit correspondre aux dimensions de cette plage).
`setNumberFormat(numberFormat)`	`Range`	Définit le format de nombre ou de date sur la chaîne de formatage donnée.
`setNumberFormats(numberFormats)`	`Range`	Définit une grille rectangulaire de formats de nombre ou de date (elle 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`	Indique si la plage doit afficher ou non des liens hypertextes.
`setTextDirection(direction)`	`Range`	Définit le sens du texte pour les cellules de la plage.
`setTextDirections(directions)`	`Range`	Définit une grille rectangulaire de sens du 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 de rotations de texte.
`setTextStyle(style)`	`Range`	Définit le style de texte pour les 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 (elle doit correspondre aux dimensions de cette plage).
`setVerticalAlignment(alignment)`	`Range`	Définit 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 (elle doit correspondre aux dimensions de cette plage).
`setVerticalText(isVertical)`	`Range`	Indique si le texte des cellules de la plage doit être empilé ou non.
`setWrap(isWrapEnabled)`	`Range`	Définit le retour à la ligne des cellules 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 pour les cellules de la plage.
`setWraps(isWrapEnabled)`	`Range`	Définit une grille rectangulaire de règles de retour à la ligne (elle doit correspondre aux dimensions de cette plage).
`shiftColumnGroupDepth(delta)`	`Range`	Modifie la profondeur de regroupement des colonnes de la plage selon la valeur spécifiée.
`shiftRowGroupDepth(delta)`	`Range`	Modifie la hauteur du 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 dans l'ordre spécifié.
`splitTextToColumns()`	`void`	Fractionne une colonne de texte en plusieurs colonnes en fonction d'un délimiteur détecté automatiquement.
`splitTextToColumns(delimiter)`	`void`	Fractionne une colonne de texte en plusieurs colonnes à l'aide de la chaîne spécifiée comme délimiteur personnalisé.
`splitTextToColumns(delimiter)`	`void`	Fractionne une colonne de texte en plusieurs colonnes en fonction du délimiteur spécifié.
`trimWhitespace()`	`Range`	Élimine les espaces blancs (tels que les espaces, les tabulations ou les sauts de ligne) de chaque cellule de cette plage.
`uncheck()`	`Range`	Désactive les cases à cocher de la plage.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`getFontColor()`	`String`	Renvoie la couleur de la police de la cellule en haut à gauche de la plage, en notation CSS (par exemple, `'#ffffff'` ou `'white'`).
`getFontColors()`	`String[][]`	Renvoie les couleurs de police des cellules de la plage dans la notation CSS (par exemple, `'#ffffff'` ou `'white'`).

Documentation détaillée

`activate()`

Définit la plage spécifiée comme active range, avec la cellule en haut à gauche de la plage comme current cell.

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

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

Renvois

Range : cette plage, pour le chaînage.

`activateAsCurrentCell()`

Définit la cellule spécifiée comme current cell.

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

Si la cellule spécifiée ne figure dans aucune plage existante, la sélection existante est supprimée, et la cellule devient la cellule active et la plage active.

Remarque:L'Range spécifié doit être constitué d'une seule cellule, sinon une exception est générée.

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

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

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`addDeveloperMetadata(key)`

Ajoute des métadonnées de développeur avec la clé spécifiée à 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' 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é des nouvelles métadonnées de développement.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`addDeveloperMetadata(key, visibility)`

Ajoute des métadonnées de développeur avec la clé 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 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é des nouvelles métadonnées de développement.
`visibility`	`DeveloperMetadataVisibility`	Visibilité des nouvelles métadonnées de développement.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`addDeveloperMetadata(key, value)`

Ajoute des métadonnées de développement avec la clé et la valeur 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 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é des nouvelles métadonnées de développement.
`value`	`String`	Valeur des nouvelles métadonnées de développement.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`addDeveloperMetadata(key, value, visibility)`

Ajoute des métadonnées de développement à la plage avec la clé, la valeur et la visibilité spécifiées.

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

// Gets 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é des nouvelles métadonnées de développement.
`value`	`String`	Valeur des nouvelles métadonnées de développement.
`visibility`	`DeveloperMetadataVisibility`	Visibilité des nouvelles métadonnées de développement.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`applyColumnBanding()`

Applique un thème de bandes de colonnes par défaut à la plage. Par défaut, le bandeau comporte un en-tête, mais pas de 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(),
);

Renvois

Banding : nouveau groupe.

Autorisation

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

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

`applyColumnBanding(bandingTheme)`

Applique un thème de bandes de colonnes spécifié à la plage. Par défaut, la bande comporte un en-tête et aucune couleur de 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 couleurs à appliquer aux colonnes de la plage.

Renvois

Banding : nouveau groupe.

Autorisation

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

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

`applyColumnBanding(bandingTheme, showHeader, showFooter)`

Applique un thème de bandes de colonnes spécifié à la plage avec les paramètres d'en-tête et de pied de page 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 couleurs à appliquer aux colonnes de la plage.
`showHeader`	`Boolean`	Si la valeur est `true`, la couleur de l'en-tête du thème de bande est appliquée à la première colonne.
`showFooter`	`Boolean`	Si la valeur est `true`, la couleur du pied de page du thème de bande est appliquée à la dernière colonne.

Renvois

Banding : nouveau groupe.

Autorisation

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

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

`applyRowBanding()`

Applique un thème de bandes de lignes par défaut à la plage. Par défaut, le bandeau comporte un en-tête, mais pas de 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);

Renvois

Banding : bandes.

Autorisation

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

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

`applyRowBanding(bandingTheme)`

Applique un thème de bandes de lignes spécifié à la plage. Par défaut, le bandeau comporte un en-tête, mais pas de 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.

Renvois

Banding : nouveau groupe.

Autorisation

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

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

`applyRowBanding(bandingTheme, showHeader, showFooter)`

Applique un thème de bandes de lignes spécifié à la plage avec les 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 bande est appliquée à la première ligne.
`showFooter`	`Boolean`	Si la valeur est `true`, la couleur du pied de page du thème de bande est appliquée à la dernière ligne.

Renvois

Banding : nouveau groupe.

Autorisation

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

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

`autoFill(destination, series)`

Remplit destinationRange avec des données basées sur celles 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, l'instruction suivante remplit A1:A20 d'une série de nombres croissants en fonction des valeurs actuelles de A1:A4:

const sheet = SpreadsheetApp.getActiveSheet();

// Has values [1, 2, 3, 4].
const sourceRange = sheet.getRange('A1:A4');
// The range to fill with values.
const 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 de saisie automatique à utiliser pour calculer de nouvelles valeurs. L'effet de cette série varie en fonction du type et de la quantité de données sources.

Autorisation

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

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

`autoFillToNeighbor(series)`

Calcule une plage à remplir avec de nouvelles données en fonction des cellules voisines et remplit automatiquement cette plage 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 tient compte des données environnantes pour déterminer où les nouvelles valeurs doivent être insérées: si des données se trouvent immédiatement à gauche ou à droite d'une colonne en cours de remplissage automatique, les nouvelles valeurs ne s'étendent que jusqu'à ces données adjacentes.

Par exemple, si A1:A20 est rempli d'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, seules les nouvelles valeurs sont insérées dans B5:B20. De cette manière, ces nouvelles valeurs "collent" aux cellules contenant les valeurs de la colonne A.

const sheet = SpreadsheetApp.getActiveSheet();

// A1:A20 has values [1, 2, 3, ... 20].
// B1:B4 has values [1/1/2017, 1/2/2017, ...]
const 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 de saisie automatique à utiliser pour calculer de nouvelles valeurs. L'effet de cette série varie en fonction du type et de la quantité de données sources.

Autorisation

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

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

`breakApart()`

Répartissez à nouveau les cellules multicolonnes de la plage en cellules individuelles.

Appeler cette fonction sur une plage équivaut à sélectionner une plage, puis à cliquer sur Format > Fusionner les cellules > Défusionner.

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`canEdit()`

Détermine si l'utilisateur est autorisé à 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());

Renvois

Boolean : true si l'utilisateur est autorisé à modifier chaque cellule de la plage, false dans le cas contraire.

Autorisation

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

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

`check()`

Définit l'état des cases à cocher de la plage sur "cochée". Ignore les cellules de la plage qui ne contiennent actuellement ni la valeur cochée ni la valeur non cochée configurée.

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`clear()`

Efface la gamme de contenus et de formats.

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

const range = sheet.getRange('A1:D10');
range.clear();

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`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 des paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

Nom	Type	Description
`commentsOnly`	`Boolean`	Indique si seuls les commentaires doivent être effacés.
`contentsOnly`	`Boolean`	Indique si le contenu doit être effacé uniquement.
`formatOnly`	`Boolean`	Indique si vous souhaitez effacer uniquement la mise en forme. Notez que l'effacement de la mise en forme entraîne également l'effacement des règles de validation des données.
`validationsOnly`	`Boolean`	Indique si seules les règles de validation des données doivent être effacées.
`skipFilteredRows`	`Boolean`	Indique si vous devez éviter d'effacer les lignes filtrées.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`clearContent()`

Efface le contenu de la plage, tout en conservant la mise en forme.

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

const range = sheet.getRange('A1:D10');
range.clearContent();

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`clearDataValidations()`

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

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`clearFormat()`

Supprime la mise en forme de cette plage.

Cette opération efface le formatage du texte pour la ou les cellules de la plage, mais ne réinitialise aucune règle de formatage des nombres.

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

const range = sheet.getRange('A1:D10');
range.clearFormat();

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`clearNote()`

Efface la note dans la ou les cellules données.

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

const range = sheet.getRange('A1:D10');
range.clearNote();

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`collapseGroups()`

Réduit tous les groupes entièrement compris 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.

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

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

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

Copier la mise en forme de la plage à l'emplacement donné Si la destination est plus grande ou plus petite que la plage source, la source 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 getGridId().

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

const 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 dans 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 avec 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)`

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

const 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 avec un ou plusieurs des champs d'application suivants:

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

`copyTo(destination)`

Copier les données d'une plage de cellules vers une autre Les valeurs et le formatage sont copiés.

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

Paramètres

Nom	Type	Description
`destination`	`Range`	Plage de destination dans laquelle copier. Seule la position de la cellule en haut à gauche est pertinente.

Autorisation

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

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

`copyTo(destination, copyPasteType, transposed)`

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

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

Paramètres

Nom	Type	Description
`destination`	`Range`	Plage de destination dans laquelle copier les données. Seule la position de la cellule en haut à gauche est pertinente.
`copyPasteType`	`CopyPasteType`	Type qui spécifie comment le contenu de la plage est collé à 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 avec un ou plusieurs des champs d'application suivants:

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

`copyTo(destination, options)`

Copier les données d'une plage de cellules vers une autre Par défaut, les valeurs et la mise en forme sont copiées, mais cela peut être remplacé à l'aide d'arguments avancés.

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

Paramètres

Nom	Type	Description
`destination`	`Range`	Plage de destination dans laquelle copier les données. Seule la position de la cellule en haut à gauche est pertinente.
`options`	`Object`	Objet JavaScript qui spécifie des 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 avec 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)`

Copiez le contenu de la plage à l'emplacement donné. Si la destination est plus grande ou plus petite que la plage source, la source est répétée ou tronquée en conséquence.

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

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

const 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 dans 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 avec 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)`

Copiez le contenu de la plage à l'emplacement donné. Si la destination est plus grande ou plus petite que la plage source, la source est répétée ou tronquée en conséquence.

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

const 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 avec 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 pour une source de données.

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

const 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.

Renvois

DataSourcePivotTable : tableau croisé dynamique de la source de données nouvellement créée.

Autorisation

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

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

`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.

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

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

Paramètres

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

Renvois

DataSourceTable : table de la source de données nouvellement créée.

Autorisation

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

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

`createDeveloperMetadataFinder()`

Renvoie un DeveloperMetadataFinderApi pour rechercher des métadonnées de développeur dans le champ d'application de cette plage. Les métadonnées ne sont incluses dans la portée de la plage que si elles sont entièrement contenues dans cette plage. Par exemple, les métadonnées associées à la ligne "3:3" ne sont pas incluses dans la plage "A1:D5", mais elles le sont 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());

Renvois

DeveloperMetadataFinder : outil de recherche de métadonnées de développement permettant de rechercher des métadonnées dans le champ d'application de cette plage.

`createFilter()`

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

const ss = SpreadsheetApp.getActiveSheet();
const 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() {
  const filter = range.getFilter();
  const criteria =
      SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
  filter.setColumnFilterCriteria(2, criteria);
}

Utilisez cette méthode pour créer des filtres pour les feuilles Grid, qui sont le type de feuille par défaut. Les feuilles de calcul en grille ne sont pas associées à une base de données. Pour créer d'autres types de filtres, consultez les articles suivants :

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)

Renvois

Filter : nouveau filtre.

Autorisation

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

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

`createPivotTable(sourceData)`

Crée un tableau croisé dynamique vide à partir de l'sourceData spécifié 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.

Renvois

PivotTable : PivotTable nouvellement créé.

Autorisation

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

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

`createTextFinder(findText)`

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

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

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

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

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

Paramètres

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

Renvois

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écalées vers la plage supprimée.

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

const range = sheet.getRange('A1:D10');
range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);

Paramètres

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

Autorisation

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

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

`expandGroups()`

Développe les groupes réduits dont la plage ou le bouton de contrôle intersecte cette plage. L'emplacement du bouton d'activation/de désactivation est l'indice à partir duquel le bouton s'affiche, directement avant ou après le groupe, en fonction des paramètres. Si plusieurs groupes se trouvent au même endroit, le groupe le moins développé est développé.

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

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`getA1Notation()`

Renvoie une description de la plage sous forme de chaîne, dans la notation A1.

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

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

Renvois

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

Autorisation

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

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

`getBackground()`

Renvoie la couleur d'arrière-plan de la cellule supérieure gauche de la plage (par exemple, '#ffffff').

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackground());

Renvois

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

Autorisation

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

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

`getBackgroundObject()`

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

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

const cell = sheet.getRange('B5');
Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());

Renvois

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

Autorisation

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

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

`getBackgroundObjects()`

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

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

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

Renvois

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

Autorisation

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

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

`getBackgrounds()`

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

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

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

Renvois

String[][] : tableau à deux dimensions des codes de couleur des arrière-plans.

Autorisation

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

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

`getBandings()`

Renvoie tous les bandes appliquées à toutes les 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 (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Renvois

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

Autorisation

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

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

`getCell(row, column)`

Affiche une cellule donnée dans une plage.

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

const 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
const 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.

Renvois

Range : plage contenant une seule cellule aux coordonnées spécifiées.

Autorisation

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

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

`getColumn()`

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

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

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

Renvois

Integer : position de la colonne de départ de la plage dans la feuille de calcul.

Autorisation

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

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

`getDataRegion()`

Renvoie une copie de la plage développée dans les quatre Directions 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 sur les diagonales, la plage elle-même est renvoyée. Cela équivaut à sélectionner la plage et à saisir Ctrl+A dans l'éditeur.

// Assume the active spreadsheet is blank.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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());

Renvois

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 avec 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 développée 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'extension de la plage est basée sur la détection de données à côté de la plage qui sont organisées comme un tableau. La plage développée couvre toutes les cellules adjacentes contenant des données le long de la dimension spécifiée, y compris les limites de la table. 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.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 le long de laquelle développer la plage.

Renvois

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 avec un ou plusieurs des champs d'application suivants:

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

`getDataSourceFormula()`

Renvoie la DataSourceFormula de 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);

Renvois

DataSourceFormula : DataSourceFormula de la cellule.

Autorisation

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

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

`getDataSourceFormulas()`

Renvoie les 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());

Renvois

DataSourceFormula[] : tableau d'éléments DataSourceFormula.

Autorisation

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

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

`getDataSourcePivotTables()`

Récupère tous les tableaux croisés dynamiques de la source de données qui se croisent 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());

Renvois

DataSourcePivotTable[] : liste des tableaux croisés dynamiques de la source de données.

Autorisation

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

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

`getDataSourceTables()`

Récupère toutes les tables de sources de données qui se croisent 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());

Renvois

DataSourceTable[] : liste des tables de la source de données.

Autorisation

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

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

`getDataSourceUrl()`

Renvoie une URL pour les données de cette plage, que vous pouvez utiliser pour créer des graphiques et des requêtes.

Code.gs

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

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

piechart.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>

Renvois

String : URL de cette plage en tant que source de données pouvant être transmise à d'autres API telles que les graphiques.

Autorisation

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

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

`getDataTable()`

Renvoyez les données de cet objet sous la forme d'une 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();

Renvois

DataTable : données sous forme de tableau de données.

`getDataTable(firstRowIsHeader)`

Renvoie les données de cette plage sous forme de DataTable.

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

// Calling this method with "true" sets the first line to be the title of the
// axes
const 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.
const chart = Charts.newBarChart()
                  .setDataTable(datatable)
                  .setOption('title', 'Your Title Here')
                  .build();

Paramètres

Nom	Type	Description
`firstRowIsHeader`	`Boolean`	Indique si la première ligne doit être traitée comme un en-tête.

Renvois

DataTable : données sous forme de tableau de données.

Autorisation

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

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

`getDataValidation()`

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

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const 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.');
}

Renvois

DataValidation : règle de validation des données pour la cellule en haut à gauche de la plage.

Autorisation

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

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

`getDataValidations()`

Renvoie 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 pour 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.
const oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
const newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
const rules = range.getDataValidations();

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

    if (rule != null) {
      const criteria = rule.getCriteriaType();
      const 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);

Renvois

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 avec 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 du développeur 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()}`);
}

Renvois

DeveloperMetadata[] : métadonnées du développeur associées à cette plage.

Autorisation

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

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

`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 du formatage de la date, de l'heure et de la devise, y compris des formats appliqués automatiquement par le paramètre régional 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());

Renvois

String : valeur affichée dans cette cellule.

Autorisation

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

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

`getDisplayValues()`

Renvoie la grille rectangulaire de valeurs pour cette plage.

Renvoie un tableau à deux dimensions des valeurs affichées, indexées par ligne, puis par colonne. Les valeurs sont des objets String. La valeur affichée tient compte du formatage de la date, de l'heure et de la devise, y compris des formats appliqués automatiquement par le paramètre de 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, bien qu'un indice 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.
const values =
    SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues();
Logger.log(values[0][0]);

Renvois

String[][] : tableau bidimensionnel de valeurs.

Autorisation

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

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

`getFilter()`

Renvoie le filtre de la feuille à laquelle cette plage appartient, ou null s'il n'y a pas de filtre sur la feuille.

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

Renvois

Filter : filtre.

Autorisation

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

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

`getFontColorObject()`

Renvoie la couleur de la police de la cellule en haut à gauche de la plage.

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

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

Renvois

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

Autorisation

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

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

`getFontColorObjects()`

Renvoie les couleurs de police des cellules de la plage.

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

const results = range.getFontColorObjects();

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

Renvois

Color[][] : tableau à deux dimensions des couleurs de police associées aux cellules de la plage.

Autorisation

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

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

`getFontFamilies()`

Renvoie les familles de polices des cellules de la plage.

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

const results = range.getFontFamilies();

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

Renvois

String[][] : tableau à deux dimensions de familles de polices associées aux cellules de la plage.

Autorisation

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

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

`getFontFamily()`

Renvoie la famille de polices de la cellule située en haut à gauche de la plage.

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

Logger.log(range.getFontFamily());

Renvois

String : famille de polices de la cellule.

Autorisation

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

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

`getFontLine()`

Récupère le style de ligne de la cellule en haut à gauche de la plage ('underline', 'line-through' ou 'none').

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

Logger.log(range.getFontLine());

Renvois

String : ligne de police.

Autorisation

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

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

`getFontLines()`

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

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

const results = range.getFontLines();

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

Renvois

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

Autorisation

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

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

`getFontSize()`

Renvoie la taille de la police en points de la cellule en haut à gauche de la plage.

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

Logger.log(range.getFontSize());

Renvois

Integer : taille de la police en points.

Autorisation

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

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

`getFontSizes()`

Renvoie les tailles de police des cellules de la plage.

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

const results = range.getFontSizes();

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

Renvois

Integer[][] : tableau à deux dimensions des tailles de police du texte associé aux cellules de la plage.

Autorisation

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

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

`getFontStyle()`

Renvoie le style de police ('italic' ou 'normal') de la cellule en haut à gauche de la plage.

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

Logger.log(range.getFontStyle());

Renvois

String : style de police du texte dans la cellule.

Autorisation

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

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

`getFontStyles()`

Renvoie les styles de police des cellules de la plage.

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

const results = range.getFontStyles();

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

Renvois

String[][] : tableau à deux dimensions des styles de police de texte associés aux cellules de la plage.

Autorisation

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

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

`getFontWeight()`

Renvoie l'épaisseur de la police (normale/en gras) de la cellule en haut à gauche de la plage.

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

Logger.log(range.getFontWeight());

Renvois

String : épaisseur de la police du texte dans la cellule.

Autorisation

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

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

`getFontWeights()`

Affiche les épaisseurs de police des cellules de la plage.

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

const results = range.getFontWeights();

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

Renvois

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

Autorisation

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

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

`getFormula()`

Renvoie la formule (notation A1) de la cellule en haut à gauche de la plage, ou une chaîne vide si la cellule est vide ou ne contient pas de formule.

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

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

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

Renvois

String : formule de la cellule.

Autorisation

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

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

`getFormulaR1C1()`

Renvoie la formule (notation R1C1) d'une cellule donnée, ou null si aucune formule n'est définie.

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

const range = sheet.getRange('B5');
const formula = range.getFormulaR1C1();
Logger.log(formula);

Renvois

String : formule au format R1C1.

Autorisation

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

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

`getFormulas()`

Renvoie les formules (notation A1) des cellules de la plage. Les entrées du tableau à deux dimensions sont des chaînes vides pour les cellules sans formule.

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

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

Renvois

String[][] : tableau bidimensionnel de formules au format chaîne.

Autorisation

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

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

`getFormulasR1C1()`

Renvoie les formules (notation R1C1) des cellules de la plage. Les entrées du tableau à deux dimensions sont null pour les cellules sans formule.

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

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

Renvois

String[][] : tableau à deux dimensions de formules au format R1C1.

Autorisation

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

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

`getGridId()`

Renvoie l'ID de la 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.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange('B2:D4');

Logger.log(range.getGridId());

Renvois

Integer : ID de la grille de la feuille parente.

Autorisation

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

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

`getHeight()`

Renvoie la hauteur de la plage.

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

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

Renvois

Integer : hauteur de la plage.

Autorisation

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

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

`getHorizontalAlignment()`

Renvoie l'alignement horizontal du texte (à gauche/au centre/à droite) de la cellule en haut à gauche de la plage.

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

Logger.log(range.getHorizontalAlignment());

Renvois

String : alignement horizontal du texte dans la cellule.

Autorisation

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

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

`getHorizontalAlignments()`

Affiche les alignements horizontaux des cellules de la plage.

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

const results = range.getHorizontalAlignments();

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

Renvois

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

Autorisation

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

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

`getLastColumn()`

Renvoie la position de la colonne de fin.

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

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

Renvois

Integer : position de la colonne de fin de la plage dans la feuille de calcul.

Autorisation

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

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

`getLastRow()`

Renvoie la position de la dernière ligne.

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

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

Renvois

Integer : position de la ligne de fin de la plage dans la feuille de calcul.

Autorisation

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

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

`getMergedRanges()`

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

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

const range = sheet.getRange('A1:B3');

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

Renvois

Range[] : tableau d'objets Range représentant les cellules fusionnées qui chevauchent la plage.

`getNextDataCell(direction)`

À partir de la cellule de la première colonne et de la première ligne de la plage, renvoie la cellule suivante dans la direction donnée, qui est le bord d'une plage contiguë de cellules contenant des données ou la cellule 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.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const 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 prochaine cellule de bord de la région des données.

Renvois

Range : cellule de bordure 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 avec 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.

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

Logger.log(range.getNote());

Renvois

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

Autorisation

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

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

`getNotes()`

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

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

const results = range.getNotes();

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

Renvois

String[][] : tableau à deux dimensions des notes associées aux cellules de la plage.

Autorisation

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

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

`getNumColumns()`

Renvoie le nombre de colonnes de cette plage.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumColumns());

Renvois

Integer : nombre de colonnes dans cette plage.

Autorisation

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

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

`getNumRows()`

Renvoie le nombre de lignes dans cette plage.

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

const range = sheet.getRange('B2:D5');
Logger.log(range.getNumRows());

Renvois

Integer : nombre de lignes dans cette plage.

Autorisation

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

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

`getNumberFormat()`

Obtenez la mise en forme des nombres ou des dates de la cellule en haut à gauche de la plage donnée. Les formats renvoyés sont décrits dans la documentation de l'API Sheets.

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

const cell = sheet.getRange('C4');
Logger.log(cell.getNumberFormat());

Renvois

String : format numérique de la cellule en haut à gauche de la plage.

Autorisation

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

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

`getNumberFormats()`

Renvoie les formats de nombre ou de date des cellules de la plage. Les formats renvoyés sont décrits dans la documentation de l'API Sheets.

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

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

Renvois

String[][] : tableau bidimensionnel de formats de nombres.

Autorisation

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

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

`getRichTextValue()`

Renvoie la valeur de texte enrichi pour la cellule en haut à 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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('D4:F6');
const richText = range.getRichTextValue();
console.log(richText.getText());

Renvois

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 avec 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 pour les cellules de la plage.

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

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

Renvois

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

Autorisation

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

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

`getRow()`

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

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

const range = sheet.getRange('B2');
Logger.log(range.getRow());

Renvois

Integer : position de la ligne de la plage.

Autorisation

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

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

`getRowIndex()`

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

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

const range = sheet.getRange('B2');
Logger.log(range.getRowIndex());

Renvois

Integer : position de la ligne de la plage.

Autorisation

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

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

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

Renvois

Sheet : feuille à laquelle cette plage appartient.

Autorisation

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

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

`getTextDirection()`

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

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

Renvois

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

Autorisation

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

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

`getTextDirections()`

Renvoie l'orientation du texte pour les cellules de la plage. Les entrées de la matrice 2D sont null pour les cellules utilisant la détection automatique.

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

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

Renvois

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

Autorisation

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

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

`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.
const sheet = SpreadsheetApp.getActiveSheet();

const cell = sheet.getRange('A1');
Logger.log(cell.getTextRotation());

Renvois

TextRotation : paramètres de rotation du texte.

Autorisation

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

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

`getTextRotations()`

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

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

const results = range.getTextRotations();

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

Renvois

TextRotation[][] : tableau à deux dimensions des rotations de texte associées aux cellules de la plage.

Autorisation

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

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

`getTextStyle()`

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

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

Renvois

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 avec un ou plusieurs des champs d'application suivants:

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

`getTextStyles()`

Affiche les styles de texte des cellules de la plage.

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

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

Renvois

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

Autorisation

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

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

`getValue()`

Renvoie la valeur de la cellule supérieure gauche de la plage. La valeur peut être de type Number, Boolean, Date ou String, en fonction de 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());

Renvois

Object : valeur de cette cellule.

Autorisation

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

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

`getValues()`

Renvoie la grille rectangulaire de valeurs pour cette plage.

Renvoie un tableau à deux dimensions de valeurs, 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, bien qu'un indice 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.
const 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 valide. getValues() ne renvoie pas de données à une application Web si la plage contient une cellule avec une valeur Date. Transformez plutôt toutes les valeurs récupérées à partir de la feuille en une primitive JavaScript compatible, comme Number, Boolean ou String.

Renvois

Object[][] : tableau bidimensionnel de valeurs.

Autorisation

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

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

`getVerticalAlignment()`

Renvoie l'alignement vertical (haut/milieu/bas) de la cellule située en haut à gauche de la plage.

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

Logger.log(range.getVerticalAlignment());

Renvois

String : alignement vertical du texte dans la cellule.

Autorisation

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

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

`getVerticalAlignments()`

Renvoie les alignements verticaux des cellules de la plage.

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

const results = range.getVerticalAlignments();

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

Renvois

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

Autorisation

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

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

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

Renvois

Integer : nombre de colonnes dans la plage.

Autorisation

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

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

`getWrap()`

Indique si le texte de la cellule est mis en retour à la ligne. Pour obtenir une stratégie de mise en page plus précise, utilisez getWrapStrategy().

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

Logger.log(range.getWrap());

Renvois

Boolean : indique si le texte de cette cellule est mis en forme en retour à la ligne ou non.

Autorisation

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

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

`getWrapStrategies()`

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

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

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

Renvois

WrapStrategy[][] : tableau bidimensionnel de stratégies de retour à la ligne automatique.

Autorisation

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

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

`getWrapStrategy()`

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

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

Renvois

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

Autorisation

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

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

`getWraps()`

Indique si le texte des cellules est mis en forme avec retour à la ligne. Pour obtenir une stratégie de mise en page plus précise, utilisez getWrapStrategies().

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

const results = range.getVerticalAlignments();

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

Renvois

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

Autorisation

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

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

`insertCells(shiftDimension)`

Insère des cellules vides dans cette plage. Les nouvelles cellules conservent le formatage présent dans les cellules qui occupaient auparavant cette plage. Les données existantes de la feuille en fonction de la dimension fournie sont décalées par rapport à la plage insérée.

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

const range = sheet.getRange('A1:D10');
range.insertCells(SpreadsheetApp.Dimension.COLUMNS);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`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 décochées. Définit la valeur de toutes les cellules de la plage sur false.

const 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();

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`insertCheckboxes(checkedValue)`

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`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 décochés. Définit la valeur de chaque cellule de la plage sur la valeur personnalisée non cochée.

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`isBlank()`

Renvoie true si la plage est totalement vide.

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

Logger.log(range.isBlank());

Renvois

Boolean : true si la plage est vide, false sinon.

Autorisation

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

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

`isChecked()`

Indique si l'état de la case à cocher de toutes les cellules de la plage est "coché". Renvoie null si certaines cellules sont cochées et les autres décochées, ou si certaines cellules ne sont pas validées par une case à cocher.

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

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

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

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

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

Renvois

Boolean : true, si toutes les cellules de la plage sont cochées, false, si toutes les cellules de la plage ne sont pas cochées, ou null, si l'une des cellules n'est pas cochée ou ne comporte pas de validation des données par case à cocher.

Autorisation

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

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

`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 à la fin de la plage, cette méthode renvoie true. Pour les plages 3:7 ou A1:5, qui ne sont liées qu'à des lignes particulières à la fin 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 end of the range is bound to a particular column and logs
// it to the console.
console.log(range.isEndColumnBounded());

Renvois

Boolean : true si la fin de la plage est liée à une colonne spécifique ; false sinon.

Autorisation

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

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

`isEndRowBounded()`

Indique 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 à la fin de la plage, cette méthode renvoie true. Pour les plages B:B ou A1:C, qui ne sont liées qu'à des colonnes particulières à la fin 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 end of the range is bound to a particular row and logs it
// to the console.
console.log(range.isEndRowBounded());

Renvois

Boolean : true si la fin de la plage est liée à une ligne spécifique, false sinon.

Autorisation

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

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

`isPartOfMerge()`

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

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

const range = sheet.getRange('A1:B3');

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

Renvois

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

`isStartColumnBounded()`

Indique 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 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());

Renvois

Boolean : true si le début de la plage est lié à une colonne spécifique, false sinon.

Autorisation

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

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

`isStartRowBounded()`

Indique 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 particulière 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());

Renvois

Boolean : true si le début de la plage est lié à une ligne spécifique, false sinon.

Autorisation

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

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

`merge()`

Fusionne les cellules de la plage en un seul bloc.

const sheet = SpreadsheetApp.getActiveSheet();

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`mergeAcross()`

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

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

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

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`mergeVertically()`

Fusionne les cellules de la plage.

const 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();

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`moveTo(target)`

Coupez et collez (à la fois le format et les valeurs) cette plage dans la plage cible.

// The code below moves the first 5 columns over to the 6th column
const 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 la cellule en haut à gauche est pertinente.

Autorisation

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

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

`offset(rowOffset, columnOffset)`

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

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

const cell = sheet.getRange('A1');

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

Paramètres

Nom	Type	Description
`rowOffset`	`Integer`	Nombre de lignes vers le bas à partir de la cellule en haut à gauche de la plage. Les valeurs négatives représentent les lignes vers le haut à partir de la cellule en haut à 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.

Renvois

Range : cette plage, pour le chaînage.

`offset(rowOffset, columnOffset, numRows)`

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

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

const cell = sheet.getRange('A1');

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

Paramètres

Nom	Type	Description
`rowOffset`	`Integer`	Nombre de lignes vers le bas à partir de la cellule en haut à gauche de la plage. Les valeurs négatives représentent les lignes vers le haut à partir de la cellule en haut à 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.

Renvois

Range : cette plage, pour le chaînage.

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

Renvoie une nouvelle plage par rapport à 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 avec la hauteur et la largeur données en cellules.

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

const cell = sheet.getRange('A1');

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

Paramètres

Nom	Type	Description
`rowOffset`	`Integer`	Nombre de lignes vers le bas à partir de la cellule en haut à gauche de la plage. Les valeurs négatives représentent les lignes vers le haut à partir de la cellule en haut à 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.

Renvois

Range : cette plage, pour le chaînage.

`protect()`

Crée un objet qui peut empêcher la modification de la plage, 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'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.
const ss = SpreadsheetApp.getActive();
const range = ss.getRange('A1:B10');
const 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.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Renvois

Protection : objet représentant les paramètres de protection.

Autorisation

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

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

`randomize()`

Ordonne de manière aléatoire les lignes de la plage donnée.

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

// Randomizes the range
range.randomize();

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`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 non cochée.

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

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

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

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`removeDuplicates()`

Supprime les lignes de cette plage qui contiennent des valeurs en double de celles d'une ligne précédente. Les lignes dont les valeurs sont 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 qui ne s'appliquent pas à cette période ne sont pas supprimés.

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

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

Renvois

Range : plage obtenue après 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 avec 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 d'une ligne précédente. Les lignes dont les valeurs sont 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 qui ne s'appliquent pas à cette période ne sont pas supprimés.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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 rechercher des valeurs en double. Si aucune colonne n'est fournie, toutes les colonnes sont analysées pour détecter les doublons.

Renvois

Range : plage obtenue après 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 avec 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 dans la notation CSS (par exemple, '#ffffff' ou 'white').

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

const range = sheet.getRange('B2:D5');
range.setBackground('red');

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setBackgroundObject(color)`

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

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setBackgroundObjects(color)`

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

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

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

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

const cell = sheet.getRange('B5:C6');
cell.setBackgroundObjects(colors);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setBackgroundRGB(red, green, blue)`

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

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setBackgrounds(color)`

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

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

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

const cell = sheet.getRange('B5:D6');
cell.setBackgrounds(colors);

Paramètres

Nom	Type	Description
`color`	`String[][]`	Tableau à deux dimensions de couleurs en notation CSS (par exemple, `'#ffffff'` ou `'white'`). Les valeurs `null` réinitialisent la couleur.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

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

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

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

const 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 une bordure, `false` pour aucune bordure et `null` pour aucune modification.
`left`	`Boolean`	`true` pour une bordure, `false` pour aucune bordure et `null` pour aucune modification.
`bottom`	`Boolean`	`true` pour une bordure, `false` pour aucune bordure et `null` pour aucune modification.
`right`	`Boolean`	`true` pour une bordure, `false` pour aucune bordure et `null` pour aucune modification.
`vertical`	`Boolean`	`true` pour les bordures verticales internes, `false` pour aucune, `null` pour aucune modification.
`horizontal`	`Boolean`	`true` pour les bordures horizontales internes, `false` pour aucune, `null` pour aucune modification.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

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

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

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

const 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 une bordure, `false` pour aucune bordure et `null` pour aucune modification.
`left`	`Boolean`	`true` pour une bordure, `false` pour aucune bordure et `null` pour aucune modification.
`bottom`	`Boolean`	`true` pour une bordure, `false` pour aucune bordure et `null` pour aucune modification.
`right`	`Boolean`	`true` pour une bordure, `false` pour aucune bordure et `null` pour aucune modification.
`vertical`	`Boolean`	`true` pour les bordures verticales internes, `false` pour aucune, `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 des bordures, `null` pour le style par défaut (plein).

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setDataValidations(rules)`

Définit les règles de validation des données pour toutes les cellules de la plage. Cette méthode prend un tableau à deux dimensions de validations de données, indexé 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.
const destinationRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5');
const sourceRange =
    SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build();
const rules = destinationRange.getDataValidations();
for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    rules[i][j] = rule;
  }
}
destinationRange.setDataValidations(rules);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontColor(color)`

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

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontColorObject(color)`

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

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

const cell = sheet.getRange('B2');
cell.setFontColor(color);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontColorObjects(colors)`

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

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

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

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

const cell = sheet.getRange('B5:C6');
cell.setFontColorObjects(colors);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontColors(colors)`

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

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

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

const cell = sheet.getRange('B5:D6');
cell.setFontColors(colors);

Paramètres

Nom	Type	Description
`colors`	`Object[][]`	Tableau à deux dimensions de couleurs en notation CSS (par exemple, `'#ffffff'` ou `'white'`). Les valeurs `null` réinitialisent la couleur.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontFamilies(fontFamilies)`

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

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

const fonts = [
  ['Arial', 'Helvetica', 'Verdana'],
  ['Courier New', 'Arial', 'Helvetica'],
];

const cell = sheet.getRange('B2:D3');
cell.setFontFamilies(fonts);

Paramètres

Nom	Type	Description
`fontFamilies`	`Object[][]`	Tableau à deux dimensions de familles de polices. Les valeurs `null` réinitialisent la famille de polices.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontFamily(fontFamily)`

Définit la famille de polices, par exemple "Arial" ou "Helvetica".

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontLine(fontLine)`

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

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontLines(fontLines)`

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

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

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

const range = sheet.getRange('B2:D2');
range.setFontLines(fontLines);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontSize(size)`

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

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

const cell = sheet.getRange('B2');
cell.setFontSize(20);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontSizes(sizes)`

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

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

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

const range = sheet.getRange('B2:D2');
range.setFontSizes(fontSizes);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontStyle(fontStyle)`

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

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontStyles(fontStyles)`

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

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

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

const range = sheet.getRange('B2:C2');
range.setFontStyles(fontStyles);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontWeight(fontWeight)`

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

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

const 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 la police.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFontWeights(fontWeights)`

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

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

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

const range = sheet.getRange('B2:D2');
range.setFontWeights(fontStyles);

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFormula(formula)`

Met à jour la formule de cette plage. La formule indiquée doit être au format A1.

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFormulaR1C1(formula)`

Met à jour la formule de cette plage. La formule indiquée doit être au format R1C1.

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

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFormulas(formulas)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
const formulas = [
  ['=SUM(B2:B4)', '=SUM(C2:C4)', '=SUM(D2:D4)'],
  ['=AVERAGE(B2:B4)', '=AVERAGE(C2:C4)', '=AVERAGE(D2:D4)'],
];

const cell = sheet.getRange('B5:D6');
cell.setFormulas(formulas);

Paramètres

Nom	Type	Description
`formulas`	`String[][]`	Tableau bidimensionnel de chaînes de formules.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setFormulasR1C1(formulas)`

Définit une grille rectangulaire de formules (elle doit correspondre aux dimensions de cette plage). Les formules données doivent être au format R1C1.

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

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

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

const 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 bidimensionnel de formules au format R1C1.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setHorizontalAlignment(alignment)`

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

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

const cell = sheet.getRange('B2');
cell.setHorizontalAlignment('center');

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setHorizontalAlignments(alignments)`

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

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

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

const range = sheet.getRange('B2:D2');
range.setHorizontalAlignments(horizontalAlignments);

Paramètres

Nom	Type	Description
`alignments`	`Object[][]`	Tableau bidimensionnel d'alignements, soit `'left'`, `'center'` ou `'normal'`. Une valeur `null` réinitialise l'alignement.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

Voir aussi

setHorizontalAlignment(alignment)

`setNote(note)`

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

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

const cell = sheet.getRange('B2');
cell.setNote('This is a note');

Paramètres

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setNotes(notes)`

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

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

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

const cell = sheet.getRange('B2:D3');
cell.setNotes(notes);

Paramètres

Nom	Type	Description
`notes`	`Object[][]`	Tableau bidimensionnel de notes. Les valeurs `null` suppriment la note.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

Voir aussi

setNote(note)

`setNumberFormat(numberFormat)`

Définit le format de nombre ou de date sur la chaîne de formatage donnée. Les formats acceptés sont décrits dans la documentation de l'API Sheets.

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

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

Paramètres

Nom	Type	Description
`numberFormat`	`String`	Chaîne de format de nombre.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setNumberFormats(numberFormats)`

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

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

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

const range = sheet.getRange('B2:D2');
range.setNumberFormats(formats);

Paramètres

Nom	Type	Description
`numberFormats`	`Object[][]`	Tableau bidimensionnel de formats de nombres.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`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.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setRichTextValues(values)`

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

// Sets the cells in range A1:A2 to have Rich Text values.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:A2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
const richTextA1 = SpreadsheetApp.newRichTextValue()
                       .setText('This cell is bold')
                       .setTextStyle(bold)
                       .build();
const 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 de texte enrichi souhaitées.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setShowHyperlink(showHyperlink)`

Indique si la plage doit afficher ou non 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`	Indique si le lien hypertexte doit être affiché ou non.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setTextDirection(direction)`

Définit le sens du texte pour les 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.
const sheet = SpreadsheetApp.getActiveSheet();
const 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 le paramétrage.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setTextDirections(directions)`

Définit une grille rectangulaire de sens du texte. Si la 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.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextDirections());

Paramètres

Nom	Type	Description
`directions`	`TextDirection[][]`	Sens du texte souhaité. Si une direction spécifiée est `null`, elle est déduite avant le paramétrage.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setTextRotation(degrees)`

Définit les paramètres de rotation du texte pour les cellules de la plage. La valeur d'entrée correspond à l'angle entre l'orientation standard du texte et l'orientation souhaitée. Une valeur de zéro indique que le texte est défini sur l'orientation standard.

Pour le sens de lecture de gauche à droite, les angles positifs sont dans le sens inverse des aiguilles d'une montre, tandis que pour le sens de lecture de droite à gauche, ils sont dans le sens des aiguilles d'une montre.

// Sets all cell's in range B2:D4 to have text rotated up 45 degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const 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 antihoraire.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`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.
const sheet = SpreadsheetApp.getActiveSheet();

const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setTextRotations(rotations)`

Définit une grille rectangulaire de rotations de texte.

// Copies all of the text rotations from range A1:B2 over to range C5:D6.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setTextRotations(range1.getTextRotations());

Paramètres

Nom	Type	Description
`rotations`	`TextRotation[][]`	Paramètres de rotation du texte souhaités.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setTextStyle(style)`

Définit le style de texte pour les cellules de la plage.

// Sets the cells in range C5:D6 to have underlined size 15 font.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('C5:D6');
const style =
    SpreadsheetApp.newTextStyle().setFontSize(15).setUnderline(true).build();
range.setTextStyle(style);

Paramètres

Nom	Type	Description
`style`	`TextStyle`	Style de texte souhaité.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setTextStyles(styles)`

Définit une grille rectangulaire de styles de texte.

// Sets text styles for cells in range A1:B2
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B2');
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const 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[][]`	Les styles de texte souhaités.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setValue(value)`

Définit la valeur de la plage. La valeur peut être numérique, une chaîne, une valeur booléenne ou une date. S'il commence par '=', il est interprété comme une formule.

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

const cell = sheet.getRange('B2');
cell.setValue(100);

Paramètres

Nom	Type	Description
`value`	`Object`	Valeur de la plage.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setValues(values)`

Définit une grille rectangulaire de valeurs (elle doit correspondre aux dimensions de cette plage). Si une valeur commence par =, elle est interprétée comme une formule.

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

// The size of the two-dimensional array must match the size of the range.
const values = [['2.000', '1,000,000', '$2.99']];

const range = sheet.getRange('B2:D2');
range.setValues(values);

Paramètres

Nom	Type	Description
`values`	`Object[][]`	Tableau bidimensionnel de valeurs.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setVerticalAlignment(alignment)`

Définit l'alignement vertical (de haut en bas) pour la plage donnée (haut/milieu/bas).

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

const cell = sheet.getRange('B2');
cell.setVerticalAlignment('middle');

Paramètres

Nom	Type	Description
`alignment`	`String`	L'alignement, soit `'top'`, `'middle'` ou `'bottom'`. Une valeur `null` réinitialise l'alignement.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setVerticalAlignments(alignments)`

Définit une grille rectangulaire d'alignements verticaux (elle doit correspondre aux dimensions de cette plage).

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

// The size of the two-dimensional array must match the size of the range.
const alignments = [['top', 'middle', 'bottom']];

const range = sheet.getRange('B2:D2');
range.setVerticalAlignments(alignments);

Paramètres

Nom	Type	Description
`alignments`	`Object[][]`	Tableau bidimensionnel d'alignements, soit `'top'`, `'middle'` ou `'bottom'`. Une valeur `null` réinitialise l'alignement.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

Voir aussi

setVerticalAlignment(alignment)

`setVerticalText(isVertical)`

Indique si le texte des cellules de la plage doit être empilé ou non. Si le texte est empilé verticalement, le paramètre de rotation du texte en degrés est ignoré.

// Sets all cell's in range B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setVerticalText(true);

Paramètres

Nom	Type	Description
`isVertical`	`Boolean`	Indique si le texte doit être empilé ou non.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setWrap(isWrapEnabled)`

Définit le retour à la ligne des cellules de la plage donnée.

Les cellules pour lesquelles le retour à la ligne automatique est activé (par défaut) se redimensionnent pour afficher l'intégralité de leur contenu. Les cellules dont le retour à la ligne est désactivé s'affichent autant que possible dans la cellule sans être redimensionnées ni s'étendre sur plusieurs lignes.

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

const cell = sheet.getRange('B2');
cell.setWrap(true);

Paramètres

Nom	Type	Description
`isWrapEnabled`	`Boolean`	Indique si le texte doit être mis en retour à la ligne automatique ou non.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`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.
const sheet = SpreadsheetApp.getActiveSheet();
const range1 = sheet.getRange('A1:B2');
const range2 = sheet.getRange('C5:D6');

range2.setWrapStrategies(range1.getWrapStrategies());

Paramètres

Nom	Type	Description
`strategies`	`WrapStrategy[][]`	Les stratégies de retour à la ligne souhaitées.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setWrapStrategy(strategy)`

Définit la stratégie de retour à la ligne pour les cellules de la plage.

// Sets all cells in range B2:D4 to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('B2:D4');

range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Paramètres

Nom	Type	Description
`strategy`	`WrapStrategy`	Stratégie de retour à la ligne souhaitée.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`setWraps(isWrapEnabled)`

Définit une grille rectangulaire de règles de retour à la ligne (elle doit correspondre aux dimensions de cette plage). Les cellules avec retour à la ligne activé (par défaut) se redimensionnent pour afficher l'intégralité de leur contenu. Les cellules dont le retour à la ligne est désactivé s'affichent autant que possible dans la cellule sans être redimensionnées ni s'étendre sur plusieurs lignes.

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

// The size of the two-dimensional array must match the size of the range.
const wraps = [[true, true, false]];

const range = sheet.getRange('B2:D2');
range.setWraps(wraps);

Paramètres

Nom	Type	Description
`isWrapEnabled`	`Object[][]`	Tableau à deux dimensions de variables de retour à la ligne qui déterminent si le texte doit être mis en forme avec retour à la ligne dans une cellule ou non.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

Voir aussi

setWrap(isWrapEnabled)

`shiftColumnGroupDepth(delta)`

Modifie la profondeur de regroupement des colonnes de la plage selon la valeur spécifiée.

Cela a pour effet de créer, de modifier ou de supprimer des groupes qui se croisent avec la plage. Pour les deltas positifs, des groupes sont créés et/ou modifiés. Pour les deltas négatifs, des groupes sont détruits et/ou modifiés.

Cette modification n'a aucun effet si vous diminuez la profondeur du groupe en dessous de zéro ou au-dessus de huit.

Si column group control position est BEFORE, une erreur est générée lors de la tentative de décalage de la profondeur de la première ligne.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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`	Valeur à appliquer pour modifier la hauteur du groupe de colonnes de cette plage.

Renvois

Range : cette plage, pour le chaînage.

Génère

Error : lorsque vous essayez de modifier 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 avec 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 hauteur du regroupement des lignes de la plage selon la valeur spécifiée.

Cette modification n'a aucun effet si vous diminuez la profondeur du groupe en dessous de zéro ou au-dessus de huit.

Si row group control position est BEFORE, une erreur est générée lors de la tentative de décalage de la profondeur de la première ligne.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const 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`	Valeur à appliquer pour modifier la hauteur du groupe de lignes de cette plage.

Renvois

Range : cette plage, pour le chaînage.

Génère

Error : lorsque vous essayez de modifier la profondeur de la première ligne lorsque la position de contrôle est GroupControlTogglePosition.BEFORE

Autorisation

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

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

`sort(sortSpecObj)`

Trie les cellules de la plage donnée par colonne et dans l'ordre spécifié.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const 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.

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`splitTextToColumns()`

Fractionne 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|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns();

// Result after splitting 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 avec un ou plusieurs des champs d'application suivants:

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

`splitTextToColumns(delimiter)`

Fractionne une colonne de texte en plusieurs colonnes à l'aide de 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|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns('#');

// Result after splitting 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`	Séparateur personnalisé à utiliser pour la division.

Autorisation

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

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

`splitTextToColumns(delimiter)`

Fractionne 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|                 |                 |

const range = SpreadsheetApp.getActiveSheet().getRange('A1:A3');
range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON);

// Result after splitting 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 avec un ou plusieurs des champs d'application suivants:

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

`trimWhitespace()`

Élimine les espaces blancs (tels que les espaces, les tabulations ou les sauts de ligne) de chaque cellule de cette plage. Supprime tous les espaces au début et à la fin du texte de chaque cellule, et réduit toute sous-séquence de caractères d'espaces restants à un seul espace.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

range.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

`uncheck()`

Définit l'état des cases à cocher de la plage sur "non cochée". Ignore les cellules de la plage qui ne contiennent actuellement ni la valeur cochée ni la valeur non cochée configurée.

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

Renvois

Range : cette plage, pour le chaînage.

Autorisation

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

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

Méthodes obsolètes

`getFontColor()`

Obsolète. Remplacé par getFontColorObject()

Renvoie la couleur de la police de la cellule en haut à gauche de la plage, en notation CSS (par exemple, '#ffffff' ou 'white').

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

Logger.log(range.getFontColor());

Renvois

String : couleur de la police en notation CSS (par exemple, '#ffffff' ou 'white').

Autorisation

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

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

`getFontColors()`

Obsolète. Remplacé par getFontColorObjects()

Renvoie les couleurs de police des cellules de la plage dans la notation CSS (par exemple, '#ffffff' ou 'white').

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

const results = range.getFontColors();

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

Renvois

String[][] : tableau à deux dimensions des couleurs de police associées aux cellules de la plage.

Autorisation

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

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