Class Range

Plage

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

Méthodes

MéthodeType renvoyéBrève description
activate()RangeDéfinit la plage spécifiée en tant que active range, avec les valeurs les plus élevées cellule de gauche dans la plage current cell.
activateAsCurrentCell()RangeDéfinit la cellule spécifiée en tant que current cell.
addDeveloperMetadata(key)RangeAjoute à la plage les métadonnées de développement avec la clé spécifiée.
addDeveloperMetadata(key, visibility)RangeAjoute des métadonnées de développement avec la clé et la visibilité spécifiées à la plage.
addDeveloperMetadata(key, value)RangeAjoute à la plage les métadonnées de développement avec la clé et la valeur spécifiées.
addDeveloperMetadata(key, value, visibility)RangeAjoute des métadonnées de développement avec la clé, la valeur et la visibilité spécifiées à la plage.
applyColumnBanding()BandingApplique un thème de banding de colonne par défaut à la plage.
applyColumnBanding(bandingTheme)BandingApplique à la plage un thème de banding de colonne spécifié.
applyColumnBanding(bandingTheme, showHeader, showFooter)BandingApplique un thème de banding de colonne spécifié à la plage avec l'en-tête et le pied de page spécifiés paramètres.
applyRowBanding()BandingApplique à la plage un thème de bandes passantes des lignes par défaut.
applyRowBanding(bandingTheme)BandingApplique à la plage un thème de banding des lignes spécifié.
applyRowBanding(bandingTheme, showHeader, showFooter)BandingApplique un thème de banding des lignes spécifié à la plage avec les paramètres d'en-tête et de pied de page spécifiés.
autoFill(destination, series)voidElle remplit destinationRange avec des données basées sur les données de cette plage.
autoFillToNeighbor(series)voidCalcule une plage à remplir avec de nouvelles données basées sur les cellules voisines et remplit automatiquement cette plage par de nouvelles valeurs basées sur les données qu'elle contient.
breakApart()RangeDivisez à nouveau toutes les cellules de plusieurs colonnes de la plage en cellules individuelles.
canEdit()BooleanDétermine si l'utilisateur est autorisé à modifier chaque cellule de la plage.
check()RangeDéfinit l'état des cases à cocher de la plage sur "Coché".
clear()RangeEfface la plage de contenus et de formats.
clear(options)RangeEfface la plage de contenus, de format, de règles de validation des données et/ou de commentaires, comme spécifié avec les options avancées données.
clearContent()RangeEfface le contenu de la plage, sans modifier la mise en forme.
clearDataValidations()RangeEfface les règles de validation des données pour la plage.
clearFormat()RangeEfface la mise en forme de cette plage.
clearNote()RangeEfface la note dans la ou les cellules indiquées.
collapseGroups()RangeRéduit tous les groupes entièrement contenus dans la plage.
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)voidCopiez la mise en forme de la plage à l'emplacement indiqué.
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)voidCopiez la mise en forme de la plage à l'emplacement indiqué.
copyTo(destination)voidCopie les données d'une plage de cellules dans une autre plage de cellules.
copyTo(destination, copyPasteType, transposed)voidCopie les données d'une plage de cellules dans une autre plage de cellules.
copyTo(destination, options)voidCopie les données d'une plage de cellules dans une autre plage de cellules.
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)voidCopiez le contenu de la plage à l'emplacement indiqué.
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)voidCopiez le contenu de la plage à l'emplacement indiqué.
createDataSourcePivotTable(dataSource)DataSourcePivotTableCrée un tableau croisé dynamique de source de données vide à partir de la source de données, ancré dans la première cellule de cette plage.
createDataSourceTable(dataSource)DataSourceTableCrée une table de source de données vide à partir de la source de données, ancrée dans la première cellule de ce la plage d'adresses IP.
createDeveloperMetadataFinder()DeveloperMetadataFinderRenvoie une DeveloperMetadataFinderApi pour trouver les métadonnées de développement dans le champ d'application de la plage d'adresses IP.
createFilter()FilterCrée un filtre et l'applique à la plage spécifiée sur la feuille.
createPivotTable(sourceData)PivotTableCrée un tableau croisé dynamique vide à partir de l'élément sourceData spécifié, ancré dans la première cellule dans cette plage.
createTextFinder(findText)TextFinderCrée un outil de recherche de texte pour la plage, qui peut rechercher et remplacer du texte dans cette plage.
deleteCells(shiftDimension)voidSupprime cette plage de cellules.
expandGroups()RangeDéveloppe les groupes réduits dont le bouton d'activation de la plage ou des commandes recoupe cette plage.
getA1Notation()StringRenvoie une description de la plage sous forme de chaîne, au format A1.
getBackground()StringAffiche la couleur d'arrière-plan de la cellule en haut à gauche de la plage (par exemple, '#ffffff').
getBackgroundObject()ColorAffiche la couleur d'arrière-plan de la cellule en haut à gauche de la plage.
getBackgroundObjects()Color[][]Renvoie les couleurs d'arrière-plan des cellules de la plage.
getBackgrounds()String[][]Renvoie les couleurs d'arrière-plan des cellules de la plage (par exemple, '#ffffff').
getBandings()Banding[]Renvoie toutes les bandes qui sont appliquées aux cellules de cette plage.
getCell(row, column)RangeAffiche une cellule donnée dans une plage.
getColumn()IntegerRenvoie la position de départ de la colonne pour cette plage.
getDataRegion()RangeRenvoie une copie de la plage étendue dans les quatre Direction cardinales pour couvrir l'ensemble cellules adjacentes contenant des données.
getDataRegion(dimension)RangeRenvoie une copie de la plage étendue Direction.UP et Direction.DOWN si la La dimension spécifiée est Dimension.ROWS, ou Direction.NEXT et Direction.PREVIOUS si la dimension est Dimension.COLUMNS.
getDataSourceFormula()DataSourceFormulaRenvoie la valeur DataSourceFormula pour la première cellule de la plage, ou null si la cellule ne contient pas de formule de source de données.
getDataSourceFormulas()DataSourceFormula[]Renvoie les valeurs DataSourceFormula pour les cellules de la plage.
getDataSourcePivotTables()DataSourcePivotTable[]Récupère tous les tableaux croisés dynamiques de sources de données qui présentent une intersection avec la plage.
getDataSourceTables()DataSourceTable[]Récupère toutes les tables de source de données qui présentent une intersection avec la plage.
getDataSourceUrl()StringAffiche une URL pour les données de cette plage, qui peut être utilisée pour créer des graphiques et des requêtes.
getDataTable()DataTableRenvoyez les données contenues dans cet objet sous forme de DataTable.
getDataTable(firstRowIsHeader)DataTableRenvoyez les données de cette plage sous forme de DataTable.
getDataValidation()DataValidationRenvoie 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 de développement associées à cette plage.
getDisplayValue()StringRenvoie la valeur affichée de la cellule en haut à gauche de la plage.
getDisplayValues()String[][]Affiche la grille rectangulaire de valeurs pour cette plage.
getFilter()FilterAffiche le filtre sur la feuille à laquelle appartient cette plage, ou null si aucun filtre n'est appliqué la feuille.
getFontColorObject()ColorRenvoie la couleur de police de la cellule dans le coin supérieur gauche de la plage.
getFontColorObjects()Color[][]Renvoie les couleurs de police des cellules de la plage.
getFontFamilies()String[][]Renvoie les familles de polices des cellules de la plage.
getFontFamily()StringRenvoie la famille de polices de la cellule dans le coin supérieur gauche de la plage.
getFontLine()StringRécupère le style de ligne de la cellule dans l'angle supérieur gauche de la plage ('underline', 'line-through' ou 'none').
getFontLines()String[][]Récupère le style de ligne des cellules de la plage ('underline', 'line-through' ou 'none').
getFontSize()IntegerRenvoie la taille de police en point de la cellule dans l'angle supérieur gauche de la plage.
getFontSizes()Integer[][]Renvoie la taille de police des cellules de la plage.
getFontStyle()StringAffiche 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()StringRenvoie l'épaisseur de police (normale/gras) de la cellule dans le coin supérieur gauche de la plage.
getFontWeights()String[][]Renvoie l'épaisseur de la police des cellules de la plage.
getFormula()StringRenvoie la formule (notation A1) pour la cellule située en haut à gauche de la plage, ou une chaîne vide si le paramètre la cellule est vide ou ne contient pas de formule.
getFormulaR1C1()StringRenvoie la formule (notation R1C1) pour une cellule donnée, ou null si aucune cellule n'est renvoyée.
getFormulas()String[][]Renvoie les formules (notation A1) pour les cellules de la plage.
getFormulasR1C1()String[][]Renvoie les formules (notation R1C1) pour les cellules de la plage.
getGridId()IntegerRenvoie l'ID de grille de la feuille parente de la plage.
getHeight()IntegerRenvoie la hauteur de la plage.
getHorizontalAlignment()StringRenvoie l'alignement horizontal du texte (à gauche/au centre/à droite) de la cellule en haut à gauche. de la plage.
getHorizontalAlignments()String[][]Renvoie les alignements horizontaux des cellules de la plage.
getLastColumn()IntegerRenvoie la position de fin de la colonne.
getLastRow()IntegerRenvoie la position de la dernière ligne.
getMergedRanges()Range[]Renvoie un tableau d'objets Range représentant les cellules fusionnées qui sont entièrement dans la plage actuelle, ou qui contiennent au moins une cellule dans la plage actuelle.
getNextDataCell(direction)RangeEn partant de la cellule de la première colonne et 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 en bordure de la feuille de calcul, dans cette direction.
getNote()StringAffiche la note associée à la plage donnée.
getNotes()String[][]Affiche les notes associées aux cellules de la plage.
getNumColumns()IntegerRenvoie le nombre de colonnes dans cette plage.
getNumRows()IntegerRenvoie le nombre de lignes dans cette plage.
getNumberFormat()StringObtient le format numérique ou de date de la cellule en haut à gauche d'une plage donnée.
getNumberFormats()String[][]Renvoie les formats numériques ou de date des cellules de la plage.
getRichTextValue()RichTextValueAffiche la valeur en texte enrichi de la cellule située en haut à gauche de la plage, ou null si la cellule la valeur n'est pas du texte.
getRichTextValues()RichTextValue[][]Renvoie les valeurs en texte enrichi pour les cellules de la plage.
getRow()IntegerRenvoie la position de ligne pour cette plage.
getRowIndex()IntegerRenvoie la position de ligne pour cette plage.
getSheet()SheetAffiche la feuille à laquelle cette plage appartient.
getTextDirection()TextDirectionAffiche le sens du texte pour la cellule supérieure gauche de la plage.
getTextDirections()TextDirection[][]Affiche le sens du texte pour les cellules de la plage.
getTextRotation()TextRotationRenvoie 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()TextStyleAffiche 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()ObjectAffiche la valeur de la cellule en haut à gauche de la plage.
getValues()Object[][]Affiche la grille rectangulaire de valeurs pour cette plage.
getVerticalAlignment()StringRenvoie l'alignement vertical (en haut/au milieu/bas) de la cellule dans le coin supérieur gauche de la la plage d'adresses IP.
getVerticalAlignments()String[][]Renvoie les alignements verticaux des cellules de la plage.
getWidth()IntegerRenvoie la largeur de la plage en colonnes.
getWrap()BooleanIndique si le retour à la ligne automatique est effectué dans la cellule.
getWrapStrategies()WrapStrategy[][]Affiche les stratégies de renvoi de texte pour les cellules de la plage.
getWrapStrategy()WrapStrategyRenvoie la stratégie de retour à la ligne automatique pour la cellule supérieure gauche de la plage.
getWraps()Boolean[][]Indique si le texte contenu dans les cellules est renvoyé à la ligne automatiquement.
insertCells(shiftDimension)RangeInsère des cellules vides dans cette plage.
insertCheckboxes()RangeInsère des cases à cocher dans chaque cellule de la plage, configurée avec true pour les options cochées et false pour la case décochée.
insertCheckboxes(checkedValue)RangeInsère des cases à cocher dans chaque cellule de la plage, configurées avec une valeur personnalisée pour les options cochées et la chaîne vide pour décocher la case.
insertCheckboxes(checkedValue, uncheckedValue)RangeInsère des cases à cocher dans chaque cellule de la plage, configurée avec des valeurs personnalisées pour les cases cochées et décochée.
isBlank()BooleanRenvoie true si la plage est totalement vide.
isChecked()BooleanIndique si la case à cocher de toutes les cellules de la plage est cochée.
isEndColumnBounded()BooleanDétermine si la fin de la plage est liée à une colonne particulière.
isEndRowBounded()BooleanDétermine si la fin de la plage est liée à une ligne spécifique.
isPartOfMerge()BooleanRenvoie true si les cellules de la plage actuelle chevauchent des cellules fusionnées.
isStartColumnBounded()BooleanDétermine si le début de la plage est lié à une colonne particulière.
isStartRowBounded()BooleanDétermine si le début de la plage est lié à une ligne spécifique.
merge()RangeFusionne les cellules de la plage en un seul bloc.
mergeAcross()RangeFusionnez les cellules de la plage dans toutes les colonnes qui s'y trouvent.
mergeVertically()RangeFusionne les cellules de la plage.
moveTo(target)voidCoupez et collez (format et valeurs) de cette plage dans la plage cible.
offset(rowOffset, columnOffset)RangeRenvoie une nouvelle plage décalée par rapport au nombre de lignes et de colonnes donné. (qui peut être négative).
offset(rowOffset, columnOffset, numRows)RangeRenvoie une nouvelle plage relative à la plage actuelle, dont le point supérieur gauche est décalé à partir de la plage actuelle par les lignes et colonnes données, et avec la hauteur donnée en cellules.
offset(rowOffset, columnOffset, numRows, numColumns)RangeRenvoie une nouvelle plage relative à la plage actuelle, dont le point supérieur gauche est décalé à partir de la plage actuelle selon les lignes et les colonnes données, et la hauteur et la largeur indiquées en cellules.
protect()ProtectionCrée un objet pouvant empêcher la modification de la plage, sauf par les utilisateurs disposant l'autorisation.
randomize()RangeAchète l'ordre des lignes dans la plage donnée.
removeCheckboxes()RangeSupprime toutes les cases à cocher de la plage.
removeDuplicates()RangeSupprime les lignes de cette plage qui contiennent des valeurs qui sont des doublons des valeurs dans ligne précédente.
removeDuplicates(columnsToCompare)RangeSupprime les lignes de cette plage qui contiennent des valeurs en double dans les colonnes spécifiées de valeurs n'importe quelle ligne précédente.
setBackground(color)RangeDéfinit la couleur d'arrière-plan de toutes les cellules de la plage au format CSS ('#ffffff', par exemple) ou 'white').
setBackgroundObject(color)RangeDéfinit la couleur d'arrière-plan de toutes les cellules de la plage.
setBackgroundObjects(color)RangeDéfinit une grille rectangulaire de couleurs d'arrière-plan (doivent correspondre aux dimensions de cette plage).
setBackgroundRGB(red, green, blue)RangeDéfinit la couleur de l'arrière-plan à l'aide de valeurs RVB (entiers compris entre 0 et 255 inclus).
setBackgrounds(color)RangeDéfinit une grille rectangulaire de couleurs d'arrière-plan (doivent correspondre aux dimensions de cette plage).
setBorder(top, left, bottom, right, vertical, horizontal)RangeDéfinit la propriété de la bordure.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeDéfinit la propriété de la bordure avec une couleur et/ou un style.
setDataValidation(rule)RangeDéfinit une règle de validation des données pour toutes les cellules de la plage.
setDataValidations(rules)RangeDéfinit les règles de validation des données pour toutes les cellules de la plage.
setFontColor(color)RangeDéfinit la couleur de la police dans la notation CSS ('#ffffff' ou 'white', par exemple).
setFontColorObject(color)RangeDéfinit la couleur de la police de la plage donnée.
setFontColorObjects(colors)RangeDéfinit une grille rectangulaire de couleurs de police (doit correspondre aux dimensions de cette plage).
setFontColors(colors)RangeDéfinit une grille rectangulaire de couleurs de police (doit correspondre aux dimensions de cette plage).
setFontFamilies(fontFamilies)RangeDéfinit une grille rectangulaire de familles de polices (doivent correspondre aux dimensions de cette plage).
setFontFamily(fontFamily)RangeDéfinit la famille de polices, par exemple "Arial". ou "Helvetica".
setFontLine(fontLine)RangeDéfinit le style de ligne de la police de la plage donnée ('underline', 'line-through' ou 'none').
setFontLines(fontLines)RangeDéfinit une grille rectangulaire de styles de ligne (doit correspondre aux dimensions de cette plage).
setFontSize(size)RangeDéfinit la taille de la police, la taille correspondant au point à utiliser.
setFontSizes(sizes)RangeDéfinit une grille rectangulaire de tailles de police (doivent correspondre aux dimensions de cette plage).
setFontStyle(fontStyle)RangeDéfinissez le style de police pour la plage donnée ('italic' ou 'normal').
setFontStyles(fontStyles)RangeDéfinit une grille rectangulaire de styles de police (doit correspondre aux dimensions de cette plage).
setFontWeight(fontWeight)RangeDéfinissez l'épaisseur de la police pour la plage donnée (normal/gras).
setFontWeights(fontWeights)RangeDéfinit une grille rectangulaire d'épaisseurs de police (doit correspondre aux dimensions de cette plage).
setFormula(formula)RangeMet à jour la formule pour cette plage.
setFormulaR1C1(formula)RangeMet à jour la formule pour cette plage.
setFormulas(formulas)RangeDéfinit une grille rectangulaire de formules (doivent correspondre aux dimensions de cette plage).
setFormulasR1C1(formulas)RangeDéfinit une grille rectangulaire de formules (doivent correspondre aux dimensions de cette plage).
setHorizontalAlignment(alignment)RangeDéfinissez l'alignement horizontal (de gauche à droite) pour la plage donnée (gauche/centre/droite).
setHorizontalAlignments(alignments)RangeDéfinit une grille rectangulaire d'alignements horizontaux.
setNote(note)RangeDéfinit la note sur la valeur donnée.
setNotes(notes)RangeDéfinit une grille rectangulaire de notes (doit correspondre aux dimensions de cette plage).
setNumberFormat(numberFormat)RangeDéfinit le format de nombre ou de date sur la chaîne de mise en forme donnée.
setNumberFormats(numberFormats)RangeDéfinit une grille rectangulaire de formats numériques ou de date (doit correspondre aux dimensions de cette plage).
setRichTextValue(value)RangeDéfinit la valeur en texte enrichi des cellules de la plage.
setRichTextValues(values)RangeDéfinit une grille rectangulaire de valeurs en texte enrichi.
setShowHyperlink(showHyperlink)RangeDétermine si la plage doit afficher ou non des liens hypertexte.
setTextDirection(direction)RangeDéfinit l'orientation du texte des cellules de la plage.
setTextDirections(directions)RangeDéfinit une grille rectangulaire des orientations de texte.
setTextRotation(degrees)RangeDéfinit les paramètres de rotation du texte pour les cellules de la plage.
setTextRotation(rotation)RangeDéfinit les paramètres de rotation du texte pour les cellules de la plage.
setTextRotations(rotations)RangeDéfinit une grille rectangulaire de rotations du texte.
setTextStyle(style)RangeDéfinit le style du texte des cellules de la plage.
setTextStyles(styles)RangeDéfinit une grille rectangulaire de styles de texte.
setValue(value)RangeDéfinit la valeur de la plage.
setValues(values)RangeDéfinit une grille rectangulaire de valeurs (doit correspondre aux dimensions de cette plage).
setVerticalAlignment(alignment)RangeDéfinissez l'alignement vertical (de haut en bas) de la plage donnée (haut, milieu et bas).
setVerticalAlignments(alignments)RangeDéfinit une grille rectangulaire d'alignements verticaux (doivent correspondre aux dimensions de cette plage).
setVerticalText(isVertical)RangeDétermine si le texte des cellules de la plage doit être empilé ou non.
setWrap(isWrapEnabled)RangeDéfinit le retour à la ligne automatique de la plage donnée.
setWrapStrategies(strategies)RangeDéfinit une grille rectangulaire de stratégies d'encapsulation.
setWrapStrategy(strategy)RangeDéfinit la stratégie de retour à la ligne automatique pour les cellules de la plage.
setWraps(isWrapEnabled)RangeDéfinit une grille rectangulaire de règles de retour automatique à la ligne (doit correspondre aux dimensions de cette plage).
shiftColumnGroupDepth(delta)RangeModifie la profondeur du regroupement de colonnes de la plage en fonction de la quantité spécifiée.
shiftRowGroupDepth(delta)RangeModifie la profondeur du regroupement de lignes de la plage en fonction de la valeur spécifiée.
sort(sortSpecObj)RangeTrie les cellules de la plage donnée, par colonne et par ordre spécifiés.
splitTextToColumns()voidDivise une colonne de texte en plusieurs colonnes en fonction d'un délimiteur détecté automatiquement.
splitTextToColumns(delimiter)voidDivise une colonne de texte en plusieurs colonnes en utilisant la chaîne spécifiée comme délimiteur personnalisé.
splitTextToColumns(delimiter)voidScind une colonne de texte en plusieurs colonnes en fonction du délimiteur spécifié.
trimWhitespace()RangeSupprime les espaces blancs (espaces, tabulations ou sauts de ligne, par exemple) dans chaque cellule de la plage.
uncheck()RangeDéfinit l'état des cases à cocher de la plage sur "non cochée".

Documentation détaillée

activate()

Définit la plage spécifiée en tant que active range, avec les valeurs les plus élevées cellule de gauche dans la plage current cell.

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

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

Renvois

Range : plage utilisée pour le chaînage.


activateAsCurrentCell()

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

Si la cellule spécifiée se trouve dans une plage existante, cette plage devient la cellule active plage avec la cellule en tant que cellule active.

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

Remarque:La valeur Range spécifiée doit être constituée d'une seule cellule. Dans le cas contraire, elle génère une une exception.

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

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

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

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

addDeveloperMetadata(key)

Ajoute à la plage les métadonnées de développement avec la clé spécifiée.

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

// Gets 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

NomTypeDescription
keyStringClé des nouvelles métadonnées de développement.

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

addDeveloperMetadata(key, visibility)

Ajoute des métadonnées de développement avec la clé 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

NomTypeDescription
keyStringClé des nouvelles métadonnées de développement.
visibilityDeveloperMetadataVisibilityVisibilité des nouvelles métadonnées de développement.

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

addDeveloperMetadata(key, value)

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

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

// Gets 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

NomTypeDescription
keyStringClé des nouvelles métadonnées de développement.
valueStringValeur des nouvelles métadonnées de développement.

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

addDeveloperMetadata(key, value, visibility)

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

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

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

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

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

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

Paramètres

NomTypeDescription
keyStringClé des nouvelles métadonnées de développement.
valueStringValeur des nouvelles métadonnées de développement.
visibilityDeveloperMetadataVisibilityVisibilité des nouvelles métadonnées de développement.

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 banding de colonne par défaut à la plage. Par défaut, la bande comporte un en-tête et aucune la couleur du 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 : nouvelle création de bandes.

Autorisation

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

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

applyColumnBanding(bandingTheme)

Applique à la plage un thème de banding de colonne spécifié. Par défaut, la définition des bandes comporte un en-tête et pas de 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

NomTypeDescription
bandingThemeBandingThemeThème de couleurs à appliquer aux colonnes de la plage.

Renvois

Banding : nouvelle création de bandes.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 banding de colonne spécifié à la plage avec l'en-tête et le pied de page spécifiés paramètres.

// 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

NomTypeDescription
bandingThemeBandingThemeThème de couleurs à appliquer aux colonnes de la plage.
showHeaderBooleanSi la valeur est true, la couleur de l'en-tête du thème des bandes est appliquée à la première .
showFooterBooleanSi la valeur est true, la couleur du pied de page du thème des bandes est appliquée au dernier .

Renvois

Banding : nouvelle création de bandes.

Autorisation

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

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

applyRowBanding()

Applique à la plage un thème par bandes de lignes par défaut. Par défaut, la bande comporte un en-tête et aucune la couleur du 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 : création de bandes.

Autorisation

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

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

applyRowBanding(bandingTheme)

Applique à la plage un thème de banding des lignes spécifié. Par défaut, la bande comporte un en-tête et aucune la couleur du 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

NomTypeDescription
bandingThemeBandingThemeThème de couleurs à appliquer aux lignes de la plage.

Renvois

Banding : nouvelle création de bandes.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 à la plage un thème de banding des lignes spécifié pour l'en-tête et le pied de page.

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

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

// Gets rows 1-30 on Sheet1.
const range = sheet.getRange('1:30');

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

Paramètres

NomTypeDescription
bandingThemeBandingThemeThème de couleurs à appliquer aux lignes de la plage.
showHeaderBooleanSi la valeur est true, la couleur de l'en-tête du thème des bandes est appliquée à la première ligne.
showFooterBooleanSi la valeur est true, la couleur du pied de page du thème des bandes est appliquée à la dernière ligne.

Renvois

Banding : nouvelle création de bandes.

Autorisation

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

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

autoFill(destination, series)

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

var sheet = SpreadsheetApp.getActiveSheet();

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

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

Paramètres

NomTypeDescription
destinationRangePlage à remplir automatiquement avec des valeurs. La plage de destination doit contiennent cette plage et l'étendent dans une seule direction (vers le haut, le bas, la gauche ou à droite).
seriesAutoFillSeriesType de série de saisie automatique à utiliser pour calculer de nouvelles valeurs. La l'effet de cette série diffère en fonction du type et de la quantité de données sources.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 basées sur les cellules voisines et remplit automatiquement cette plage par de nouvelles valeurs basées sur les données qu'elle contient. Ces nouvelles valeurs sont également déterminé par le type series spécifié.

La plage de destination calculée prend en compte les données environnantes pour déterminer l'emplacement doivent être insérées: s'il existe des données à gauche ou à droite d'une colonne remplies automatiquement, les nouvelles valeurs s'étendent uniquement au-delà de ces données adjacentes.

Par exemple, si A1:A20 est rempli par une série de nombres croissants et que cette méthode est appelée sur la plage B1:B4 qui contient une série de dates, les nouvelles valeurs ne sont inséré dans B5:B20. De cette façon, ces nouvelles valeurs aux cellules contenant les valeurs de la colonne A.

var sheet = SpreadsheetApp.getActiveSheet();

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

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

Paramètres

NomTypeDescription
seriesAutoFillSeriesType de série de saisie automatique à utiliser pour calculer de nouvelles valeurs. La l'effet de cette série diffère en fonction du type et de la quantité de données sources.

Autorisation

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

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

breakApart()

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

Appeler cette fonction sur une plage revient à sélectionner une plage et 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 : plage utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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. 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 toutes les cellules de la plage false sinon.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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é". Ignore les cellules de la plage qui ne contiennent actuellement aucune valeur cochée ou dé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'.
var range = SpreadsheetApp.getActive().getRange('A1:B10');
range.check();

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

clear()

Efface la plage de contenus et de formats.

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

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

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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, de format, de règles de validation des données et/ou de 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

NomTypeDescription
optionsObjectObjet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

NomTypeDescription
commentsOnlyBooleanIndique si seuls les commentaires doivent être effacés.
contentsOnlyBooleanPermet d'effacer uniquement le contenu.
formatOnlyBooleanIndique s'il faut effacer uniquement le format ; notez que la suppression efface également les règles de validation des données.
validationsOnlyBooleanPermet d'effacer uniquement les règles de validation des données.
skipFilteredRowsBooleanPermet d'éviter d'effacer les lignes filtrées.

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

clearContent()

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

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

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

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

clearDataValidations()

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

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

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

clearFormat()

Efface la mise en forme de cette plage.

Cette action efface la mise en forme du texte de la ou des cellules de la plage, mais n'en réinitialise pas des règles de mise en forme des nombres.

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

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

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 indiquées.

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

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

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

collapseGroups()

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

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

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

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

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

Copiez la mise en forme de la plage à l'emplacement indiqué. Si la destination est plus grande ou plus petite que la plage source, celle-ci est répétée ou tronquée en conséquence. Notez que cette ne copie que la mise en forme.

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

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

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

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

Paramètres

NomTypeDescription
gridIdIntegerIdentifiant unique de la feuille dans la feuille de calcul, quelle que soit sa position.
columnIntegerPremière colonne de la plage cible.
columnEndIntegerColonne de fin de la plage cible.
rowIntegerPremière ligne de la plage cible.
rowEndIntegerDernière ligne de la plage cible.

Autorisation

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

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

Voir aussi


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

Copiez la mise en forme de la plage à l'emplacement indiqué. Si la destination est plus grande ou plus petite que la plage source, celle-ci est répétée ou tronquée en conséquence. Notez que cette ne copie que la mise en forme.

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

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

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

Paramètres

NomTypeDescription
sheetSheetFeuille cible
columnIntegerPremière colonne de la plage cible.
columnEndIntegerColonne de fin de la plage cible.
rowIntegerPremière ligne de la plage cible.
rowEndIntegerDernière ligne de la plage cible.

Autorisation

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

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

copyTo(destination)

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

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

Paramètres

NomTypeDescription
destinationRangeUne plage de destination vers laquelle effectuer la copie seule la position de la cellule en haut à gauche est pertinente.

Autorisation

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

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

copyTo(destination, copyPasteType, transposed)

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

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

Paramètres

NomTypeDescription
destinationRangeUne plage de destination vers laquelle effectuer la copie seule la position de la cellule en haut à gauche est pertinente.
copyPasteTypeCopyPasteTypeType spécifiant comment le contenu de la plage est collé dans la vers votre destination.
transposedBooleanIndique si la plage doit être collée dans son orientation transposée.

Autorisation

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

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

copyTo(destination, options)

Copie les données d'une plage de cellules dans une autre plage de cellules. Par défaut, les valeurs et la mise en forme sont copiées, mais vous pouvez les remplacer à l'aide d'arguments avancés.

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

Paramètres

NomTypeDescription
destinationRangeUne plage de destination vers laquelle effectuer la copie seule la position de la cellule en haut à gauche est pertinente.
optionsObjectObjet JavaScript qui spécifie des paramètres avancés, comme indiqué ci-dessous.

Paramètres avancés

NomTypeDescription
formatOnlyBooleanindique que seul le format doit être copié
contentsOnlyBooleanindique que seul le contenu doit être copié

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 indiqué. Si la destination est plus grande ou plus petite que la plage source, celle-ci est répétée ou tronquée en conséquence.

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

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

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

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

Paramètres

NomTypeDescription
gridIdIntegerIdentifiant unique de la feuille dans la feuille de calcul, quelle que soit sa position.
columnIntegerPremière colonne de la plage cible.
columnEndIntegerColonne de fin de la plage cible.
rowIntegerPremière ligne de la plage cible.
rowEndIntegerDernière ligne de la plage cible.

Autorisation

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

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

Voir aussi


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

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

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

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

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

Paramètres

NomTypeDescription
sheetSheetFeuille cible
columnIntegerPremière colonne de la plage cible.
columnEndIntegerColonne de fin de la plage cible.
rowIntegerPremière ligne de la plage cible.
rowEndIntegerDernière ligne de la plage cible.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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é dans la première cellule de cette plage.

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

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

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

Paramètres

NomTypeDescription
dataSourceDataSourceSource de données à partir de laquelle créer le tableau croisé dynamique.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 dans la première cellule de ce la plage d'adresses IP.

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

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

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

Paramètres

NomTypeDescription
dataSourceDataSourceSource de données à partir de laquelle créer le tableau croisé dynamique.

Renvois

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

Autorisation

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

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

createDeveloperMetadataFinder()

Renvoie une DeveloperMetadataFinderApi pour trouver les métadonnées de développement dans le champ d'application de la plage d'adresses IP. Les métadonnées sont incluses dans le champ d'application de la plage uniquement si elles sont entièrement incluses dans celle-ci. la plage d'adresses IP. Par exemple, les métadonnées associées à la ligne "3:3" ne sont pas incluses dans le champ d'application d'une plage. "A1:D5", mais entre dans le champ d'application d'une 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 pour 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 sur la feuille. Vous ne pouvez pas créer plus de un filtre sur une feuille. Pour accéder à votre filtre et le modifier après l'avoir créé, utilisez getFilter() ou Sheet.getFilter().

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

// Creates a new filter and applies it to the range A1:C20 on the active sheet.
function createFilter() {
  range.createFilter();
}
// Gets the filter and applies criteria that only shows cells that aren't empty.
function getFilterAddCriteria() {
  let filter = range.getFilter();
  let criteria = SpreadsheetApp.newFilterCriteria()
    .whenCellNotEmpty()
    .build();
  filter.setColumnFilterCriteria(2, criteria);
}
Utilisez cette méthode afin de créer des filtres pour Grid feuilles, le type de feuille par défaut. Les feuilles de grille sont des feuilles qui ne sont pas connectées à une base de données. Pour créer d'autres types de filtres, reportez-vous aux articles suivants: <ph type="x-smartling-placeholder">

Renvois

Filter : nouveau filtre.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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'élément sourceData spécifié, ancré dans la première cellule dans 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

NomTypeDescription
sourceDataRangeDonné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 correspondant à un ou plusieurs des champs d'application suivants:

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

createTextFinder(findText)

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

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

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

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

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

Paramètres

NomTypeDescription
findTextStringTexte à rechercher.

Renvois

TextFinder : TextFinder de la plage


deleteCells(shiftDimension)

Supprime cette plage de cellules. Les données existantes de la feuille correspondant à la dimension fournie sont décalées dans la plage supprimée.

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

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

Paramètres

NomTypeDescription
shiftDimensionDimensionDimension via laquelle les données existantes doivent être déplacées.

Autorisation

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

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

expandGroups()

Développe les groupes réduits dont le bouton d'activation de la plage ou des commandes recoupe cette plage. La L'emplacement du bouton d'activation et de désactivation des commandes est l'indice d'affichage du bouton d'activation/de désactivation, directement avant ou après le groupe en fonction des paramètres. S'il y a plusieurs groupes au même emplacement, le groupe le plus moins profond est développé.

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

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

Renvois

Range : plage utilisée pour le chaînage.

Autorisation

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

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

getA1Notation()

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

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

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

Renvois

String : description de la plage au format A1.

Autorisation

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

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

getBackground()

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

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

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

Renvois

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

Autorisation

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

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

getBackgroundObject()

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

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

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

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

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

getBackgroundObjects()

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

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

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

Renvois

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

Autorisation

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

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

getBackgrounds()

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

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

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

Renvois

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

Autorisation

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

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

getBandings()

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

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

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

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

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

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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.

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

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

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

Paramètres

NomTypeDescription
rowIntegerLigne de la cellule par rapport à la plage.
columnIntegerColonne 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 correspondant à un ou plusieurs des champs d'application suivants:

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

getColumn()

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

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

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

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

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

getDataRegion()

Renvoie une copie de la plage étendue dans les quatre Direction cardinales pour couvrir l'ensemble cellules adjacentes contenant des données. Si la plage est entourée de cellules vides à l'exception de ces cellules le long des diagonales, la plage elle-même est renvoyée. Ceci est similaire à la sélection de la plage et saisissez Ctrl+A dans l'éditeur.

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

Renvois

Range : région des 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 correspondant à un ou plusieurs des champs d'application suivants:

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

getDataRegion(dimension)

Renvoie une copie de la plage étendue Direction.UP et Direction.DOWN si la La dimension spécifiée est Dimension.ROWS, ou Direction.NEXT et Direction.PREVIOUS si la dimension est Dimension.COLUMNS. L'élargissement de la gamme est basé sur la détection de données à côté de la plage organisée comme un tableau. La plage étendue couvre toutes les cellules adjacentes contenant des données en fonction de la dimension spécifiée, y compris le tableau des limites. 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 revient à sélectionner la plage et à saisir Ctrl+Space pour les colonnes ou Shift+Space pour les lignes dans l'éditeur.

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

Paramètres

NomTypeDescription
dimensionDimensionDimension selon laquelle étendre la plage.

Renvois

Range : région des 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 correspondant à un ou plusieurs des champs d'application suivants:

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

getDataSourceFormula()

Renvoie la valeur DataSourceFormula pour la première cellule de la plage, ou null si la cellule ne contient pas de formule de source de données.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

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

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

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

Renvois

DataSourceFormula : DataSourceFormula de la cellule.

Autorisation

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

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

getDataSourceFormulas()

Renvoie les valeurs DataSourceFormula pour les 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 de DataSourceFormula.

Autorisation

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

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

getDataSourcePivotTables()

Récupère tous les tableaux croisés dynamiques de sources de données qui présentent une intersection avec la plage.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

// Gets 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 de tableaux croisés dynamiques de sources de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 source de données qui présentent une intersection avec la plage.

// Opens the spreadsheet file by its ID. If you created your script from a Google Sheets file,
// use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

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

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

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

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

Renvois

DataSourceTable[] : liste de tables de sources de données.

Autorisation

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

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

getDataSourceUrl()

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

Code.gs

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

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

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 correspondant à cette plage en tant que source de données, qui peut être transmise à d'autres API telles que des graphiques.

Autorisation

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

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

getDataTable()

Renvoyez les données contenues dans cet objet sous forme de 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)

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

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

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

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

Paramètres

NomTypeDescription
firstRowIsHeaderBooleanIndique 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 correspondant à 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 a été définie sur la cellule, cette méthode renvoie null.

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

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 correspondant à 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 sur une cellule donnée, cette méthode renvoie null pour la position de cette cellule dans le tableau.

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

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

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

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

Renvois

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

Autorisation

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

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

getDeveloperMetadata()

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

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

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

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

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

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

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 en haut à gauche de la plage. Sa valeur est un String. La valeur affichée tient compte du format de la date, de l'heure et de la devise, y compris s'appliquent automatiquement selon les paramètres régionaux de la feuille de calcul. Les cellules vides renvoient une valeur .

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

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

getDisplayValues()

Affiche la grille rectangulaire de valeurs pour cette plage.

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

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

Renvois

String[][] : tableau de valeurs à deux dimensions.

Autorisation

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

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

getFilter()

Affiche le filtre sur la feuille à laquelle appartient cette plage, ou null si aucun filtre n'est appliqué la feuille.

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

Renvois

Filter : filtre.

Autorisation

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

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

getFontColorObject()

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

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

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

Renvois

Color : couleur de police de la cellule en haut à gauche de la plage.

Autorisation

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

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

getFontColorObjects()

Renvoie les couleurs de police des cellules de la plage.

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

var results = range.getFontColorObjects();

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

Renvois

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

Autorisation

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

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

getFontFamilies()

Renvoie les familles de polices des cellules de la plage.

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

var results = range.getFontFamilies();

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

Renvois

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

Autorisation

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

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