Class Selection

Pilihan

Akses pilihan aktif saat ini di sheet aktif. Pilihan adalah kumpulan sel yang telah disorot pengguna dalam sheet, yang dapat berupa rentang yang tidak berdekatan. Satu sel yang dipilih adalah sel saat ini, tempat fokus pengguna saat ini berada. Sel saat ini ditandai dengan batas yang lebih gelap di UI Google Spreadsheet.

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getActiveRange()RangeMenampilkan rentang yang dipilih di sheet aktif, atau null jika tidak ada rentang aktif.
getActiveRangeList()RangeListMenampilkan daftar rentang aktif dalam sheet aktif atau null jika tidak ada rentang aktif.
getActiveSheet()SheetMenampilkan sheet aktif di spreadsheet.
getCurrentCell()RangeMenampilkan sel saat ini (ditandai) yang dipilih di salah satu rentang aktif atau null jika tidak ada sel yang aktif.
getNextDataRange(direction)RangeMulai dari current cell dan active range serta bergerak ke arah tertentu, menampilkan rentang yang disesuaikan dengan tepi rentang yang sesuai telah digeser untuk menutupi next data cell sambil tetap menutupi 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.

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

Return

Range — 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 dalam sheet aktif atau null jika tidak ada rentang aktif.

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

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

Return

RangeList — 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 di spreadsheet.

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

Return

Sheet — Sheet aktif di 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 (ditandai) yang dipilih di salah satu rentang aktif atau null jika tidak ada sel yang aktif.

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

Return

Range — 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 serta bergerak ke arah tertentu, menampilkan rentang yang disesuaikan dengan tepi rentang yang sesuai telah digeser untuk menutupi next data cell sambil tetap menutupi sel saat ini. Jika rentang aktif tidak dibatasi di sepanjang dimension pada arah, rentang aktif asli akan ditampilkan. Jika tidak ada sel saat ini atau rentang aktif, null akan ditampilkan. Hal ini sama dengan memilih rentang di editor dan menekan 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());

Parameter

NamaJenisDeskripsi
directionDirectionArah untuk menemukan sel tepi region data berikutnya.

Return

Range — Rentang yang disesuaikan yang menyertakan 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