Class Selection

Auswahl

Greifen Sie auf die aktuelle aktive Auswahl im aktiven Tabellenblatt zu. Eine Auswahl ist die Menge der Zellen, die der Nutzer im Tabellenblatt markiert hat. Dabei kann es sich um nicht angrenzende Bereiche handeln. Eine Zelle in der Auswahl ist die aktuelle Zelle, auf die sich der Nutzer gerade konzentriert. Die aktuelle Zelle wird in der Google Tabellen-Benutzeroberfläche mit einem dunkleren Rahmen hervorgehoben.

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

Methoden

MethodeRückgabetypKurzbeschreibung
getActiveRange()Range|nullGibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist.
getActiveRangeList()RangeList|nullGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine aktiven Bereiche vorhanden sind.
getActiveSheet()SheetGibt das aktive Tabellenblatt in der Tabelle zurück.
getCurrentCell()Range|nullGibt die aktuelle (hervorgehobene) Zelle zurück, die in einem der aktiven Bereiche ausgewählt ist, oder null, wenn keine aktuelle Zelle vorhanden ist.
getNextDataRange(direction)Range|nullBeginnend mit current cell und active range und in der angegebenen Richtung wird ein angepasster Bereich zurückgegeben, in dem die entsprechende Kante des Bereichs verschoben wurde, um next data cell abzudecken und gleichzeitig die aktuelle Zelle abzudecken.

Detaillierte Dokumentation

getActiveRange()

Gibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist. Wenn mehrere Bereiche ausgewählt sind, wird mit dieser Methode nur der zuletzt ausgewählte Bereich zurückgegeben.

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

Rückflug

Range|null: Der aktive Bereich.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getActiveRangeList()

Gibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine aktiven Bereiche vorhanden sind.

Wenn nur ein Bereich ausgewählt ist, verhält sich das wie ein getActiveRange()-Aufruf.

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

Rückflug

RangeList|null: Die Liste der aktiven Bereiche.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getActiveSheet()

Gibt das aktive Tabellenblatt in der Tabelle zurück.

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

Rückflug

Sheet: Das aktive Tabellenblatt in der Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getCurrentCell()

Gibt die aktuelle (hervorgehobene) Zelle zurück, die in einem der aktiven Bereiche ausgewählt ist, oder null, wenn keine aktuelle Zelle vorhanden ist.

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

Rückflug

Range|null: Die aktuelle Zelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getNextDataRange(direction)

Beginnend mit current cell und active range und in der angegebenen Richtung wird ein angepasster Bereich zurückgegeben, in dem die entsprechende Kante des Bereichs verschoben wurde, um next data cell abzudecken und gleichzeitig die aktuelle Zelle abzudecken. Wenn der aktive Bereich entlang der dimension-Richtung unbegrenzt ist, wird der ursprüngliche aktive Bereich zurückgegeben. Wenn es keine aktuelle Zelle oder keinen aktiven Bereich gibt, wird null zurückgegeben. Das entspricht dem Auswählen eines Bereichs im Editor und dem Drücken von 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

NameTypBeschreibung
directionDirectionDie Richtung, in der die nächste Zelle am Rand des Datenbereichs gesucht werden soll.

Rückflug

Range|null: Der angepasste Bereich, der die Datenzelle enthält, oder null, wenn keine Auswahl vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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