Class Selection

Sélection

Accéder à la sélection active dans la feuille active. Une sélection correspond à l'ensemble des cellules mises en surbrillance par l'utilisateur dans la feuille, qui peuvent être des plages non adjacentes. L'une des cellules de la sélection est la cellule actuelle, dans laquelle se trouve le curseur de l'utilisateur. Elle est mise en surbrillance avec une bordure plus sombre dans l'interface utilisateur de Google Sheets.

var activeSheet = SpreadsheetApp.getActiveSheet();
var rangeList = activeSheet.getRangeList(['A1:B4', 'D1:E4']);
rangeList.activate();

var selection = activeSheet.getSelection();
// Current Cell: D1
console.log('Current Cell: ' + selection.getCurrentCell().getA1Notation());
// Active Range: D1:E4
console.log('Active Range: ' + selection.getActiveRange().getA1Notation());
// Active Ranges: A1:B4, D1:E4
var ranges =  selection.getActiveRangeList().getRanges();
for (var i = 0; i < ranges.length; i++) {
  console.log('Active Ranges: ' + ranges[i].getA1Notation());
}
console.log('Active Sheet: ' + selection.getActiveSheet().getName());

Méthodes

MéthodeType renvoyéBrève description
getActiveRange()RangeRenvoie la plage sélectionnée dans la feuille active, ou null s'il n'y a pas de plage active.
getActiveRangeList()RangeListRenvoie la liste des plages actives dans la feuille active ou dans null s'il n'y a pas de plages actives.
getActiveSheet()SheetRenvoie la feuille active dans la feuille de calcul.
getCurrentCell()RangeRenvoie la cellule actuelle (en surbrillance) qui est sélectionnée dans l'une des plages actives ou null si aucune cellule n'est en cours.
getNextDataRange(direction)RangeÀ partir de current cell et de active range, et en se déplaçant dans la direction donnée, renvoie une plage ajustée dans laquelle le bord approprié de la plage a été décalé pour couvrir la next data cell tout en recouvrant la cellule actuelle.

Documentation détaillée

getActiveRange()

Renvoie la plage sélectionnée dans la feuille active, ou null s'il n'y a pas de plage active. Si vous sélectionnez plusieurs plages, cette méthode ne renvoie que la dernière plage sélectionnée.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var activeRange = selection.getActiveRange();

Renvois

Range : plage active.

Autorisation

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

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

getActiveRangeList()

Renvoie la liste des plages actives dans la feuille active ou dans null s'il n'y a pas de plages actives.

Si une seule plage est sélectionnée, cela se comporte comme un appel getActiveRange().

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

Renvois

RangeList : liste des plages actives.

Autorisation

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

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

getActiveSheet()

Renvoie la feuille active dans la feuille de calcul.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var activeSheet = selection.getActiveSheet();

Renvois

Sheet : feuille active dans la feuille de calcul.

Autorisation

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

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

getCurrentCell()

Renvoie la cellule actuelle (en surbrillance) qui est sélectionnée dans l'une des plages actives ou null si aucune cellule n'est en cours.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = selection.getCurrentCell();

Renvois

Range : cellule actuellement sélectionnée.

Autorisation

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

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

getNextDataRange(direction)

À partir de current cell et de active range, et en se déplaçant dans la direction donnée, renvoie une plage ajustée dans laquelle le bord approprié de la plage a été décalé pour couvrir la next data cell tout en recouvrant la cellule actuelle. Si la plage active est illimitée le long du dimension de la direction, la plage active d'origine est renvoyée. S'il n'y a pas de cellule actuelle ni de plage active, null est renvoyé. Cela équivaut à sélectionner une plage dans l'éditeur et à appuyer sur Ctrl+Shift+[arrow key].

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

// Makes C3 the current cell and C3:E5 the active range.
sheet.getRange('C3:E5').activate();
// Logs 'C1:E3'
console.log(SpreadsheetApp.getSelection()
                          .getNextDataRange(SpreadsheetApp.Direction.UP)
                          .getA1Notation());

Paramètres

NomTypeDescription
directionDirectionSens dans lequel trouver la cellule de bordure de la région de données suivante.

Renvois

Range : plage ajustée qui inclut la cellule de données, ou null en l'absence de sélection.

Autorisation

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

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