Class Selection

Выбор

Доступ к текущему активному выделению на активном листе. Выборка — это набор ячеек, выделенных пользователем на листе, которые могут представлять собой несмежные диапазоны. Одна ячейка в выделенном фрагменте — это текущая ячейка , на которой находится текущий фокус пользователя. Текущая ячейка выделяется более темной рамкой в ​​пользовательском интерфейсе Google Таблиц. 

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

Методы

Метод Тип возврата Краткое описание
getActiveRange() Range Возвращает выбранный диапазон на активном листе или null , если активного диапазона нет.
getActiveRangeList() RangeList Возвращает список активных диапазонов на активном листе или null , если активных диапазонов нет.
getActiveSheet() Sheet Возвращает активный лист в электронной таблице.
getCurrentCell() Range Возвращает текущую (выделенную) ячейку, выбранную в одном из активных диапазонов, или null , если текущей ячейки нет.
getNextDataRange(direction) Range Начиная с current cell и active range и двигаясь в заданном направлении, возвращает скорректированный диапазон, в котором соответствующий край диапазона был сдвинут, чтобы охватить next data cell , при этом охватывая текущую ячейку.

Подробная документация

getActiveRange()

Возвращает выбранный диапазон на активном листе или null , если активного диапазона нет. Если выбрано несколько диапазонов, этот метод возвращает только последний выбранный диапазон. 

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

Возвращаться

Range — активный диапазон.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getActiveRangeList()

Возвращает список активных диапазонов на активном листе или null , если активных диапазонов нет.

Если выбран один диапазон, это действует как вызов getActiveRange() . 

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

Возвращаться

RangeList — Список активных диапазонов.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getActiveSheet()

Возвращает активный лист в электронной таблице. 

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

Возвращаться

Sheet — активный лист в электронной таблице.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getCurrentCell()

Возвращает текущую (выделенную) ячейку, выбранную в одном из активных диапазонов, или null , если текущей ячейки нет. 

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

Возвращаться

Range — текущая ячейка.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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

getNextDataRange(direction)

Начиная с current cell и active range и двигаясь в заданном направлении, возвращает скорректированный диапазон, в котором соответствующий край диапазона был сдвинут, чтобы охватить next data cell , при этом охватывая текущую ячейку. Если активный диапазон не ограничен по dimension направления, возвращается исходный активный диапазон. Если текущей ячейки или активного диапазона нет, возвращается null . Это эквивалентно выбору диапазона в редакторе и нажатию 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());

Параметры

Имя Тип Описание
direction Direction Направление поиска следующей краевой ячейки области данных.

Возвращаться

Range — скорректированный диапазон, включающий ячейку данных, или null если выбор отсутствует.

Авторизация

Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :

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