Class Sheet

Sheets

Auf Tabellenblätter zugreifen und sie bearbeiten. Zu den gängigen Vorgängen gehören das Umbenennen eines Tabellenblatts und der Zugriff auf Bereichsobjekte aus dem Tabellenblatt.

Methoden

MethodeRückgabetypKurzbeschreibung
activate()SheetAktiviert dieses Tabellenblatt.
addDeveloperMetadata(key)SheetFügen Sie der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.
addDeveloperMetadata(key, visibility)SheetFügen Sie dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel und der Sichtbarkeit hinzu.
addDeveloperMetadata(key, value)SheetFügen Sie dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.
addDeveloperMetadata(key, value, visibility)SheetFügen Sie dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der Sichtbarkeit hinzu.
appendRow(rowContents)SheetFügt eine Zeile am Ende des aktuellen Datenbereichs im Tabellenblatt an.
asDataSourceSheet()DataSourceSheetGibt das Tabellenblatt als DataSourceSheet zurück, wenn es vom Typ SheetType.DATASOURCE ist, andernfalls als null.
autoResizeColumn(columnPosition)SheetDie Breite der angegebenen Spalte wird an den Inhalt angepasst.
autoResizeColumns(startColumn, numColumns)SheetDie Breite aller Spalten ab der angegebenen Spaltenposition wird so festgelegt, dass sie dem Inhalt entspricht.
autoResizeRows(startRow, numRows)SheetDie Höhe aller Zeilen ab der angegebenen Zeilenposition wird an den Inhalt angepasst.
clear()SheetInhalte und Formatierungsinformationen werden aus dem Tabellenblatt gelöscht.
clear(options)SheetLöscht den Inhalt und/oder das Format des Tabellenblatts, wie in den erweiterten Optionen angegeben.
clearConditionalFormatRules()voidEntfernt alle Regeln für die bedingte Formatierung aus dem Tabellenblatt.
clearContents()SheetDer Inhalt des Tabellenblatts wird gelöscht, während Formatierungsinformationen beibehalten werden.
clearFormats()SheetDie Formatierung des Tabellenblatts wird gelöscht, der Inhalt bleibt erhalten.
clearNotes()SheetLöscht alle Notizen aus dem Tabellenblatt.
collapseAllColumnGroups()SheetAlle Spaltengruppen im Tabellenblatt werden minimiert.
collapseAllRowGroups()SheetAlle Zeilengruppen in der Tabelle werden minimiert.
copyTo(spreadsheet)SheetDas Tabellenblatt wird in eine bestimmte Tabelle kopiert. Das kann dieselbe Tabelle wie die Quelle sein.
createDeveloperMetadataFinder()DeveloperMetadataFinderGibt eine DeveloperMetadataFinder zurück, wenn Entwicklermetadaten im Bereich dieses Tabellenblatts gefunden wurden.
createTextFinder(findText)TextFinderErstellt einen Textsuchmechanismus für das Tabellenblatt, mit dem Text im Tabellenblatt gefunden und ersetzt werden kann.
deleteColumn(columnPosition)SheetLöscht die Spalte an der angegebenen Spaltenposition.
deleteColumns(columnPosition, howMany)voidLöscht eine Reihe von Spalten, beginnend an der angegebenen Spaltenposition.
deleteRow(rowPosition)SheetLöscht die Zeile an der angegebenen Zeilenposition.
deleteRows(rowPosition, howMany)voidLöscht eine Reihe von Zeilen, beginnend an der angegebenen Zeilenposition.
expandAllColumnGroups()SheetMaximiert alle Spaltengruppen im Tabellenblatt.
expandAllRowGroups()SheetMaximiert alle Zeilengruppen auf dem Tabellenblatt.
expandColumnGroupsUpToDepth(groupDepth)SheetHiermit werden alle Spaltengruppen bis zur angegebenen Tiefe maximiert und alle anderen minimiert.
expandRowGroupsUpToDepth(groupDepth)SheetMaximiert alle Zeilengruppen bis zur angegebenen Tiefe und minimiert alle anderen.
getActiveCell()RangeGibt die aktive Zelle in diesem Tabellenblatt zurück.
getActiveRange()RangeGibt den ausgewählten Bereich im aktiven Tabellenblatt zurück oder null, wenn kein aktiver Bereich vorhanden ist.
getActiveRangeList()RangeListGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt zurück oder null, wenn keine aktiven Bereiche vorhanden sind.
getBandings()Banding[]Gibt alle Farbbänder in diesem Tabellenblatt zurück.
getCharts()EmbeddedChart[]Gibt ein Array von Diagrammen auf diesem Tabellenblatt zurück.
getColumnGroup(columnIndex, groupDepth)GroupGibt die Spaltengruppe am angegebenen Index und der angegebenen Gruppentiefe zurück.
getColumnGroupControlPosition()GroupControlTogglePositionGibt den GroupControlTogglePosition für alle Spaltengruppen im Tabellenblatt zurück.
getColumnGroupDepth(columnIndex)IntegerGibt die Gruppentiefe der Spalte am angegebenen Index zurück.
getColumnWidth(columnPosition)IntegerRuft die Breite der angegebenen Spalte in Pixeln ab.
getConditionalFormatRules()ConditionalFormatRule[]Alle Regeln für die bedingte Formatierung in diesem Tabellenblatt abrufen
getCurrentCell()RangeGibt die aktuelle Zelle im aktiven Tabellenblatt zurück oder null, wenn keine aktuelle Zelle vorhanden ist.
getDataRange()RangeGibt ein Range zurück, das den Dimensionen entspricht, in denen Daten vorhanden sind.
getDataSourceFormulas()DataSourceFormula[]Hier werden alle Formeln der Datenquelle abgerufen.
getDataSourcePivotTables()DataSourcePivotTable[]Hier werden alle Pivot-Tabellen der Datenquelle abgerufen.
getDataSourceTables()DataSourceTable[]Hier werden alle Tabellen der Datenquelle abgerufen.
getDeveloperMetadata()DeveloperMetadata[]Alle Entwicklermetadaten abrufen, die mit diesem Tabellenblatt verknüpft sind.
getDrawings()Drawing[]Gibt ein Array von Zeichnungen auf dem Tabellenblatt zurück.
getFilter()FilterGibt den Filter in diesem Tabellenblatt zurück oder null, wenn kein Filter vorhanden ist.
getFormUrl()StringDie URL des Formulars, das seine Antworten an dieses Tabellenblatt sendet, oder null, wenn diesem Tabellenblatt kein Formular zugewiesen ist.
getFrozenColumns()IntegerGibt die Anzahl der fixierten Spalten zurück.
getFrozenRows()IntegerGibt die Anzahl der fixierten Zeilen zurück.
getImages()OverGridImage[]Gibt alle Bilder zurück, die über das Raster hinausragen.
getIndex()IntegerRuft die Position des Tabellenblatts in der übergeordneten Tabelle ab.
getLastColumn()IntegerGibt die Position der letzten Spalte mit Inhalt zurück.
getLastRow()IntegerGibt die Position der letzten Zeile mit Inhalt zurück.
getMaxColumns()IntegerGibt die aktuelle Anzahl der Spalten im Tabellenblatt zurück, unabhängig vom Inhalt.
getMaxRows()IntegerGibt die aktuelle Anzahl der Zeilen im Tabellenblatt zurück, unabhängig vom Inhalt.
getName()StringGibt den Namen des Tabellenblatts zurück.
getNamedRanges()NamedRange[]Hiermit werden alle benannten Bereiche in diesem Tabellenblatt abgerufen.
getParent()SpreadsheetGibt die Spreadsheet zurück, die dieses Tabellenblatt enthält.
getPivotTables()PivotTable[]Gibt alle Pivot-Tabellen in diesem Tabellenblatt zurück.
getProtections(type)Protection[]Hiermit wird ein Array von Objekten zurückgegeben, die alle geschützten Bereiche im Tabellenblatt darstellen, oder ein Array mit einem Element, das den Schutz des Tabellenblatts selbst darstellt.
getRange(row, column)RangeGibt den Bereich mit der linken oberen Zelle an den angegebenen Koordinaten zurück.
getRange(row, column, numRows)RangeGibt den Bereich mit der linken oberen Zelle an den angegebenen Koordinaten und mit der angegebenen Anzahl von Zeilen zurück.
getRange(row, column, numRows, numColumns)RangeGibt den Bereich mit der linken oberen Zelle an den angegebenen Koordinaten mit der angegebenen Anzahl von Zeilen und Spalten zurück.
getRange(a1Notation)RangeGibt den Bereich in A1- oder R1C1-Notation zurück.
getRangeList(a1Notations)RangeListGibt die RangeList-Sammlung zurück, die die Bereiche auf demselben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Bezeichnungen angegeben werden.
getRowGroup(rowIndex, groupDepth)GroupGibt die Zeilengruppe am angegebenen Index und der angegebenen Gruppentiefe zurück.
getRowGroupControlPosition()GroupControlTogglePositionGibt den GroupControlTogglePosition für alle Zeilengruppen im Tabellenblatt zurück.
getRowGroupDepth(rowIndex)IntegerGibt die Gruppenebene der Zeile am angegebenen Index zurück.
getRowHeight(rowPosition)IntegerDie Höhe der angegebenen Zeile in Pixeln.
getSelection()SelectionGibt das aktuelle Selection in der Tabelle zurück.
getSheetId()IntegerGibt die ID des Tabellenblatts zurück, das durch dieses Objekt dargestellt wird.
getSheetName()StringGibt den Tabellennamen zurück.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Gibt das rechteckige Raster mit Werten für diesen Bereich ab den angegebenen Koordinaten zurück.
getSlicers()Slicer[]Gibt ein Array von Segmentierungstools auf dem Tabellenblatt zurück.
getTabColorObject()ColorGibt die Farbe des Tabellenblatts zurück oder null, wenn das Tabellenblatt keine Farbe hat.
getType()SheetTypeGibt den Typ des Tabellenblatts zurück.
hasHiddenGridlines()BooleanGibt true zurück, wenn die Tabellenrasterlinien ausgeblendet sind. Andernfalls wird false zurückgegeben.
hideColumn(column)voidDie Spalte oder Spalten im angegebenen Bereich werden ausgeblendet.
hideColumns(columnIndex)voidBlendet eine einzelne Spalte am angegebenen Index aus.
hideColumns(columnIndex, numColumns)voidBlendet eine oder mehrere aufeinanderfolgende Spalten ab dem angegebenen Index aus.
hideRow(row)voidBlendet die Zeilen im angegebenen Bereich aus.
hideRows(rowIndex)voidDie Zeile am angegebenen Index wird ausgeblendet.
hideRows(rowIndex, numRows)voidEine oder mehrere aufeinanderfolgende Zeilen ab dem angegebenen Index werden ausgeblendet.
hideSheet()SheetBlendet dieses Tabellenblatt aus.
insertChart(chart)voidFügen Sie diesem Tabellenblatt ein neues Diagramm hinzu.
insertColumnAfter(afterPosition)SheetFügt eine Spalte nach der angegebenen Spaltenposition ein.
insertColumnBefore(beforePosition)SheetHiermit wird eine Spalte vor der angegebenen Spaltenposition eingefügt.
insertColumns(columnIndex)voidFügt an der angegebenen Stelle in einem Tabellenblatt eine leere Spalte ein.
insertColumns(columnIndex, numColumns)voidFügt ein oder mehrere aufeinanderfolgende leere Spalten in ein Tabellenblatt ein, beginnend an der angegebenen Stelle.
insertColumnsAfter(afterPosition, howMany)SheetFügt nach der angegebenen Spaltenposition eine bestimmte Anzahl von Spalten ein.
insertColumnsBefore(beforePosition, howMany)SheetHiermit werden mehrere Spalten vor der angegebenen Spaltenposition eingefügt.
insertImage(blobSource, column, row)OverGridImageFügt ein BlobSource als Bild in das Dokument in einer bestimmten Zeile und Spalte ein.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageFügt ein BlobSource als Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem Pixelversatz ein.
insertImage(url, column, row)OverGridImageFügt ein Bild in das Dokument in einer bestimmten Zeile und Spalte ein.
insertImage(url, column, row, offsetX, offsetY)OverGridImageFügt ein Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem Pixelversatz ein.
insertRowAfter(afterPosition)SheetFügt eine Zeile nach der angegebenen Zeilenposition ein.
insertRowBefore(beforePosition)SheetFügt eine Zeile vor der angegebenen Zeilenposition ein.
insertRows(rowIndex)voidFügt an der angegebenen Stelle in einem Tabellenblatt eine leere Zeile ein.
insertRows(rowIndex, numRows)voidFügt eine oder mehrere aufeinanderfolgende leere Zeilen in ein Tabellenblatt ein, beginnend an der angegebenen Stelle.
insertRowsAfter(afterPosition, howMany)SheetFügt nach der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen ein.
insertRowsBefore(beforePosition, howMany)SheetFügt vor der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen ein.
insertSlicer(range, anchorRowPos, anchorColPos)SlicerFügt diesem Tabellenblatt einen neuen Sliver hinzu.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerFügt diesem Tabellenblatt einen neuen Sliver hinzu.
isColumnHiddenByUser(columnPosition)BooleanGibt zurück, ob die angegebene Spalte vom Nutzer ausgeblendet ist.
isRightToLeft()BooleanGibt true zurück, wenn das Tabellenlayout von rechts nach links ist.
isRowHiddenByFilter(rowPosition)BooleanGibt zurück, ob die angegebene Zeile durch einen Filter (nicht durch eine Filteransicht) ausgeblendet ist.
isRowHiddenByUser(rowPosition)BooleanGibt zurück, ob die angegebene Zeile vom Nutzer ausgeblendet ist.
isSheetHidden()BooleanGibt true zurück, wenn das Tabellenblatt derzeit ausgeblendet ist.
moveColumns(columnSpec, destinationIndex)voidVerschiebt die durch den angegebenen Bereich ausgewählten Spalten an die Position, die durch das destinationIndex angegeben ist.
moveRows(rowSpec, destinationIndex)voidVerschiebt die durch den angegebenen Bereich ausgewählten Zeilen an die Position, die durch das destinationIndex angegeben ist.
newChart()EmbeddedChartBuilderHiermit wird ein Builder zurückgegeben, mit dem ein neues Diagramm für dieses Tabellenblatt erstellt werden kann.
protect()ProtectionErstellt ein Objekt, mit dem das Tabellenblatt vor Bearbeitungen geschützt werden kann, mit Ausnahme von Nutzern mit Berechtigung.
removeChart(chart)voidEntfernt ein Diagramm aus dem übergeordneten Tabellenblatt.
setActiveRange(range)RangeDer angegebene Bereich wird als active range in der aktiven Tabelle festgelegt, wobei die linke obere Zelle im Bereich als current cell festgelegt wird.
setActiveRangeList(rangeList)RangeListLegt die angegebene Liste von Bereichen als active ranges im aktiven Tabellenblatt fest.
setActiveSelection(range)RangeLegt den aktiven Auswahlbereich für dieses Tabellenblatt fest.
setActiveSelection(a1Notation)RangeLegt die aktive Auswahl fest, wie in A1- oder R1C1-Notation angegeben.
setColumnGroupControlPosition(position)SheetHiermit wird die Position des Schalters für die Spaltengruppensteuerung auf dem Tabellenblatt festgelegt.
setColumnWidth(columnPosition, width)SheetHiermit wird die Breite der angegebenen Spalte in Pixeln festgelegt.
setColumnWidths(startColumn, numColumns, width)SheetHiermit wird die Breite der angegebenen Spalten in Pixeln festgelegt.
setConditionalFormatRules(rules)voidErsetzt alle derzeit vorhandenen Regeln für die bedingte Formatierung in der Tabelle durch die Eingaberegeln.
setCurrentCell(cell)RangeDie angegebene Zelle wird als current cell festgelegt.
setFrozenColumns(columns)voidDie angegebene Anzahl von Spalten wird fixiert.
setFrozenRows(rows)voidDie angegebene Anzahl von Zeilen wird fixiert.
setHiddenGridlines(hideGridlines)SheetBlendet die Gitternetzlinien des Tabellenblatts ein oder aus.
setName(name)SheetLegt den Tabellennamen fest.
setRightToLeft(rightToLeft)SheetHiermit wird das Layout des Arbeitsblatts auf „Linksläufig“ festgelegt oder aufgehoben.
setRowGroupControlPosition(position)SheetHiermit wird die Position des Ein-/Aus-Schalters für die Zeilengruppensteuerung auf dem Tabellenblatt festgelegt.
setRowHeight(rowPosition, height)SheetLegt die Zeilenhöhe der angegebenen Zeile in Pixeln fest.
setRowHeights(startRow, numRows, height)SheetLegt die Höhe der angegebenen Zeilen in Pixeln fest.
setRowHeightsForced(startRow, numRows, height)SheetLegt die Höhe der angegebenen Zeilen in Pixeln fest.
setTabColor(color)SheetLegt die Farbe des Tabellenblatts fest.
setTabColorObject(color)SheetLegt die Farbe des Tabellenblatts fest.
showColumns(columnIndex)voidDie Spalte am angegebenen Index wird eingeblendet.
showColumns(columnIndex, numColumns)voidBlendet eine oder mehrere aufeinanderfolgende Spalten ab dem angegebenen Index ein.
showRows(rowIndex)voidDie Zeile am angegebenen Index wird sichtbar gemacht.
showRows(rowIndex, numRows)voidEine oder mehrere aufeinanderfolgende Zeilen werden ab dem angegebenen Index sichtbar gemacht.
showSheet()SheetMacht das Tabellenblatt sichtbar.
sort(columnPosition)SheetSortiert ein Tabellenblatt nach Spalte in aufsteigender Reihenfolge.
sort(columnPosition, ascending)SheetSortiert ein Tabellenblatt nach Spalte.
unhideColumn(column)voidDie Spalte im angegebenen Bereich wird eingeblendet.
unhideRow(row)voidBlendet die Zeile im angegebenen Bereich ein.
updateChart(chart)voidAktualisiert das Diagramm auf diesem Tabellenblatt.

Detaillierte Dokumentation

activate()

Aktiviert dieses Tabellenblatt. Das Tabellenblatt selbst wird nicht geändert, sondern nur die Ansicht des übergeordneten Elements.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.activate();

Rückflug

Sheet: Das neu aktive Tabellenblatt.


addDeveloperMetadata(key)

Fügen Sie der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

Parameter

NameTypBeschreibung
keyStringDer Schlüssel für die neuen Entwicklermetadaten.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addDeveloperMetadata(key, visibility)

Fügen Sie dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel und der Sichtbarkeit hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

Parameter

NameTypBeschreibung
keyStringDer Schlüssel für die neuen Entwicklermetadaten.
visibilityDeveloperMetadataVisibilityDie Sichtbarkeit der neuen Entwicklermetadaten.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addDeveloperMetadata(key, value)

Fügen Sie dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for
// the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

Parameter

NameTypBeschreibung
keyStringDer Schlüssel für die neuen Entwicklermetadaten.
valueStringDer Wert für die neuen Entwicklermetadaten.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

addDeveloperMetadata(key, value, visibility)

Fügen Sie dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der Sichtbarkeit hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and
// sets the visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
    'COMPANY',
    'TECH',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Parameter

NameTypBeschreibung
keyStringDer Schlüssel für die neuen Entwicklermetadaten.
valueStringDer Wert für die neuen Entwicklermetadaten.
visibilityDeveloperMetadataVisibilityDie Sichtbarkeit der neuen Entwicklermetadaten.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

appendRow(rowContents)

Fügt eine Zeile am Ende des aktuellen Datenbereichs im Tabellenblatt an. Wenn der Inhalt einer Zelle mit = beginnt, wird er als Formel interpretiert.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(['a man', 'a plan', 'panama']);

Parameter

NameTypBeschreibung
rowContentsObject[]Ein Array mit Werten, die nach der letzten Zeile im Tabellenblatt eingefügt werden sollen.

Rückflug

Sheet: Das Tabellenblatt, nützlich für die Methodenverkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

asDataSourceSheet()

Gibt das Tabellenblatt als DataSourceSheet zurück, wenn es vom Typ SheetType.DATASOURCE ist, andernfalls als null.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

Rückflug

DataSourceSheet: Eine Tabelle mit Datenquellen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

autoResizeColumn(columnPosition)

Die Breite der angegebenen Spalte wird an den Inhalt angepasst.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue(
    'Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der Spalte, deren Größe Sie ändern möchten.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

autoResizeColumns(startColumn, numColumns)

Die Breite aller Spalten ab der angegebenen Spaltenposition wird an den Inhalt angepasst.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

Parameter

NameTypBeschreibung
startColumnIntegerDie Anfangsspalte, deren Größe automatisch angepasst werden soll.
numColumnsIntegerDie Anzahl der Spalten, deren Größe automatisch angepasst werden soll.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

autoResizeRows(startRow, numRows)

Die Höhe aller Zeilen ab der angegebenen Zeilenposition wird an den Inhalt angepasst.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

Parameter

NameTypBeschreibung
startRowIntegerDie Anfangszeile, deren Größe automatisch geändert werden soll.
numRowsIntegerDie Anzahl der Zeilen, deren Größe automatisch geändert werden soll.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

clear()

Inhalte und Formatierungsinformationen werden aus dem Tabellenblatt gelöscht.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clear();

Rückflug

Sheet: Das gelöschte Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

clear(options)

Löscht den Inhalt und/oder das Format des Tabellenblatts, wie in den erweiterten Optionen angegeben.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.clear({formatOnly: true, contentsOnly: true});

Parameter

NameTypBeschreibung
optionsObjectEine JavaScript-Karte mit erweiterten Optionen, die unten aufgeführt sind.

Erweiterte Parameter

NameTypBeschreibung
contentsOnlyBooleanOb der Inhalt gelöscht werden soll.
formatOnlyBooleanGibt an, ob die Formatierung entfernt werden soll.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

clearConditionalFormatRules()

Entfernt alle Regeln für die bedingte Formatierung aus dem Tabellenblatt. Entspricht dem Aufruf von setConditionalFormatRules(rules) mit einem leeren Array als Eingabe.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.clearConditionalFormatRules();

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

clearContents()

Der Inhalt des Tabellenblatts wird gelöscht, während Formatierungsinformationen beibehalten werden.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearContents();

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

clearFormats()

Die Formatierung des Tabellenblatts wird gelöscht, der Inhalt bleibt erhalten.

Die Formatierung bezieht sich auf die Formatierung von Daten, wie sie im Menü „Format“ zulässig ist (z. B. Fett, Kursiv, bedingte Formatierung), und nicht auf die Breite oder Höhe von Zellen.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearFormats();

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

clearNotes()

Löscht alle Notizen aus dem Tabellenblatt.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearNotes();

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

collapseAllColumnGroups()

Alle Spaltengruppen im Tabellenblatt werden minimiert.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

collapseAllRowGroups()

Alle Zeilengruppen in der Tabelle werden minimiert.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

copyTo(spreadsheet)

Das Tabellenblatt wird in eine bestimmte Tabelle kopiert. Das kann dieselbe Tabelle wie die Quelle sein. Die kopierte Tabelle heißt „Kopie von [Originalname]“.

const source = SpreadsheetApp.getActiveSpreadsheet();
const sheet = source.getSheets()[0];

const destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

Parameter

NameTypBeschreibung
spreadsheetSpreadsheetDie Tabelle, in die dieses Tabellenblatt kopiert werden soll. Dies kann dieselbe Tabelle wie die Quelle sein.

Rückflug

Sheet: Das neue Tabellenblatt für die Verknüpfung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

createDeveloperMetadataFinder()

Gibt eine DeveloperMetadataFinder zurück, wenn Entwicklermetadaten im Bereich dieses Tabellenblatts gefunden wurden. Metadaten gehören zu einem bestimmten Tabellenblatt, wenn sie entweder mit dem Tabellenblatt selbst oder mit einer Zeile, Spalte oder einem Bereich auf diesem Tabellenblatt verknüpft sind.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

Rückflug

DeveloperMetadataFinder: Ein Suchtool für Entwicklermetadaten, mit dem Sie nach Metadaten in diesem Tabellenblatt suchen können.


createTextFinder(findText)

Erstellt einen Textsuchmechanismus für das Tabellenblatt, mit dem Text im Tabellenblatt gefunden und ersetzt werden kann.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Creates  a text finder.
const textFinder = sheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the sheet.
const firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
const numOccurrencesReplaced = firstOccurrence.replaceWith('cat');

Parameter

NameTypBeschreibung
findTextStringDer Text, nach dem gesucht werden soll.

Rückflug

TextFinder: Die TextFinder für das Tabellenblatt.


deleteColumn(columnPosition)

Löscht die Spalte an der angegebenen Spaltenposition.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der Spalte, beginnend mit 1 für die erste Spalte.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

deleteColumns(columnPosition, howMany)

Löscht eine Reihe von Spalten, beginnend an der angegebenen Spaltenposition.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der ersten Spalte, die gelöscht werden soll.
howManyIntegerDie Anzahl der zu löschenden Spalten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

deleteRow(rowPosition)

Löscht die Zeile an der angegebenen Zeilenposition.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der Zeile, beginnend mit 1 für die erste Zeile.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

deleteRows(rowPosition, howMany)

Löscht eine Reihe von Zeilen, beginnend an der angegebenen Zeilenposition.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der ersten Zeile, die gelöscht werden soll.
howManyIntegerDie Anzahl der zu löschenden Zeilen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

expandAllColumnGroups()

Maximiert alle Spaltengruppen im Tabellenblatt. Für diese Methode ist mindestens eine Spaltengruppe erforderlich.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

expandAllRowGroups()

Maximiert alle Zeilengruppen auf dem Tabellenblatt. Für diese Methode ist mindestens eine Zeilengruppe erforderlich.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

expandColumnGroupsUpToDepth(groupDepth)

Hiermit werden alle Spaltengruppen bis zur angegebenen Tiefe maximiert und alle anderen minimiert.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

Parameter

NameTypBeschreibung
groupDepthIntegerDie Gruppentiefe, bis zu der die Spaltengruppen maximiert werden sollen.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

expandRowGroupsUpToDepth(groupDepth)

Maximiert alle Zeilengruppen bis zur angegebenen Tiefe und minimiert alle anderen.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

Parameter

NameTypBeschreibung
groupDepthIntegerDie Gruppentiefe, bis zu der die Zeilengruppen maximiert werden sollen.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getActiveCell()

Gibt die aktive Zelle in diesem Tabellenblatt zurück.

Hinweis:Es wird empfohlen, getCurrentCell() zu verwenden, da damit die aktuell markierte Zelle zurückgegeben wird.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Returns the active cell
const cell = sheet.getActiveCell();

Rückflug

Range – die aktuelle aktive Zelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

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, gibt diese Methode nur den zuletzt ausgewählten Bereich zurück.

Der Begriff „aktiver Bereich“ bezieht sich auf den Bereich, den ein Nutzer in der aktiven Tabelle ausgewählt hat. In einer benutzerdefinierten Funktion bezieht er sich jedoch auf die Zelle, die aktiv neu berechnet wird.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const activeRange = sheet.getActiveRange();

Rückflug

Range – der aktive Bereich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen


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 Ganze wie ein getActiveRange()-Aufruf.

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

Rückflug

RangeList – Liste der aktiven Bereiche

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen


getBandings()

Gibt alle Gruppierungen in diesem Tabellenblatt zurück.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the banding info for the sheet.
const bandings = sheet.getBandings();

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

Rückflug

Banding[]: Alle Farbbänder in diesem Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getCharts()

Gibt ein Array von Diagrammen auf diesem Tabellenblatt zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const charts = sheet.getCharts();

for (const i in charts) {
  const chart = charts[i];
  // Do something with the chart
}

Rückflug

EmbeddedChart[]: Ein Array von Diagrammen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getColumnGroup(columnIndex, groupDepth)

Gibt die Spaltengruppe am angegebenen Index und der angegebenen Gruppentiefe zurück.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
const columnGroup = sheet.getColumnGroup(2, 1);

Parameter

NameTypBeschreibung
columnIndexIntegerDer Spaltenindex der Gruppensteuerung oder ein Index innerhalb der Gruppe.
groupDepthIntegerDie Tiefe der Gruppe.

Rückflug

Group: Die Spaltengruppe am Steuerelementindex und der Steuerelementtiefe. Andernfalls wird eine Ausnahme ausgelöst, wenn die Gruppe nicht vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getColumnGroupControlPosition()

Gibt den GroupControlTogglePosition für alle Spaltengruppen im Tabellenblatt zurück.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the column grouping control toggle is
// shown after the group.
const columnGroupControlPosition = sheet.getColumnGroupControlPosition();

Rückflug

GroupControlTogglePosition bis true, wenn die Ein/Aus-Schaltfläche für die Spaltengruppierung nach der Gruppe auf diesem Tabellenblatt angezeigt wird, andernfalls false.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getColumnGroupDepth(columnIndex)

Gibt die Gruppentiefe der Spalte am angegebenen Index zurück.

Die Gruppentiefe gibt an, wie viele Gruppen sich mit der Spalte überschneiden. Dieser Wert kann zwischen null und acht liegen.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over columns 1 through 3
const groupDepth = sheet.getColumnGroupDepth(1);

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index der Spalte.

Rückflug

Integer: Die Gruppentiefe der Spalte am angegebenen Index.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getColumnWidth(columnPosition)

Ruft die Breite der angegebenen Spalte in Pixeln ab.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu prüfenden Spalte.

Rückflug

Integer: Spaltenbreite in Pixeln

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getConditionalFormatRules()

Alle Regeln für die bedingte Formatierung in diesem Tabellenblatt abrufen

// Logs the conditional format rules in a sheet.
const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const rule = rules[i];
  Logger.log(rule);
}

Rückflug

ConditionalFormatRule[]: Ein Array mit allen Regeln in der Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getCurrentCell()

Gibt die aktuelle Zelle im aktiven Tabellenblatt zurück oder null, wenn keine aktuelle Zelle vorhanden ist. Die aktuelle Zelle ist die Zelle, die in Google Tabellen den Fokus hat. Sie ist durch einen dunklen Rahmen hervorgehoben. Es gibt nie mehr als eine aktuelle Zelle. Wenn ein Nutzer einen oder mehrere Zellenbereiche auswählt, ist eine der Zellen in der Auswahl die aktuelle Zelle.

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

Rückflug

Range – die aktuelle Zelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataRange()

Gibt ein Range zurück, das den Dimensionen entspricht, in denen Daten vorhanden sind.

Das entspricht funktional dem Erstellen eines Bereichs, der durch A1 und (Sheet.getLastColumn(), Sheet.getLastRow()) begrenzt ist.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This represents ALL the data
const range = sheet.getDataRange();
const values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = `${row},`;
  }
  Logger.log(row);
}

Rückflug

Range: ein Bereich, der alle Daten in der Tabelle enthält

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourceFormulas()

Hier werden alle Formeln der Datenquelle abgerufen.

// Opens the spreadsheet by its ID. If you created your script from within a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Rückflug

DataSourceFormula[]: Liste der Datenquellenformeln.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourcePivotTables()

Hier werden alle Pivot-Tabellen der Datenquelle abgerufen.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Rückflug

DataSourcePivotTable[]: Liste der Pivot-Tabellen der Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDataSourceTables()

Hier werden alle Tabellen der Datenquelle abgerufen.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Rückflug

DataSourceTable[]: Liste der Tabellen der Datenquelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDeveloperMetadata()

Alle Entwicklermetadaten abrufen, die mit diesem Tabellenblatt verknüpft sind.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

Rückflug

DeveloperMetadata[]: Die mit diesem Tabellenblatt verknüpften Entwicklermetadaten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getDrawings()

Gibt ein Array von Zeichnungen auf dem Tabellenblatt zurück.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

// Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

Rückflug

Drawing[]: Liste der Zeichnungen auf diesem Blatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getFilter()

Gibt den Filter in diesem Tabellenblatt zurück oder null, wenn kein Filter vorhanden ist.

// Gets the filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();

Rückflug

Filter: Der Filter.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getFormUrl()

Die URL des Formulars, das seine Antworten an dieses Tabellenblatt sendet, oder null, wenn diesem Tabellenblatt kein Formular zugewiesen ist. Es wird eine Ausnahme ausgelöst, wenn der Nutzer keine Berechtigung zum Bearbeiten der Tabelle hat.

const sheet = SpreadsheetApp.getActiveSheet();
const url = sheet.getFormUrl();

Rückflug

String: Die URL des Formulars, dessen Antworten in diese Tabelle eingetragen werden. Wenn dieser Tabelle kein Formular zugewiesen ist, wird null angezeigt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getFrozenColumns()

Gibt die Anzahl der fixierten Spalten zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());

Rückflug

Integer – die Anzahl der fixierten Spalten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getFrozenRows()

Gibt die Anzahl der fixierten Zeilen zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());

Rückflug

Integer – die Anzahl der fixierten Zeilen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getImages()

Gibt alle Bilder zurück, die über das Raster hinausragen.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use
// ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
  console.log(image.getAnchorCell().getA1Notation());
}

Rückflug

OverGridImage[]: Eine Reihe von über das Raster gelegten Bildern.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getIndex()

Ruft die Position des Tabellenblatts in der übergeordneten Tabelle ab. Beginnt mit 1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
const sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

Rückflug

Integer: Die Position des Tabellenblatts in der übergeordneten Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getLastColumn()

Gibt die Position der letzten Spalte mit Inhalt zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Rückflug

Integer: die letzte Spalte der Tabelle, die Inhalte enthält

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getLastRow()

Gibt die Position der letzten Zeile mit Inhalt zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Rückflug

Integer: die letzte Zeile der Tabelle, die Inhalte enthält

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getMaxColumns()

Gibt die aktuelle Anzahl der Spalten im Tabellenblatt zurück, unabhängig vom Inhalt.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxColumns());

Rückflug

Integer: Die maximale Breite des Tabellenblatts.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getMaxRows()

Gibt die aktuelle Anzahl der Zeilen im Tabellenblatt zurück, unabhängig vom Inhalt.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxRows());

Rückflug

Integer: Die maximale Höhe des Tabellenblatts.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getName()

Gibt den Namen des Tabellenblatts zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
Logger.log(sheet.getName());

Rückflug

String: Der Name des Tabellenblatts.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getNamedRanges()

Hiermit werden alle benannten Bereiche in diesem Tabellenblatt abgerufen.

// The code below logs the name of the first named range.
const namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

Rückflug

NamedRange[]: Ein Array aller benannten Bereiche im Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getParent()

Gibt die Spreadsheet zurück, die dieses Tabellenblatt enthält.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// parent is identical to ss
const parent = sheet.getParent();

Rückflug

Spreadsheet: Die übergeordnete Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getPivotTables()

Gibt alle Pivot-Tabellen in diesem Tabellenblatt zurück.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

Rückflug

PivotTable[]: Die Pivot-Tabellen auf diesem Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getProtections(type)

Hiermit wird ein Array von Objekten zurückgegeben, die alle geschützten Bereiche im Tabellenblatt darstellen, oder ein Array mit einem Element, das den Schutz des Tabellenblatts selbst darstellt.

// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const sheet = SpreadsheetApp.getActiveSheet();
const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
  protection.remove();
}

Parameter

NameTypBeschreibung
typeProtectionTypeDer Typ des Schutzgebiets, entweder SpreadsheetApp.ProtectionType.RANGE oder SpreadsheetApp.ProtectionType.SHEET.

Rückflug

Protection[]: Ein Array von Objekten, das alle geschützten Bereiche im Tabellenblatt darstellt, oder ein Array mit einem Element, das den Schutz des Tabellenblatts selbst darstellt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRange(row, column)

Gibt den Bereich mit der linken oberen Zelle an den angegebenen Koordinaten zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
const range = sheet.getRange(1, 1);
const values = range.getValues();
Logger.log(values[0][0]);

Parameter

NameTypBeschreibung
rowIntegerDer Zeilenindex der Zelle, die zurückgegeben werden soll. Die Zeilenindexierung beginnt mit 1.
columnIntegerDer Spaltenindex der Zelle, die zurückgegeben werden soll. Die Spaltenindexierung beginnt mit 1.

Rückflug

Range: Ein Bereich, der nur diese Zelle enthält.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRange(row, column, numRows)

Gibt den Bereich mit der linken oberen Zelle an den angegebenen Koordinaten und mit der angegebenen Anzahl von Zeilen zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is
// returned.
const range = sheet.getRange(1, 1, 3);
const values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parameter

NameTypBeschreibung
rowIntegerDer Zeilenindex des Bereichs. Die Zeilenindexierung beginnt mit 1.
columnIntegerDer Spaltenindex des Bereichs. Die Spaltenindexierung beginnt mit 1.
numRowsIntegerDie Anzahl der zurückzugebenden Zeilen.

Rückflug

Range: Ein Bereich mit einer einzelnen Datenspalte mit der angegebenen Anzahl von Zeilen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRange(row, column, numRows, numColumns)

Gibt den Bereich mit der linken oberen Zelle an den angegebenen Koordinaten mit der angegebenen Anzahl von Zeilen und Spalten zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 3, 3);
const values = range.getValues();

// Print values from a 3x3 box.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Parameter

NameTypBeschreibung
rowIntegerDer Zeilenindex des Bereichs. Die Zeilenindexierung beginnt mit 1.
columnIntegerDer Startindex der Spalte im Bereich. Die Spaltenindexierung beginnt mit 1.
numRowsIntegerDie Anzahl der zurückzugebenden Zeilen.
numColumnsIntegerDie Anzahl der zurückzugebenden Spalten.

Rückflug

Range: Ein Bereich, der dem angegebenen Gebiet entspricht.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRange(a1Notation)

Gibt den Bereich in A1- oder R1C1-Notation zurück.

// Get a range A1:D4 on sheet titled "Invoices"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

// Get cell A1 on the first sheet
const sheet = ss.getSheets()[0];
const cell = sheet.getRange('A1');

Parameter

NameTypBeschreibung
a1NotationStringDer Bereich, der zurückgegeben werden soll, in A1- oder R1C1-Notation.

Rückflug

Range – der Bereich am angegebenen Standort

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRangeList(a1Notations)

Gibt die RangeList-Sammlung zurück, die die Bereiche auf demselben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Bezeichnungen angegeben werden.

// Get a list of ranges A1:D4, F1:H4.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);

Parameter

NameTypBeschreibung
a1NotationsString[]Liste der zurückzugebenden Bereiche, angegeben in A1- oder R1C1-Notation.

Rückflug

RangeList – die Bereichsliste am angegebenen Standort

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRowGroup(rowIndex, groupDepth)

Gibt die Zeilengruppe am angegebenen Index und der angegebenen Gruppentiefe zurück.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
const rowGroup = sheet.getRowGroup(2, 1);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Zeilenindex der Gruppensteuerung oder ein Index innerhalb der Gruppe.
groupDepthIntegerDie Tiefe der Gruppe.

Rückflug

Group: Die Zeilengruppe mit dem Index und der Tiefe der Steuerung. Andernfalls wird eine Ausnahme ausgelöst, wenn die Gruppe nicht vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRowGroupControlPosition()

Gibt den GroupControlTogglePosition für alle Zeilengruppen im Tabellenblatt zurück.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown
// after the group.
const rowGroupControlPosition = sheet.getRowGroupControlPosition();

Rückflug

GroupControlTogglePosition bis true, wenn das Umschaltfeld für die Zeilengruppierung nach der Gruppe auf diesem Tabellenblatt angezeigt wird, andernfalls false.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRowGroupDepth(rowIndex)

Gibt die Gruppenebene der Zeile am angegebenen Index zurück.

Die Gruppentiefe gibt an, wie viele Gruppen sich mit der Zeile überschneiden. Dieser Wert kann zwischen null und acht liegen.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over rows 1 through 3
const groupDepth = sheet.getRowGroupDepth(1);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Index der Zeile.

Rückflug

Integer: Die Gruppentiefe der Zeile am angegebenen Index.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getRowHeight(rowPosition)

Die Höhe der angegebenen Zeile in Pixeln.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der Zeile, die geprüft werden soll.

Rückflug

Integer – Zeilenhöhe in Pixeln

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSelection()

Gibt das aktuelle Selection in der Tabelle zurück.

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const currentCell = selection.getCurrentCell();

Rückflug

Selection – die aktuelle Auswahl

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSheetId()

Gibt die ID des Tabellenblatts zurück, das durch dieses Objekt dargestellt wird.

Dies ist eine eindeutige ID für die Tabelle. Die ID ist eine monoton steigende Ganzzahl, die beim Erstellen des Tabellenblatts zugewiesen wird und unabhängig von der Tabellenblattposition ist. Das ist nützlich in Verbindung mit Methoden wie Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd), die einen gridId-Parameter anstelle einer Sheet-Instanz annehmen.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

Rückflug

Integer: Eine eindeutige ID für die Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSheetName()

Gibt den Tabellennamen zurück.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

Rückflug

String – der Name der Tabelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Gibt das rechteckige Raster mit Werten für diesen Bereich ab den angegebenen Koordinaten zurück. Wenn Sie als Zeilen- oder Spaltenposition den Wert „-1“ angeben, wird die letzte Zeile oder Spalte mit Daten im Tabellenblatt zurückgegeben.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// The two samples below produce the same output
let values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

const range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Parameter

NameTypBeschreibung
startRowIntegerDie Position der Startzeile.
startColumnIntegerDie Position der Startspalte.
numRowsIntegerDie Anzahl der Zeilen, für die Werte zurückgegeben werden sollen.
numColumnsIntegerDie Anzahl der Spalten, für die Werte zurückgegeben werden sollen.

Rückflug

Object[][] – ein zweidimensionales Array von Werten

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getSlicers()

Gibt ein Array von Segmentierungstools auf dem Tabellenblatt zurück.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

Rückflug

Slicer[]: Liste der Segmentierungstools auf diesem Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getTabColorObject()

Gibt die Farbe des Tabellenblatts zurück oder null, wenn das Tabellenblatt keine Farbe hat.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = first.getTabColorObject();

Rückflug

Color: Die Farbe des Tabellenblatt-Tabs oder null, wenn der Tabellenblatt-Tab keine Farbe hat.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getType()

Gibt den Typ des Tabellenblatts zurück.

Der Standardtyp für Blätter ist SheetType.GRID. Ein Tabellenblatt, das ein einzelnes eingebettetes Objekt wie ein EmbeddedChart enthält, ist ein SheetType.OBJECT-Tabellenblatt.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
Logger.log(sheet.getType());

Rückflug

SheetType: Der Typ des Tabellenblatts.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hasHiddenGridlines()

Gibt true zurück, wenn die Tabellenrasterlinien ausgeblendet sind. Andernfalls wird false zurückgegeben. Rasterlinien sind standardmäßig sichtbar.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if the spreadsheet has hidden gridelines and logs the result to the
// console.
console.log(sheet.hasHiddenGridlines());

Rückflug

Boolean – true, wenn die Rasterlinien ausgeblendet sind, andernfalls false.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hideColumn(column)

Die Spalte oder die Spalten im angegebenen Bereich werden ausgeblendet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange('A1');
sheet.hideColumn(range);

// This hides the first 3 columns
range = sheet.getRange('A:C');
sheet.hideColumn(range);

Parameter

NameTypBeschreibung
columnRangeDer Spaltenbereich, der ausgeblendet werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hideColumns(columnIndex)

Blendet eine einzelne Spalte am angegebenen Index aus. Verwenden Sie für diese Methode den Index 1.

Wenn Sie mehrere Spalten mit einem Index ausblenden möchten, verwenden Sie hideColumns(columnIndex, numColumns).

Wenn Sie mehrere Spalten mit einem Bereich ausblenden möchten, verwenden Sie hideColumn().

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index der Spalte, die ausgeblendet werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hideColumns(columnIndex, numColumns)

Blendet eine oder mehrere aufeinanderfolgende Spalten ab dem angegebenen Index aus. Verwenden Sie für diese Methode den Index 1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

Parameter

NameTypBeschreibung
columnIndexIntegerDer Startindex der zu blendenden Spalten.
numColumnsIntegerDie Anzahl der zu blendenden Spalten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hideRow(row)

Blendet die Zeilen im angegebenen Bereich aus.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first row
const range = sheet.getRange('A1');
sheet.hideRow(range);

Parameter

NameTypBeschreibung
rowRangeDer zu blendende Zeilenbereich.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hideRows(rowIndex)

Die Zeile am angegebenen Index wird ausgeblendet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Index der Zeile, die ausgeblendet werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hideRows(rowIndex, numRows)

Eine oder mehrere aufeinanderfolgende Zeilen ab dem angegebenen Index werden ausgeblendet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Startindex der zu versteckenden Zeilen.
numRowsIntegerDie Anzahl der Zeilen, die ausgeblendet werden sollen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

hideSheet()

Blendet dieses Tabellenblatt aus. Hat keine Auswirkungen, wenn das Tabellenblatt bereits ausgeblendet ist. Wenn diese Methode für das einzige sichtbare Tabellenblatt aufgerufen wird, wird eine Ausnahme ausgelöst.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.hideSheet();

Rückflug

Sheet: Das aktuelle Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertChart(chart)

Fügen Sie diesem Tabellenblatt ein neues Diagramm hinzu.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
const chart = sheet.newChart()
                  .setChartType(Charts.ChartType.BAR)
                  .addRange(sheet.getRange('A1:B4'))
                  .setPosition(5, 5, 0, 0)
                  .setOption('title', 'Dynamic Chart')
                  .build();
sheet.insertChart(chart);

Parameter

NameTypBeschreibung
chartEmbeddedChartDas einzufügende Diagramm.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumnAfter(afterPosition)

Fügt eine Spalte an der angegebenen Spaltenposition ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Parameter

NameTypBeschreibung
afterPositionIntegerDie Spalte, nach der die neue Spalte eingefügt werden soll.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumnBefore(beforePosition)

Hiermit wird eine Spalte vor der angegebenen Spaltenposition eingefügt.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Parameter

NameTypBeschreibung
beforePositionIntegerDie Spalte, vor der die neue Spalte eingefügt werden soll.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumns(columnIndex)

Fügt an der angegebenen Stelle in einem Tabellenblatt eine leere Spalte ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index, der angibt, wo eine Spalte eingefügt werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumns(columnIndex, numColumns)

Fügt ein oder mehrere aufeinanderfolgende leere Spalten in ein Tabellenblatt ein, beginnend an der angegebenen Stelle.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index, der angibt, wo eine Spalte eingefügt werden soll.
numColumnsIntegerDie Anzahl der einzufügenden Spalten.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumnsAfter(afterPosition, howMany)

Fügt nach der angegebenen Spaltenposition eine bestimmte Anzahl von Spalten ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

Parameter

NameTypBeschreibung
afterPositionIntegerDie Spalte, nach der die neue Spalte eingefügt werden soll.
howManyIntegerDie Anzahl der einzufügenden Spalten.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertColumnsBefore(beforePosition, howMany)

Fügt vor der angegebenen Spaltenposition eine Reihe von Spalten ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Parameter

NameTypBeschreibung
beforePositionIntegerDie Spalte, vor der die neue Spalte eingefügt werden soll.
howManyIntegerDie Anzahl der einzufügenden Spalten.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertImage(blobSource, column, row)

Fügt ein BlobSource als Bild in das Dokument in einer bestimmten Zeile und Spalte ein. Die Bildgröße wird aus dem Blob-Inhalt abgerufen. Blobs dürfen maximal 2 MB groß sein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parameter

NameTypBeschreibung
blobSourceBlobSourceDer Blob mit dem Bildinhalt, dem MIME-Typ und (optional) dem Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertImage(blobSource, column, row, offsetX, offsetY)

Fügt ein BlobSource als Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem Pixelversatz ein. Die Bildgröße wird aus dem Blob-Inhalt abgerufen. Blobs dürfen maximal 2 MB groß sein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parameter

NameTypBeschreibung
blobSourceBlobSourceDer Blob mit dem Bildinhalt, dem MIME-Typ und (optional) dem Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Abstand von der Zellenecke in Pixeln.
offsetYIntegerDer vertikale Offset von der Zellenecke in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertImage(url, column, row)

Fügt ein Bild in das Dokument in einer bestimmten Zeile und Spalte ein.

Die angegebene URL muss öffentlich zugänglich sein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);

Parameter

NameTypBeschreibung
urlStringDie URL des Bildes.
columnIntegerDie Position der Rasterspalte.
rowIntegerDie Position der Rasterzeile.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertImage(url, column, row, offsetX, offsetY)

Fügt ein Bild in das Dokument in einer bestimmten Zeile und Spalte mit einem Pixelversatz ein.

Die angegebene URL muss öffentlich zugänglich sein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage(
    'https://www.google.com/images/srpr/logo3w.png',
    1,
    1,
    10,
    10,
);

Parameter

NameTypBeschreibung
urlStringDie URL für das Bild.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Abstand von der Zellenecke in Pixeln.
offsetYIntegerDer vertikale Offset von der Zellenecke in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertRowAfter(afterPosition)

Fügt eine Zeile nach der angegebenen Zeilenposition ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Parameter

NameTypBeschreibung
afterPositionIntegerDie Zeile, nach der die neue Zeile eingefügt werden soll.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertRowBefore(beforePosition)

Fügt eine Zeile vor der angegebenen Zeilenposition ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Parameter

NameTypBeschreibung
beforePositionIntegerDie Zeile, vor der die neue Zeile eingefügt werden soll.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertRows(rowIndex)

Fügt an der angegebenen Stelle in einem Tabellenblatt eine leere Zeile ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Index, der angibt, wo eine Zeile eingefügt werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertRows(rowIndex, numRows)

Fügt eine oder mehrere aufeinanderfolgende leere Zeilen in ein Tabellenblatt ein, beginnend an der angegebenen Stelle.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Index, der angibt, wo eine Zeile eingefügt werden soll.
numRowsIntegerDie Anzahl der einzufügenden Zeilen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertRowsAfter(afterPosition, howMany)

Fügt nach der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Parameter

NameTypBeschreibung
afterPositionIntegerDie Zeile, nach der die neuen Zeilen eingefügt werden sollen.
howManyIntegerDie Anzahl der einzufügenden Zeilen.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertRowsBefore(beforePosition, howMany)

Fügt vor der angegebenen Zeilenposition eine bestimmte Anzahl von Zeilen ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Parameter

NameTypBeschreibung
beforePositionIntegerDie Zeile, vor der die neuen Zeilen eingefügt werden sollen.
howManyIntegerDie Anzahl der einzufügenden Zeilen.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSlicer(range, anchorRowPos, anchorColPos)

Fügt diesem Tabellenblatt einen neuen Sliver hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range of the sheet.
const range = sheet.getRange('A1:D10');

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Parameter

NameTypBeschreibung
rangeRangeDer Bereich, über den der Datenschnitt erstellt wird.
anchorRowPosIntegerDie Oberseite des Sprengschnitts ist in dieser Zeile verankert.
anchorColPosIntegerDie obere Seite des Sliciers ist in dieser Spalte verankert.

Rückflug

Slicer: Der neu eingefügte Datenschnitt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)

Fügt diesem Tabellenblatt einen neuen Sliver hinzu.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range.
const range = sheet.getRange('A1:D10');

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Parameter

NameTypBeschreibung
rangeRangeDer Bereich, über den der Datenschnitt erstellt wird.
anchorRowPosIntegerDie Oberseite des Sprengschnitts ist in dieser Zeile verankert.
anchorColPosIntegerDie Oberseite des Slicers ist in dieser Spalte verankert.
offsetXIntegerDer horizontale Abstand von der Zellenecke in Pixeln.
offsetYIntegerDer vertikale Offset von der Zellenecke in Pixeln.

Rückflug

Slicer: Der neu eingefügte Datenschnitt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isColumnHiddenByUser(columnPosition)

Gibt an, ob die angegebene Spalte vom Nutzer ausgeblendet ist.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu prüfenden Spalte.

Rückflug

Boolean – true, wenn die Spalte ausgeblendet ist, andernfalls false.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isRightToLeft()

Gibt true zurück, wenn das Tabellenlayout von rechts nach links ist. Gibt false zurück, wenn auf dem Tabellenblatt das Standardlayout von links nach rechts verwendet wird.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to
// the console.
console.log(sheet.isRightToLeft());

Rückflug

Boolean – true bei Rechtsschreibrichtung, false bei Linksschreibrichtung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isRowHiddenByFilter(rowPosition)

Gibt zurück, ob die angegebene Zeile durch einen Filter (nicht durch eine Filteransicht) ausgeblendet ist.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der Zeile, die geprüft werden soll.

Rückflug

Boolean – true, wenn die Zeile ausgeblendet ist, andernfalls false.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isRowHiddenByUser(rowPosition)

Gibt zurück, ob die angegebene Zeile vom Nutzer ausgeblendet ist.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der Zeile, die geprüft werden soll.

Rückflug

Boolean – true, wenn die Zeile ausgeblendet ist, andernfalls false.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

isSheetHidden()

Gibt true zurück, wenn das Tabellenblatt derzeit ausgeblendet ist.

const sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

Rückflug

Boolean – true, wenn das Tabellenblatt ausgeblendet ist, andernfalls false.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

moveColumns(columnSpec, destinationIndex)

Verschiebt die durch den angegebenen Bereich ausgewählten Spalten an die Position, die durch das destinationIndex angegeben ist. Das columnSpec muss nicht genau eine ganze Spalte oder eine Gruppe von Spalten darstellen, die verschoben werden sollen. Es werden alle Spalten ausgewählt, die der Bereich umfasst.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

Parameter

NameTypBeschreibung
columnSpecRangeEin Bereich, der die Spalten umfasst, die verschoben werden sollen.
destinationIndexIntegerDer Index, zu dem die Spalten verschoben werden sollen. Dieser Index basiert auf den Koordinaten vor dem Verschieben der Spalten. Vorhandene Daten werden nach rechts verschoben, um Platz für die verschobenen Spalten zu schaffen. Die Quellspalten werden aus dem Raster entfernt. Daher werden die Daten möglicherweise in einem anderen Index als ursprünglich angegeben gespeichert.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

moveRows(rowSpec, destinationIndex)

Verschiebt die durch den angegebenen Bereich ausgewählten Zeilen an die Position, die durch das destinationIndex angegeben ist. Das rowSpec muss nicht genau eine ganze Zeile oder eine Gruppe von Zeilen darstellen, die verschoben werden sollen. Es werden alle Zeilen ausgewählt, die der Bereich umfasst.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

Parameter

NameTypBeschreibung
rowSpecRangeEin Bereich, der die Zeilen umfasst, die verschoben werden sollen.
destinationIndexIntegerDer Index, zu dem die Zeilen verschoben werden sollen. Dieser Index basiert auf den Koordinaten vor dem Verschieben der Zeilen. Vorhandene Daten werden nach unten verschoben, um Platz für die verschobenen Zeilen zu schaffen. Die Quellzeilen werden aus dem Raster entfernt. Daher werden die Daten möglicherweise in einem anderen Index als ursprünglich angegeben gespeichert.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

newChart()

Hiermit wird ein Builder zurückgegeben, mit dem ein neues Diagramm für dieses Tabellenblatt erstellt werden kann.

In diesem Beispiel wird gezeigt, wie Sie ein neues Diagramm erstellen:

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

Rückflug

EmbeddedChartBuilder: Ein Builder zum Erstellen eines neuen Diagramms.


protect()

Erstellt ein Objekt, mit dem das Tabellenblatt vor Bearbeitungen geschützt werden kann, mit Ausnahme von Nutzern mit Berechtigung. Solange das Script die Liste der Bearbeiter für das Tabellenblatt nicht tatsächlich ändert (durch Aufruf von Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) oder Festlegen eines neuen Werts für Protection.setDomainEdit(editable)), entsprechen die Berechtigungen denen des Tabellenblatts selbst. Das bedeutet, dass das Tabellenblatt weiterhin ungeschützt bleibt. Wenn das Tabellenblatt bereits geschützt ist, gibt diese Methode ein Objekt zurück, das die vorhandenen Schutzeinstellungen darstellt. Ein geschütztes Tabellenblatt kann ungeschützte Bereiche enthalten.

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if
// the user's edit permission comes from a group, the script throws an exception
// upon removing the group.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

Rückflug

Protection: Ein Objekt, das die Schutzeinstellungen darstellt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

removeChart(chart)

Entfernt ein Diagramm aus dem übergeordneten Tabellenblatt.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This removes all the embedded charts from the spreadsheet
const charts = sheet.getCharts();
for (const i in charts) {
  sheet.removeChart(charts[i]);
}

Parameter

NameTypBeschreibung
chartEmbeddedChartDas zu entfernende Diagramm.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveRange(range)

Der angegebene Bereich wird als active range in der aktiven Tabelle festgelegt, wobei die linke obere Zelle im Bereich als current cell festgelegt wird.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D4
const activeRange = selection.getActiveRange();

Parameter

NameTypBeschreibung
rangeRangeDer Bereich, der als aktiver Bereich festgelegt werden soll.

Rückflug

Range – der neu aktive Bereich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveRangeList(rangeList)

Legt die angegebene Liste von Bereichen als active ranges im aktiven Tabellenblatt fest. Der letzte Bereich in der Liste wird als active range festgelegt.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Parameter

NameTypBeschreibung
rangeListRangeListListe der auszuwählenden Bereiche.

Rückflug

RangeList: die neu ausgewählte Liste von Bereichen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveSelection(range)

Legt den aktiven Auswahlbereich für dieses Tabellenblatt fest.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

Parameter

NameTypBeschreibung
rangeRangeDer Bereich, der als aktive Auswahl festgelegt werden soll.

Rückflug

Range – der neu aktive Bereich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setActiveSelection(a1Notation)

Legt die aktive Auswahl fest, wie in A1- oder R1C1-Notation angegeben.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.setActiveSelection('A1:D4');

Parameter

NameTypBeschreibung
a1NotationStringDer Bereich, der als aktiv festgelegt werden soll, in A1- oder R1C1-Notation.

Rückflug

Range – der neu aktive Bereich

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setColumnGroupControlPosition(position)

Hiermit wird die Position des Schalters für die Spaltengruppensteuerung auf dem Tabellenblatt festgelegt.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Parameter

NameTypBeschreibung
positionGroupControlTogglePositionDie Position der Ein/Aus-Schaltfläche für die Spaltengruppensteuerung.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setColumnWidth(columnPosition, width)

Hiermit wird die Breite der angegebenen Spalte in Pixeln festgelegt.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu setzenden Spalte.
widthIntegerDie Breite in Pixeln.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setColumnWidths(startColumn, numColumns, width)

Hiermit wird die Breite der angegebenen Spalten in Pixeln festgelegt.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

Parameter

NameTypBeschreibung
startColumnIntegerDie Startposition der Spalte, die geändert werden soll.
numColumnsIntegerDie Anzahl der Spalten, die geändert werden sollen.
widthIntegerDie Breite in Pixeln.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setConditionalFormatRules(rules)

Ersetzt alle derzeit vorhandenen Regeln für die bedingte Formatierung in der Tabelle durch die Eingaberegeln. Regeln werden in der Reihenfolge ihrer Eingabe ausgewertet.

// Remove one of the existing conditional format rules.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
rules.splice(1, 1);  // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

Parameter

NameTypBeschreibung
rulesConditionalFormatRule[]Die neuen Regeln für die bedingte Formatierung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setCurrentCell(cell)

Die angegebene Zelle wird als current cell festgelegt.

Wenn sich die angegebene Zelle in einem bereits ausgewählten Bereich befindet, wird dieser Bereich zum aktiven Bereich und die Zelle zur aktuellen Zelle.

Wenn sich die angegebene Zelle in keinem ausgewählten Bereich befindet, wird die vorhandene Auswahl entfernt und die Zelle wird zur aktuellen Zelle und zum aktiven Bereich.

Hinweis:Die angegebene Range muss aus einer Zelle bestehen, andernfalls wird eine Ausnahme ausgelöst.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

const selection = sheet.getSelection();
// Current cell: B5
const currentCell = selection.getCurrentCell();

Parameter

NameTypBeschreibung
cellRangeDie Zelle, die als aktuelle Zelle festgelegt werden soll.

Rückflug

Range: die neu festgelegte aktuelle Zelle

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setFrozenColumns(columns)

Die angegebene Anzahl von Spalten wird fixiert. Wenn der Wert „0“ ist, werden keine Spalten eingefroren.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Parameter

NameTypBeschreibung
columnsIntegerDie Anzahl der Spalten, die fixiert werden sollen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setFrozenRows(rows)

Die angegebene Anzahl von Zeilen wird fixiert. Wenn der Wert „0“ ist, werden keine Zeilen eingefroren.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Parameter

NameTypBeschreibung
rowsIntegerDie Anzahl der Zeilen, die fixiert werden sollen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setHiddenGridlines(hideGridlines)

Blendet die Gitternetzlinien des Tabellenblatts ein oder aus.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

Parameter

NameTypBeschreibung
hideGridlinesBooleanWenn true festgelegt ist, werden die Gitternetzlinien in diesem Tabellenblatt ausgeblendet. Andernfalls werden sie angezeigt.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setName(name)

Legt den Tabellennamen fest.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setName('not first anymore');

Parameter

NameTypBeschreibung
nameStringDer neue Name für das Tabellenblatt.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRightToLeft(rightToLeft)

Hiermit wird das Layout des Arbeitsblatts auf „Linksläufig“ festgelegt oder aufgehoben.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

Parameter

NameTypBeschreibung
rightToLeftBooleanBei true ist das Tabellenlayout auf „Von rechts nach links“ gesetzt und Zelle A1 befindet sich oben rechts. Bei false ist das Tabellenlayout auf die Standardeinstellung „Von links nach rechts“ mit Zelle A1 links oben festgelegt.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRowGroupControlPosition(position)

Hiermit wird die Position des Ein/Aus-Schalters für die Zeilengruppensteuerung auf dem Tabellenblatt festgelegt.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Parameter

NameTypBeschreibung
positionGroupControlTogglePositionDie Position des Ein-/Aus-Schalters für die Zeilengruppensteuerung.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRowHeight(rowPosition, height)

Legt die Zeilenhöhe der angegebenen Zeile in Pixeln fest. Standardmäßig werden Zeilen so lange erweitert, bis sie den Zelleninhalt umfassen. Wenn Sie Zeilen auf eine bestimmte Höhe festlegen möchten, verwenden Sie setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Parameter

NameTypBeschreibung
rowPositionIntegerDie zu ändernde Zeilenposition.
heightIntegerDie Höhe in Pixeln.

Rückflug

Sheet: Das Tabellenblatt, nützlich für die Methodenverkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRowHeights(startRow, numRows, height)

Legt die Höhe der angegebenen Zeilen in Pixeln fest. Standardmäßig werden Zeilen so lange erweitert, bis sie den Zelleninhalt umfassen. Wenn Sie Zeilen auf eine bestimmte Höhe festlegen möchten, verwenden Sie setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

Parameter

NameTypBeschreibung
startRowIntegerDie Position der Startzeile, die geändert werden soll.
numRowsIntegerDie Anzahl der Zeilen, die geändert werden sollen.
heightIntegerDie Höhe in Pixeln.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setRowHeightsForced(startRow, numRows, height)

Legt die Höhe der angegebenen Zeilen in Pixeln fest. Standardmäßig werden Zeilen so lange erweitert, bis sie den Zelleninhalt umfassen. Wenn Sie setRowHeightsForced verwenden, werden Zeilen auf die angegebene Höhe festgelegt, auch wenn der Zelleninhalt höher ist als die Zeilenhöhe.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

Parameter

NameTypBeschreibung
startRowIntegerDie Position der Startzeile, die geändert werden soll.
numRowsIntegerDie Anzahl der Zeilen, die geändert werden sollen.
heightIntegerDie Höhe in Pixeln.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setTabColor(color)

Legt die Farbe des Tabellenblatts fest.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setTabColor('ff0000');  // Set the color to red.
first.setTabColor(null);      // Unset the color.

Parameter

NameTypBeschreibung
colorStringEinen Farbcode in CSS-Notation (z. B. '#ffffff' oder 'white') oder null, um die Tabfarbe zurückzusetzen.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

setTabColorObject(color)

Legt die Farbe des Tabellenblatts fest.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                  .build();
first.setTabColorObject(color);  // Set the color to theme accent 1.
first.setTabColorObject(null);   // Unset the color.

Parameter

NameTypBeschreibung
colorColorDie Farbe des Tabellenblatts.

Rückflug

Sheet – dieses Tabellenblatt, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

showColumns(columnIndex)

Die Spalte am angegebenen Index wird eingeblendet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index der Spalte, die eingeblendet werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

showColumns(columnIndex, numColumns)

Blendet eine oder mehrere aufeinanderfolgende Spalten ab dem angegebenen Index ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

Parameter

NameTypBeschreibung
columnIndexIntegerDer Startindex der Spalten, die eingeblendet werden sollen.
numColumnsIntegerDie Anzahl der Spalten, die sichtbar gemacht werden sollen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

showRows(rowIndex)

Die Zeile am angegebenen Index wird sichtbar gemacht.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Index der Zeile, die eingeblendet werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

showRows(rowIndex, numRows)

Eine oder mehrere aufeinanderfolgende Zeilen ab dem angegebenen Index werden sichtbar gemacht.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Startindex der Zeilen, die sichtbar gemacht werden sollen.
numRowsIntegerDie Anzahl der Zeilen, die sichtbar gemacht werden sollen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

showSheet()

Macht das Tabellenblatt sichtbar. Hat keine Auswirkungen, wenn das Tabellenblatt bereits sichtbar ist.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

Rückflug

Sheet: Das aktuelle Tabellenblatt.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

sort(columnPosition)

Sortiert ein Tabellenblatt nach Spalte in aufsteigender Reihenfolge.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Spalte, nach der sortiert werden soll.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

sort(columnPosition, ascending)

Sortiert ein Tabellenblatt nach Spalte. Erforderlich ist ein Parameter, um „aufsteigend“ oder „absteigend“ anzugeben.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Parameter

NameTypBeschreibung
columnPositionIntegerDie Spalte, nach der sortiert werden soll.
ascendingBooleantrue für aufsteigend, false für absteigend.

Rückflug

Sheet – das Tabellenblatt, nützlich für die Methodenverkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

unhideColumn(column)

Die Spalte im angegebenen Bereich wird eingeblendet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

Parameter

NameTypBeschreibung
columnRangeDer Bereich, der wieder eingeblendet werden soll, falls ausgeblendet.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

unhideRow(row)

Blendet die Zeile im angegebenen Bereich ein.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

Parameter

NameTypBeschreibung
rowRangeDer Bereich, der wieder eingeblendet werden soll, falls ausgeblendet.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

updateChart(chart)

Aktualisiert das Diagramm auf diesem Tabellenblatt.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This code is going to loop through all the charts and change them to
// column charts
const charts = sheet.getCharts();
for (const i in charts) {
  const chart = charts[i];
  const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build();
  sheet.updateChart(newChart);
}

Parameter

NameTypBeschreibung
chartEmbeddedChartDas zu aktualisierende Diagramm.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Eingestellte Methoden