Class Selection

Выбор

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

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

const 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
const ranges = selection.getActiveRangeList().getRanges();
for (let i = 0; i < ranges.length; i++) {
  console.log(`Active Ranges: ${ranges[i].getA1Notation()}`);
}
console.log(`Active Sheet: ${selection.getActiveSheet().getName()}`);

Методы

Метод Тип возврата Краткое описание
get Active Range() Range Возвращает выбранный диапазон на активном листе или null , если активного диапазона нет.
get Active Range List() Range List Возвращает список активных диапазонов на активном листе или null , если активных диапазонов нет.
get Active Sheet() Sheet Возвращает активный лист в электронной таблице.
get Current Cell() Range Возвращает текущую (выделенную) ячейку, выбранную в одном из активных диапазонов, или null если текущей ячейки нет.
get Next Data Range(direction) Range Начиная с current cell и active range и двигаясь в заданном направлении, возвращает скорректированный диапазон, в котором соответствующий край диапазона был сдвинут, чтобы охватить next data cell , сохраняя при этом текущую ячейку.

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

get Active Range()

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

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

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

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

Авторизация

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

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

get Active Range List()

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

Если выбран один диапазон, это ведет себя как вызов get Active Range() .

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

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

Range List — список активных диапазонов.

Авторизация

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

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

get Active Sheet()

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

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

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

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

Авторизация

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

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

get Current Cell()

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

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

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

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

Авторизация

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

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

get Next Data Range(direction)

Начиная с current cell и active range и двигаясь в заданном направлении, возвращает скорректированный диапазон, в котором соответствующий край диапазона был сдвинут, чтобы охватить next data cell , сохраняя при этом текущую ячейку. Если активный диапазон не ограничен по dimension направления, возвращается исходный активный диапазон. Если текущей ячейки или активного диапазона нет, возвращается null . Это эквивалентно выбору диапазона в редакторе и нажатию Ctrl+Shift+[arrow key] .

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