Class RangeList

PlageListe

Collection d'une ou plusieurs instances Range dans la même feuille. Vous pouvez utiliser cette classe pour appliquer des opérations à des collections de plages ou de cellules non adjacentes.

Méthodes

MéthodeType renvoyéBrève description
activate()RangeListSélectionne la liste des instances Range.
breakApart()RangeListRépartissez à nouveau toutes les cellules fusionnées horizontalement ou verticalement contenues dans la liste de plages en cellules individuelles.
check()RangeListDéfinit l'état des cases à cocher de la plage sur "cochée".
clear()RangeListEfface la plage de contenus, de formats et de règles de validation des données pour chaque Range de la liste des plages.
clear(options)RangeListEfface la plage de contenus, le format, les règles de validation des données et les commentaires, comme spécifié avec les options données.
clearContent()RangeListEfface le contenu de chaque Range de la liste de plages, tout en conservant la mise en forme.
clearDataValidations()RangeListEfface les règles de validation des données pour chaque Range de la liste des plages.
clearFormat()RangeListEfface la mise en forme du texte pour chaque Range de la liste des plages.
clearNote()RangeListEfface la note pour chaque Range de la liste des plages.
getRanges()Range[]Renvoie la liste d'une ou plusieurs instances Range dans la même feuille.
insertCheckboxes()RangeListInsère des cases à cocher dans chaque cellule de la plage, configurées avec true pour les cases cochées et false pour les cases décochées.
insertCheckboxes(checkedValue)RangeListInsère des cases à cocher dans chaque cellule de la plage, configurées avec une valeur personnalisée pour les cases cochées et la chaîne vide pour les cases décochées.
insertCheckboxes(checkedValue, uncheckedValue)RangeListInsère des cases à cocher dans chaque cellule de la plage, configurées avec des valeurs personnalisées pour les états cochés et décochés.
removeCheckboxes()RangeListSupprime toutes les cases à cocher de la plage.
setBackground(color)RangeListDéfinit la couleur d'arrière-plan de chaque Range de la liste des plages.
setBackgroundRGB(red, green, blue)RangeListDéfinit l'arrière-plan sur la couleur RVB donnée.
setBorder(top, left, bottom, right, vertical, horizontal)RangeListDéfinit la propriété de bordure pour chaque Range de la liste des plages.
setBorder(top, left, bottom, right, vertical, horizontal, color, style)RangeListDéfinit la propriété de bordure avec la couleur et/ou le style pour chaque Range de la liste de plages.
setFontColor(color)RangeListDéfinit la couleur de police pour chaque Range de la liste des plages.
setFontFamily(fontFamily)RangeListDéfinit la famille de polices pour chaque Range de la liste des plages.
setFontLine(fontLine)RangeListDéfinit le style de la ligne de police pour chaque Range de la liste des plages.
setFontSize(size)RangeListDéfinit la taille de police (en points) pour chaque Range de la liste de plages.
setFontStyle(fontStyle)RangeListDéfinissez le style de police pour chaque Range de la liste des plages.
setFontWeight(fontWeight)RangeListDéfinissez l'épaisseur de la police pour chaque Range de la liste des plages.
setFormula(formula)RangeListMet à jour la formule pour chaque Range de la liste des plages.
setFormulaR1C1(formula)RangeListMet à jour la formule pour chaque Range de la liste des plages.
setHorizontalAlignment(alignment)RangeListDéfinissez l'alignement horizontal de chaque Range dans la liste des plages.
setNote(note)RangeListDéfinit le texte de la note pour chaque Range de la liste des plages.
setNumberFormat(numberFormat)RangeListDéfinit le format de nombre ou de date pour chaque Range de la liste de plages.
setShowHyperlink(showHyperlink)RangeListIndique si chaque Range de la liste de plages doit afficher des liens hypertextes.
setTextDirection(direction)RangeListDéfinit l'orientation du texte pour les cellules de chaque Range de la liste des plages.
setTextRotation(degrees)RangeListDéfinit les paramètres de rotation du texte pour les cellules de chaque Range de la liste des plages.
setValue(value)RangeListDéfinit la valeur pour chaque Range de la liste de plages.
setVerticalAlignment(alignment)RangeListDéfinissez l'alignement vertical pour chaque Range de la liste des plages.
setVerticalText(isVertical)RangeListIndique si le texte des cellules de chaque Range de la liste de plages doit être empilé ou non.
setWrap(isWrapEnabled)RangeListDéfinissez le retour à la ligne pour chaque Range de la liste des plages.
setWrapStrategy(strategy)RangeListDéfinit la stratégie de retour à la ligne pour chaque Range de la liste de plages.
trimWhitespace()RangeListÉlimine les espaces blancs (tels que les espaces, les tabulations ou les sauts de ligne) de chaque cellule de cette liste de plages.
uncheck()RangeListDésactive les cases à cocher de la plage.

Documentation détaillée

activate()

Sélectionne la liste des instances Range. La dernière plage de la liste est définie comme active range.

Remarque:Cela permet de sélectionner plusieurs plages. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.activate();

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Renvois

RangeList : liste des plages actives, pour la concaténation.

Autorisation

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

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

breakApart()

Répartissez à nouveau toutes les cellules fusionnées horizontalement ou verticalement contenues dans la liste de plages en cellules individuelles.

Appeler cette fonction sur une liste de plages équivaut à sélectionner un ensemble de plages, puis l'élément de menu Sheets Format > Merge > Unmerge (Format > Fusionner > Dissocier). 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.breakApart();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

check()

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

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'checked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

clear()

Efface la plage de contenus, de formats et de règles de validation des données pour chaque Range de la liste des plages. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

clear(options)

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

// The code below clears the contents of the following ranges A:A and C:C in the
// active sheet, but preserves the format, data validation rules, and comments.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.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.
contentsOnlyBooleanIndique si le contenu doit être effacé uniquement.
formatOnlyBooleanIndique si vous souhaitez effacer uniquement la mise en forme. Notez que l'effacement de la mise en forme entraîne également l'effacement des règles de validation des données.
validationsOnlyBooleanIndique si seules les règles de validation des données doivent être effacées.
skipFilteredRowsBooleanIndique si vous devez éviter d'effacer les lignes filtrées.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

clearContent()

Efface le contenu de chaque Range de la liste de plages, tout en conservant la mise en forme. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearContent();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

clearDataValidations()

Efface les règles de validation des données pour chaque Range de la liste des plages. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearDataValidations();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

clearFormat()

Efface la mise en forme du texte pour chaque Range de la liste des plages.

Cette opération efface la mise en forme du texte pour chaque plage, mais ne réinitialise aucune règle de mise en forme des nombres. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearFormat();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

clearNote()

Efface la note pour chaque Range de la liste des plages. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearNote();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

getRanges()

Renvoie la liste d'une ou plusieurs instances Range dans la même feuille.

Renvois

Range[] : liste des plages.

Autorisation

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

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

insertCheckboxes()

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

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'true' for checked and 'false' for unchecked. Also, sets the value of each
// cell in the ranges D4 and E6 to 'false'.
rangeList.insertCheckboxes();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

insertCheckboxes(checkedValue)

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

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and the empty string for unchecked. Also, sets the value of
// each cell in the ranges D4 and E6 to the empty string.
rangeList.insertCheckboxes('yes');

Paramètres

NomTypeDescription
checkedValueObjectValeur cochée pour la validation des données de la case à cocher.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

insertCheckboxes(checkedValue, uncheckedValue)

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

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and 'no' for unchecked. Also, sets the value of each cell
// in the ranges D4 and E6 to 'no'.
rangeList.insertCheckboxes('yes', 'no');

Paramètres

NomTypeDescription
checkedValueObjectValeur cochée pour la validation des données de la case à cocher.
uncheckedValueObjectValeur décochée pour la validation des données de la case à cocher.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

removeCheckboxes()

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

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

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

const rangeList1 = SpreadsheetApp.getActive().getRangeList(['A1', 'A3']);
rangeList1.setValue('yes');
// Removes the checkbox data validation in cells A1 and A3 and clears their
// value.
rangeList1.removeCheckboxes();

const rangeList2 = SpreadsheetApp.getActive().getRangeList(['A5', 'A7']);
rangeList2.setValue('random');
// Removes the checkbox data validation in cells A5 and A7 but does not clear
// their value.
rangeList2.removeCheckboxes();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setBackground(color)

Définit la couleur d'arrière-plan de chaque Range de la liste des plages. La couleur est représentée dans la notation CSS, par exemple '#ffffff' ou 'white'. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setBackground('red');

Paramètres

NomTypeDescription
colorStringCode de couleur d'arrière-plan en notation CSS, par exemple '#ffffff' ou 'white'. Une valeur null réinitialise la couleur.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setBackgroundRGB(red, green, blue)

Définit l'arrière-plan sur la couleur RVB donnée. Il s'agit d'un wrapper pratique pour un appel setBackground(color). 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
// Sets the background to red for each range in the range list.
rangeList.setBackgroundRGB(255, 0, 0);

Paramètres

NomTypeDescription
redIntegerValeur rouge au format RVB.
greenIntegerValeur verte au format RVB.
blueIntegerValeur bleue au format RVB.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

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

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

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom of the ranges A2:B4 and C1:D4, but leaves
// the left and right unchanged.
rangeList.setBorder(true, null, true, null, false, false);

Paramètres

NomTypeDescription
topBooleantrue pour une bordure, false pour aucune bordure et null pour aucune modification.
leftBooleantrue pour une bordure, false pour aucune bordure et null pour aucune modification.
bottomBooleantrue pour une bordure, false pour aucune bordure et null pour aucune modification.
rightBooleantrue pour une bordure, false pour aucune bordure et null pour aucune modification.
verticalBooleantrue pour les bordures verticales internes, false pour aucune, null pour aucune modification.
horizontalBooleantrue pour les bordures horizontales internes, false pour aucune, null pour aucune modification.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

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

Définit la propriété de bordure avec la couleur et/ou le style pour chaque Range de la liste de plages. Les valeurs valides sont true (activé), false (désactivé) et null (pas de modification). La couleur est représentée dans la notation CSS, par exemple '#ffffff' ou 'white'. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom, but leaves the left and right unchanged
// of the ranges A2:B4 and C1:D4. Also sets the color to 'red', and the border
// to 'DASHED'.
rangeList.setBorder(
    true,
    null,
    true,
    null,
    false,
    false,
    'red',
    SpreadsheetApp.BorderStyle.DASHED,
);

Paramètres

NomTypeDescription
topBooleantrue pour une bordure, false pour aucune bordure et null pour aucune modification.
leftBooleantrue pour une bordure, false pour aucune bordure et null pour aucune modification.
bottomBooleantrue pour une bordure, false pour aucune bordure et null pour aucune modification.
rightBooleantrue pour une bordure, false pour aucune bordure et null pour aucune modification.
verticalBooleantrue pour les bordures verticales internes, false pour aucune, null pour aucune modification.
horizontalBooleantrue pour les bordures horizontales internes, false pour aucune, null pour aucune modification.
colorStringCouleur de la bordure en notation CSS, par exemple '#ffffff' ou 'white', null pour la couleur par défaut (noir).
styleBorderStyleStyle des bordures, null pour le style par défaut (plein).

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setFontColor(color)

Définit la couleur de police pour chaque Range de la liste des plages. La couleur est représentée dans la notation CSS, par exemple '#ffffff' ou 'white'. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontColor('red');

Paramètres

NomTypeDescription
colorStringCouleur de la police en notation CSS, par exemple '#ffffff' ou 'white'. Une valeur null réinitialise la couleur.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setFontFamily(fontFamily)

Définit la famille de polices pour chaque Range de la liste des plages. La famille de polices est décrite par un identifiant de chaîne tel que Arial ou Roboto. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontFamily('Roboto');

Paramètres

NomTypeDescription
fontFamilyStringFamille de polices à définir. Une valeur null réinitialise la famille de polices.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setFontLine(fontLine)

Définit le style de la ligne de police pour chaque Range de la liste des plages. Les options de style de ligne sont 'underline', 'line-through' ou 'none'. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontLine('line-through');

Paramètres

NomTypeDescription
fontLineStringStyle de ligne de la police, 'underline', 'line-through' ou 'none'. Une valeur null réinitialise le style de ligne de la police.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setFontSize(size)

Définit la taille de police (en points) pour chaque Range de la liste de plages. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontSize(20);

Paramètres

NomTypeDescription
sizeIntegerTaille de police en points.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setFontStyle(fontStyle)

Définissez le style de police pour chaque Range de la liste des plages. Les options de style de police sont 'italic' ou 'normal'. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontStyle('italic');

Paramètres

NomTypeDescription
fontStyleStringStyle de police, 'italic' ou 'normal'. Une valeur null réinitialise le style de police.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setFontWeight(fontWeight)

Définissez l'épaisseur de la police pour chaque Range de la liste des plages. Les options d'épaisseur de police sont 'normal' ou 'bold'. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontWeight('bold');

Paramètres

NomTypeDescription
fontWeightStringÉpaisseur de la police, 'bold' ou 'normal'. Une valeur null réinitialise l'épaisseur de la police.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setFormula(formula)

Met à jour la formule pour chaque Range de la liste des plages. La formule donnée doit être au format A1. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
rangeList.setFormula('=SUM(B1:B10)');

Paramètres

NomTypeDescription
formulaStringChaîne représentant la formule à définir.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setFormulaR1C1(formula)

Met à jour la formule pour chaque Range de la liste des plages. La formule donnée doit être au format R1C1. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
// This sets the formula to be the sum of the 3 rows above B5
rangeList.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

Paramètres

NomTypeDescription
formulaStringFormule de chaîne.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setHorizontalAlignment(alignment)

Définissez l'alignement horizontal de chaque Range dans la liste des plages. Les options d'alignement sont 'left', 'center' ou 'right'. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setHorizontalAlignment('center');

Paramètres

NomTypeDescription
alignmentStringL'alignement, soit 'left', 'center' ou 'normal'. Une valeur null réinitialise l'alignement.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setNote(note)

Définit le texte de la note pour chaque Range de la liste des plages. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setNote('This is a note');

Paramètres

NomTypeDescription
noteStringTexte de la note à définir. Une valeur null supprime la note.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setNumberFormat(numberFormat)

Définit le format de nombre ou de date pour chaque Range de la liste de plages.

Les formats acceptés sont décrits dans le guide de mise en forme des dates et des nombres de l'API Sheets. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Always show 3 decimal points for the specified ranges.
rangeList.setNumberFormat('0.000');

Paramètres

NomTypeDescription
numberFormatStringChaîne de format de nombre.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

Indique si chaque Range de la liste de plages doit afficher des liens hypertextes. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Show hyperlinks for all the ranges.
rangeList.setShowHyperlink(true);

Paramètres

NomTypeDescription
showHyperlinkBooleanIndique si le lien hypertexte doit être affiché ou non.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setTextDirection(direction)

Définit l'orientation du texte pour les cellules de chaque Range de la liste des plages. Si une direction spécifiée est null, elle est déduite, puis définie. 

// Sets right-to-left text direction each range in the range list.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Paramètres

NomTypeDescription
directionTextDirectionOrientation du texte souhaitée. Si la valeur est null, l'orientation est déduite avant le paramétrage.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setTextRotation(degrees)

Définit les paramètres de rotation du texte pour les cellules de chaque Range de la liste des plages. La valeur d'entrée correspond à l'angle entre l'orientation standard du texte et l'orientation souhaitée. Une valeur de zéro indique que le texte est défini sur l'orientation standard.

Pour le sens de lecture de gauche à droite, les angles positifs sont dans le sens inverse des aiguilles d'une montre, tandis que pour le sens de lecture de droite à gauche, ils sont dans le sens des aiguilles d'une montre. 

// Sets the cells in the ranges A1:A10 and C1:C10 to have text rotated up 45
// degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

Paramètres

NomTypeDescription
degreesIntegerAngle souhaité entre l'orientation standard et l'orientation souhaitée. Pour le texte de gauche à droite, les angles positifs sont dans le sens antihoraire.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setValue(value)

Définit la valeur pour chaque Range de la liste de plages. La valeur peut être numérique, une chaîne, une valeur booléenne ou une date. S'il commence par "=", il est interprété comme une formule. 

const sheet = SpreadsheetApp.getActiveSheet();
// Set value of 100 to each range in the range list.
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setValue(100);

Paramètres

NomTypeDescription
valueObjectValeur de la plage.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setVerticalAlignment(alignment)

Définissez l'alignement vertical pour chaque Range de la liste des plages. Les options d'alignement sont 'top', 'middle' ou 'bottom'. 

// Sets the vertical alignment to middle for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalAlignment('middle');

Paramètres

NomTypeDescription
alignmentStringL'alignement, soit 'top', 'middle' ou 'bottom'. Une valeur null réinitialise l'alignement.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setVerticalText(isVertical)

Indique si le texte des cellules de chaque Range de la liste de plages doit être empilé ou non. Si le texte est empilé verticalement, le paramètre de rotation du texte en degrés est ignoré. 

// Sets all cell's in ranges D4 and B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalText(true);

Paramètres

NomTypeDescription
isVerticalBooleanIndique si le texte doit être empilé ou non.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setWrap(isWrapEnabled)

Définissez le retour à la ligne pour chaque Range de la liste des plages. Les cellules avec retour à la ligne automatique activé se redimensionnent pour afficher l'intégralité de leur contenu. Les cellules dont le retour à la ligne est désactivé s'affichent autant que possible dans la cellule sans être redimensionnées ni s'étendre sur plusieurs lignes. 

// Enable text wrap for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrap(true);

Paramètres

NomTypeDescription
isWrapEnabledBooleanIndique si le texte doit être mis en retour à la ligne automatique ou non.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

setWrapStrategy(strategy)

Définit la stratégie de retour à la ligne pour chaque Range de la liste de plages. 

// Sets the list of ranges to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Paramètres

NomTypeDescription
strategyWrapStrategyStratégie de retour à la ligne souhaitée.

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

trimWhitespace()

Élimine les espaces blancs (tels que les espaces, les tabulations ou les sauts de ligne) de chaque cellule de cette liste de plages. Supprime tous les espaces au début et à la fin du texte de chaque cellule, et réduit toute sous-séquence de caractères d'espace restants à un seul espace. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

const rangeList = sheet.getRangeList(['A1', 'A2', 'A3', 'A4']);
rangeList.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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

Voir aussi

uncheck()

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

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'unchecked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

Renvois

RangeList : liste de plages, pour le chaînage.

Autorisation

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

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