Class Selection

Pilihan

Mengakses pilihan aktif saat ini di sheet aktif. Pilihan adalah sekumpulan sel yang telah ditandai pengguna dalam sheet, yang dapat berupa rentang yang tidak berdekatan. Salah satu sel dalam pilihan adalah sel saat ini, tempat fokus pengguna saat ini berada. Sel saat ini ditandai dengan batas yang lebih gelap di UI Google Spreadsheet. 

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getActiveRange()Range|nullMenampilkan rentang yang dipilih di sheet aktif, atau null jika tidak ada rentang aktif.
getActiveRangeList()RangeList|nullMenampilkan daftar rentang aktif di sheet aktif atau null jika tidak ada rentang aktif.
getActiveSheet()SheetMenampilkan sheet aktif dalam spreadsheet.
getCurrentCell()Range|nullMenampilkan sel saat ini (yang disorot) yang dipilih dalam salah satu rentang aktif atau null jika tidak ada sel saat ini.
getNextDataRange(direction)Range|nullMulai dari current cell dan active range dan bergerak ke arah yang ditentukan, menampilkan rentang yang disesuaikan di mana tepi rentang yang sesuai telah digeser untuk mencakup next data cell sambil tetap mencakup sel saat ini.

Dokumentasi mendetail

getActiveRange()

Menampilkan rentang yang dipilih di sheet aktif, atau null jika tidak ada rentang aktif. Jika beberapa rentang dipilih, metode ini hanya menampilkan rentang terakhir yang dipilih. 

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

Pulang pergi

Range|null — Rentang aktif.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getActiveRangeList()

Menampilkan daftar rentang aktif di sheet aktif atau null jika tidak ada rentang aktif.

Jika ada satu rentang yang dipilih, ini akan berfungsi sebagai panggilan getActiveRange(). 

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

Pulang pergi

RangeList|null — Daftar rentang aktif.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getActiveSheet()

Menampilkan sheet aktif dalam spreadsheet. 

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

Pulang pergi

Sheet — Sheet aktif dalam spreadsheet.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getCurrentCell()

Menampilkan sel saat ini (yang disorot) yang dipilih dalam salah satu rentang aktif atau null jika tidak ada sel saat ini. 

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

Pulang pergi

Range|null — Sel saat ini.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getNextDataRange(direction)

Mulai dari current cell dan active range dan bergerak ke arah yang ditentukan, menampilkan rentang yang disesuaikan di mana tepi rentang yang sesuai telah digeser untuk mencakup next data cell sambil tetap mencakup sel saat ini. Jika rentang aktif tidak terikat di sepanjang dimension arah, rentang aktif asli akan ditampilkan. Jika tidak ada sel saat ini atau rentang aktif, null akan ditampilkan. Tindakan ini sama dengan memilih rentang di editor dan menekan 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(),
);

Parameter

NamaJenisDeskripsi
directionDirectionArah untuk menemukan sel tepi area data berikutnya.

Pulang pergi

Range|null — Rentang yang disesuaikan yang mencakup sel data, atau null jika tidak ada pilihan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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