Class Selection

Wybór

Dostęp do bieżącego aktywnego zaznaczenia w aktywnym arkuszu. Zaznaczenie to zestaw komórek, które użytkownik wyróżnił w arkuszu. Mogą to być niesąsiadujące zakresy. Jedna komórka w zaznaczeniu jest bieżącą komórką, w której użytkownik jest aktualnie skupiony. Bieżąca komórka jest wyróżniona ciemniejszym obramowaniem w interfejsie Arkuszy 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()}`);

Metody

MetodaZwracany typKrótki opis
getActiveRange()RangeZwraca wybrany zakres na aktywnym arkuszu lub null, jeśli nie ma aktywnego zakresu.
getActiveRangeList()RangeListZwraca listę aktywnych zakresów na aktywnym arkuszu lub null, jeśli nie ma aktywnych zakresów.
getActiveSheet()SheetZwraca aktywny arkusz w arkuszu kalkulacyjnym.
getCurrentCell()RangeZwraca bieżącą (zaznaczoną) komórkę wybraną w jednym z aktywnych zakresów lub null, jeśli nie ma bieżącej komórki.
getNextDataRange(direction)RangePocząwszy od komórek current cell i active range i poruszając się w określonym kierunku, zwraca dostosowany zakres, w którym odpowiednia krawędź zakresu została przesunięta, aby objąć komórkę next data cell, a jednocześnie nadal obejmując komórkę aktualną.

Szczegółowa dokumentacja

getActiveRange()

Zwraca wybrany zakres na aktywnym arkuszu lub null, jeśli nie ma aktywnego zakresu. Jeśli wybrano kilka zakresów, ta metoda zwraca tylko ostatni wybrany zakres. 

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

Powrót

Range – aktywny zakres.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getActiveRangeList()

Zwraca listę aktywnych zakresów na aktywnym arkuszu lub null, jeśli nie ma aktywnych zakresów.

Jeśli wybrany jest pojedynczy zakres, działa on jak wywołanie funkcji getActiveRange(). 

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

Powrót

RangeList – lista aktywnych zakresów.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getActiveSheet()

Zwraca aktywny arkusz w arkuszu kalkulacyjnym. 

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

Powrót

Sheet – aktywny arkusz w arkuszu kalkulacyjnym.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getCurrentCell()

Zwraca bieżącą (zaznaczoną) komórkę wybraną w jednym z aktywnych zakresów lub null, jeśli nie ma bieżącej komórki. 

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

Powrót

Range – bieżąca komórka.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getNextDataRange(direction)

Począwszy od komórek current cell i active range i poruszając się w określonym kierunku, zwraca dostosowany zakres, w którym odpowiednia krawędź zakresu została przesunięta, aby objąć komórkę next data cell, a jednocześnie nadal obejmując komórkę aktualną. Jeśli aktywny zakres nie jest ograniczony wzdłuż osi dimension kierunku, zwracany jest pierwotny aktywny zakres. Jeśli nie ma bieżącej komórki lub aktywnego zakresu, zwracana jest wartość null. Jest to równoznaczne z wybraniem zakresu w Edytorze i kliknięciem 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(),
);

Parametry

NazwaTypOpis
directionDirectionKierunek, w którym znajduje się następna komórka krawędzi regionu danych.

Powrót

Range – dostosowany zakres obejmujący komórkę z danymi lub null, jeśli nie ma zaznaczenia.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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