Class Sheet

Tabelle

Tabellentabellen aufrufen und bearbeiten Häufige Vorgänge sind das Umbenennen eines Tabellenblatts und der Zugriff auf Bereichsobjekte über das Tabellenblatt.

Methoden

MethodeRückgabetypKurzbeschreibung
activate()SheetAktiviert dieses Tabellenblatt.
addDeveloperMetadata(key)SheetFügt dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.
addDeveloperMetadata(key, visibility)SheetFügt dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel und der Sichtbarkeit hinzu.
addDeveloperMetadata(key, value)SheetFügt dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.
addDeveloperMetadata(key, value, visibility)SheetFügt dem Tabellenblatt Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der Sichtbarkeit hinzu.
appendRow(rowContents)SheetHängt eine Zeile am unteren Rand des aktuellen Datenbereichs im Tabellenblatt an.
asDataSourceSheet()DataSourceSheetGibt das Tabellenblatt als DataSourceSheet zurück, wenn es vom Typ SheetType.DATASOURCE ist. Andernfalls wird null verwendet.
autoResizeColumn(columnPosition)SheetLegt die Breite der jeweiligen Spalte für ihren Inhalt fest.
autoResizeColumns(startColumn, numColumns)SheetLegt die Breite aller Spalten ab der angegebenen Spaltenposition fest, um ihren Inhalt anzupassen.
autoResizeRows(startRow, numRows)SheetLegt die Höhe aller Zeilen ab der angegebenen Zeilenposition fest, um den Inhalt anzupassen.
clear()SheetLöscht das Inhaltsverzeichnis und die Formatierungsinformationen.
clear(options)SheetLöscht das Inhaltsverzeichnis und/oder das Format, wie mit den angegebenen erweiterten Optionen angegeben.
clearConditionalFormatRules()voidEntfernt alle Regeln für die bedingte Formatierung aus dem Tabellenblatt.
clearContents()SheetLöscht das Inhaltsverzeichnis und behält die Formatierungsinformationen bei.
clearFormats()SheetLöscht das Formatierungsblatt, behält aber den Inhalt bei.
clearNotes()SheetLöscht das Tabellenblatt aller Notizen.
collapseAllColumnGroups()SheetAlle Spaltengruppen im Tabellenblatt minimieren.
collapseAllRowGroups()SheetMinimiert alle Zeilengruppen im Tabellenblatt.
copyTo(spreadsheet)SheetDie Tabelle wird in eine bestimmte Tabelle kopiert. Diese kann dieselbe Tabelle wie die Quelle enthalten.
createDeveloperMetadataFinder()DeveloperMetadataFinderGibt ein DeveloperMetadataFinder zurück, mit dem Entwicklermetadaten im Rahmen dieses Tabellenblatts ermittelt werden können.
createTextFinder(findText)TextFinderErstellt eine Textsuche für das Tabellenblatt, die Text im Tabellenblatt finden und ersetzen kann.
deleteColumn(columnPosition)SheetLöscht die Spalte an der angegebenen Spaltenposition.
deleteColumns(columnPosition, howMany)voidLöscht eine Reihe von Spalten ab der angegebenen Spaltenposition.
deleteRow(rowPosition)SheetLöscht die Zeile an der angegebenen Zeilenposition.
deleteRows(rowPosition, howMany)voidLöscht eine Reihe von Zeilen ab der angegebenen Zeilenposition.
expandAllColumnGroups()SheetMaximiert alle Spaltengruppen des Tabellenblatts.
expandAllRowGroups()SheetMaximiert alle Zeilengruppen im Tabellenblatt.
expandColumnGroupsUpToDepth(groupDepth)SheetMaximiert alle Spaltengruppen auf die angegebene Tiefe und minimiert alle anderen Gruppen.
expandRowGroupsUpToDepth(groupDepth)SheetMaximiert alle Zeilengruppen bis zur angegebenen Tiefe und minimiert alle anderen Gruppen.
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 Bereich aktiv 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 Streifen in diesem Tabellenblatt zurück.
getCharts()EmbeddedChart[]Gibt ein Array von Diagrammen auf diesem Tabellenblatt zurück
getColumnGroup(columnIndex, groupDepth)GroupGibt die Spaltengruppe mit dem angegebenen Index und der angegebenen Gruppentiefe zurück
getColumnGroupControlPosition()GroupControlTogglePositionGibt die GroupControlTogglePosition für alle Spaltengruppen im Tabellenblatt zurück.
getColumnGroupDepth(columnIndex)IntegerGibt die Gruppentiefe der Spalte beim angegebenen Index zurück.
getColumnWidth(columnPosition)IntegerRuft die Breite der angegebenen Spalte in Pixeln ab
getConditionalFormatRules()ConditionalFormatRule[]In diesem Tabellenblatt finden Sie alle Regeln für die bedingte Formatierung.
getCurrentCell()RangeGibt die aktuelle Zelle im aktiven Tabellenblatt zurück oder null, wenn keine Zelle vorhanden ist.
getDataRange()RangeGibt ein Range zurück, das den Dimensionen entspricht, in denen Daten vorhanden sind.
getDataSourceFormulas()DataSourceFormula[]Ruft alle Formeln in Datenquellen ab
getDataSourcePivotTables()DataSourcePivotTable[]Ruft alle Datenquellen-Pivot-Tabellen ab.
getDataSourceTables()DataSourceTable[]Ruft alle Datenquellentabellen ab
getDeveloperMetadata()DeveloperMetadata[]Alle mit diesem Tabellenblatt verknüpften Entwicklermetadaten abrufen.
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()StringGibt die URL für das Formular zurück, das die Antworten an dieses Tabellenblatt sendet, oder null, wenn diesem Tabellenblatt kein Formular zugeordnet ist.
getFrozenColumns()IntegerGibt die Anzahl der eingefrorenen Spalten zurück.
getFrozenRows()IntegerGibt die Anzahl der eingefrorenen Zeilen zurück.
getImages()OverGridImage[]Gibt alle Rasterbilder auf dem Tabellenblatt zurück
getIndex()IntegerRuft die Position des Tabellenblatts in der übergeordneten Tabelle ab
getLastColumn()IntegerGibt die Position der letzten Spalte mit Inhalten zurück.
getLastRow()IntegerGibt die Position der letzten Zeile mit Inhalten 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[]Ruft alle benannten Bereiche in diesem Tabellenblatt ab
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[]Ruft ein Array von Objekten ab, die alle geschützten Bereiche im Tabellenblatt repräsentieren, oder ein Array mit einem einzigen Element, das die Schutzmaßnahme für das Tabellenblatt selbst darstellt.
getRange(row, column)RangeGibt den Bereich mit der oberen linken Zelle bei den gegebenen Koordinaten zurück
getRange(row, column, numRows)RangeGibt den Bereich mit der linken oberen Zelle mit den angegebenen Koordinaten und mit der angegebenen Anzahl von Zeilen zurück
getRange(row, column, numRows, numColumns)RangeGibt den Bereich mit den oberen linken Zellen der angegebenen Koordinaten mit der angegebenen Anzahl von Zeilen und Spalten zurück.
getRange(a1Notation)RangeGibt den Bereich in der A1- oder R1C1-Notation zurück.
getRangeList(a1Notations)RangeListGibt die Sammlung RangeList zurück, die die Bereiche im selben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Notationen angegeben sind.
getRowGroup(rowIndex, groupDepth)GroupGibt die Zeilengruppe mit dem angegebenen Index und der angegebenen Gruppentiefe zurück
getRowGroupControlPosition()GroupControlTogglePositionGibt die GroupControlTogglePosition für alle Zeilengruppen im Tabellenblatt zurück.
getRowGroupDepth(rowIndex)IntegerGibt die Gruppentiefe der Zeile im angegebenen Index zurück.
getRowHeight(rowPosition)IntegerRuft die Höhe der angegebenen Zeile in Pixeln ab
getSelection()SelectionGibt das aktuelle Selection in der Tabelle zurück
getSheetId()IntegerGibt die ID des durch dieses Objekt dargestellten Tabellenblatts zurück
getSheetName()StringGibt den Namen des Tabellenblatts zurück
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Gibt das rechteckige Raster von Werten für diesen Bereich zurück, beginnend an den angegebenen Koordinaten.
getSlicers()Slicer[]Gibt ein Array von Datenschnitten im Tabellenblatt zurück
getTabColorObject()ColorRuft die Farbe des Tabellenblatt-Tabs ab oder null, wenn der Tabellenblatt-Tab keine Farbe hat
getType()SheetTypeGibt den Typ des Tabellenblatts zurück.
hasHiddenGridlines()BooleanGibt true zurück, wenn die Gitternetzlinien des Tabellenblatts ausgeblendet sind. Andernfalls wird false zurückgegeben.
hideColumn(column)voidBlendet die Spalte(n) im angegebenen Bereich aus
hideColumns(columnIndex)voidBlendet eine einzelne Spalte im 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)voidBlendet die Zeile im angegebenen Index aus.
hideRows(rowIndex, numRows)voidBlendet eine oder mehrere aufeinanderfolgende Zeilen ab dem angegebenen Index aus.
hideSheet()SheetDieses Tabellenblatt wird ausgeblendet.
insertChart(chart)voidDadurch wird diesem Tabellenblatt ein neues Diagramm hinzugefügt.
insertColumnAfter(afterPosition)SheetFügt eine Spalte nach der angegebenen Spaltenposition ein.
insertColumnBefore(beforePosition)SheetFügt eine Spalte vor der angegebenen Spaltenposition ein.
insertColumns(columnIndex)voidFügt an dem angegebenen Ort eine leere Spalte in ein Tabellenblatt ein.
insertColumns(columnIndex, numColumns)voidFügt eine oder mehrere aufeinanderfolgende leere Spalten in ein Tabellenblatt ein, das an der angegebenen Stelle beginnt.
insertColumnsAfter(afterPosition, howMany)SheetFügt eine Reihe von Spalten nach der angegebenen Spaltenposition ein.
insertColumnsBefore(beforePosition, howMany)SheetFügt eine Reihe von Spalten vor der angegebenen Spaltenposition ein.
insertImage(blobSource, column, row)OverGridImageFügt ein BlobSource-Element als Bild in das Dokument in einer bestimmten Zeile und Spalte ein.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageFügt ein BlobSource-Bild als Bild in das Dokument in einer bestimmten Zeile und Spalte ein, mit Pixel-Offset.
insertImage(url, column, row)OverGridImageFügt in einer bestimmten Zeile und Spalte ein Bild in das Dokument ein.
insertImage(url, column, row, offsetX, offsetY)OverGridImageFügt in einer bestimmten Zeile und Spalte ein Bild mit einem Pixelversatz in das Dokument 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 in dem Tabellenblatt an der angegebenen Stelle eine leere Zeile ein.
insertRows(rowIndex, numRows)voidFügt eine oder mehrere aufeinanderfolgende leere Zeilen in ein Tabellenblatt ein, das an der angegebenen Stelle beginnt.
insertRowsAfter(afterPosition, howMany)SheetFügt eine Reihe von Zeilen nach der angegebenen Zeilenposition ein.
insertRowsBefore(beforePosition, howMany)SheetFügt eine Anzahl von Zeilen vor der angegebenen Zeilenposition ein.
insertSlicer(range, anchorRowPos, anchorColPos)SlicerFügt diesem Tabellenblatt einen neuen Datenschnitt hinzu.
insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)SlicerFügt diesem Tabellenblatt einen neuen Datenschnitt hinzu.
isColumnHiddenByUser(columnPosition)BooleanGibt an, ob die jeweilige Spalte vom Nutzer ausgeblendet wurde.
isRightToLeft()BooleanGibt true zurück, wenn das Tabellenblattlayout von rechts nach links festgelegt wird.
isRowHiddenByFilter(rowPosition)BooleanGibt an, ob die jeweilige Zeile durch einen Filter (nicht eine Filteransicht) ausgeblendet wird.
isRowHiddenByUser(rowPosition)BooleanGibt an, ob die jeweilige Zeile für den Nutzer ausgeblendet ist.
isSheetHidden()BooleanGibt true zurück, wenn das Tabellenblatt derzeit ausgeblendet ist.
moveColumns(columnSpec, destinationIndex)voidVerschiebt die vom angegebenen Bereich ausgewählten Spalten an die durch destinationIndex angegebene Position.
moveRows(rowSpec, destinationIndex)voidVerschiebt die durch den angegebenen Bereich ausgewählten Zeilen an die durch destinationIndex angegebene Position.
newChart()EmbeddedChartBuilderGibt einen Builder zurück, um ein neues Diagramm für dieses Tabellenblatt zu erstellen.
protect()ProtectionErstellt ein Objekt, das verhindern kann, dass das Tabellenblatt bearbeitet wird, außer von Nutzern mit entsprechender Berechtigung.
removeChart(chart)voidEntfernt ein Diagramm aus dem übergeordneten Tabellenblatt.
setActiveRange(range)RangeLegt den angegebenen Bereich als active range im aktiven Tabellenblatt fest, wobei die linke obere Zelle im Bereich den Wert current cell hat.
setActiveRangeList(rangeList)RangeListLegt die angegebene Liste von Bereichen als active ranges im aktiven Tabellenblatt fest.
setActiveSelection(range)RangeLegt den aktiven Auswahlbereich für das Tabellenblatt fest.
setActiveSelection(a1Notation)RangeLegt die aktive Auswahl fest, wie in der A1- oder R1C1-Notation angegeben.
setColumnGroupControlPosition(position)SheetLegt die Ein-/Aus-Schaltfläche für die Spaltengruppensteuerung im Tabellenblatt fest.
setColumnWidth(columnPosition, width)SheetLegt die Breite der angegebenen Spalte in Pixeln fest.
setColumnWidths(startColumn, numColumns, width)SheetLegt die Breite der angegebenen Spalten in Pixeln fest.
setConditionalFormatRules(rules)voidErsetzt alle vorhandenen Regeln für bedingte Formate im Tabellenblatt durch die Eingaberegeln.
setCurrentCell(cell)RangeLegt die angegebene Zelle als current cell fest.
setFrozenColumns(columns)voidEinfriert die angegebene Anzahl von Spalten.
setFrozenRows(rows)voidEinfriert die angegebene Anzahl von Zeilen ein.
setHiddenGridlines(hideGridlines)SheetBlendet die Gitternetzlinien des Tabellenblatts ein oder aus.
setName(name)SheetLegt den Namen des Tabellenblatts fest.
setRightToLeft(rightToLeft)SheetLegt das Layout des Tabellenblatts auf Linksläufig fest oder deaktiviert sie.
setRowGroupControlPosition(position)SheetLegt die Position der Ein-/Aus-Schaltfläche der Zeilengruppe im Tabellenblatt fest.
setRowHeight(rowPosition, height)SheetLegt die Zeilenhöhe der jeweiligen 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 Tab-Farbe des Tabellenblatts fest.
setTabColorObject(color)SheetLegt die Tab-Farbe des Tabellenblatts fest.
showColumns(columnIndex)voidBlendet die Spalte im angegebenen Index wieder ein.
showColumns(columnIndex, numColumns)voidBlendet eine oder mehrere aufeinanderfolgende Spalten ab dem angegebenen Index ein.
showRows(rowIndex)voidBlendet die Zeile im angegebenen Index wieder ein.
showRows(rowIndex, numRows)voidBlendet eine oder mehrere aufeinanderfolgende Zeilen ab dem angegebenen Index ein.
showSheet()SheetDas Tabellenblatt wird sichtbar.
sort(columnPosition)SheetSortieren Sie ein Tabellenblatt aufsteigend.
sort(columnPosition, ascending)SheetSortiert eine Tabelle nach Spalte.
unhideColumn(column)voidBlendet die Spalte im angegebenen Bereich wieder ein.
unhideRow(row)voidBlendet die Zeile im angegebenen Bereich wieder ein.
updateChart(chart)voidAktualisiert das Diagramm in diesem Tabellenblatt.

Detaillierte Dokumentation

activate()

Aktiviert dieses Tabellenblatt. Ändert das Tabellenblatt selbst nicht, nur das übergeordnete Konzept des aktiven Tabellenblatts.

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

Rückflug

Sheet: Das neu aktive Tabellenblatt.


addDeveloperMetadata(key)

Fügt dem Tabellenblatt 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addDeveloperMetadata(key, visibility)

Fügt 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addDeveloperMetadata(key, value)

Fügt 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

addDeveloperMetadata(key, value, visibility)

Fügt 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

appendRow(rowContents)

Hängt eine Zeile am unteren Rand des aktuellen Datenbereichs im Tabellenblatt an.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 von Werten, die nach der letzten Zeile im Tabellenblatt eingefügt werden sollen.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 wird null verwendet.

// 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: Das Tabellenblatt der Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

autoResizeColumn(columnPosition)

Legt die Breite der jeweiligen Spalte für ihren Inhalt fest.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 angegebenen Spalte, deren Größe geändert werden soll.

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

autoResizeColumns(startColumn, numColumns)

Legt die Breite aller Spalten ab der angegebenen Spaltenposition fest, um ihren Inhalt anzupassen.

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

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

Parameter

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

autoResizeRows(startRow, numRows)

Legt die Höhe aller Zeilen ab der angegebenen Zeilenposition fest, um den Inhalt anzupassen.

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

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

Parameter

NameTypBeschreibung
startRowIntegerDie erste Zeile für die automatische Größenanpassung.
numRowsIntegerDie Anzahl der Zeilen, deren Größe automatisch angepasst werden soll.

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

clear()

Löscht das Inhaltsverzeichnis und die Formatierungsinformationen.

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

Rückflug

Sheet: Das gelöschte Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

clear(options)

Löscht das Inhaltsverzeichnis und/oder das Format, wie mit den angegebenen erweiterten Optionen angegeben.

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

Parameter

NameTypBeschreibung
optionsObjectEine JavaScript-Karte mit erweiterten Optionen (siehe unten)

Erweiterte Parameter

NameTypBeschreibung
contentsOnlyBooleanGibt an, ob der Inhalt gelöscht werden soll.
formatOnlyBooleanGibt an, ob das Format gelöscht werden soll.

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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.

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

clearContents()

Löscht das Inhaltsverzeichnis und behält die Formatierungsinformationen bei.

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

clearFormats()

Löscht das Formatierungsblatt, behält aber den Inhalt bei.

„Formatierung“ bezieht sich darauf, wie Daten gemäß den Optionen im Menü „Format“ (z. B. fett, kursiv, bedingte Formatierung) formatiert werden, nicht jedoch nach Breite oder Höhe von Zellen.

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

clearNotes()

Löscht das Tabellenblatt aller Notizen.

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

collapseAllColumnGroups()

Alle Spaltengruppen im Tabellenblatt minimieren.

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

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

collapseAllRowGroups()

Minimiert alle Zeilengruppen im Tabellenblatt.

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

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

copyTo(spreadsheet)

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

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

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

Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

createDeveloperMetadataFinder()

Gibt ein DeveloperMetadataFinder zurück, mit dem Entwicklermetadaten im Rahmen dieses Tabellenblatts ermittelt werden können. Metadaten fallen in den Geltungsbereich eines bestimmten Tabellenblatts, wenn es entweder mit dem Tabellenblatt selbst oder mit einer Zeile, Spalte oder einem Bereich in diesem Tabellenblatt verknüpft ist.

// 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: Mit der Metadatensuche für Entwickler können Sie in diesem Tabellenblatt nach Metadaten suchen.


createTextFinder(findText)

Erstellt eine Textsuche für das Tabellenblatt, die Text im Tabellenblatt finden und ersetzen kann.

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

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

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

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

Parameter

NameTypBeschreibung
findTextStringDer Text, nach dem gesucht werden soll.

Rückflug

TextFinder: der TextFinder-Wert für das Tabellenblatt.


deleteColumn(columnPosition)

Löscht die Spalte an der angegebenen Spaltenposition.

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

deleteColumns(columnPosition, howMany)

Löscht eine Reihe von Spalten ab der angegebenen Spaltenposition.

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der ersten zu löschenden Spalte.
howManyIntegerDie Anzahl der zu löschenden Spalten.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

deleteRow(rowPosition)

Löscht die Zeile an der angegebenen Zeilenposition.

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

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

deleteRows(rowPosition, howMany)

Löscht eine Reihe von Zeilen ab der angegebenen Zeilenposition.

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der ersten zu löschenden Zeile.
howManyIntegerDie Anzahl der zu löschenden Zeilen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

expandAllColumnGroups()

Maximiert alle Spaltengruppen des Tabellenblatts. Bei dieser Methode ist mindestens eine Spaltengruppe erforderlich.

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

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

expandAllRowGroups()

Maximiert alle Zeilengruppen im Tabellenblatt. Bei dieser Methode ist mindestens eine Zeilengruppe erforderlich.

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

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

expandColumnGroupsUpToDepth(groupDepth)

Maximiert alle Spaltengruppen auf die angegebene Tiefe und minimiert alle anderen Gruppen.

var 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 Gruppen.

var 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 wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 das die aktuell markierte Zelle zurückgibt.

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

Rückflug

Range: die aktuell aktive Zelle

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 Bereich aktiv 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 im aktiven Tabellenblatt ausgewählt hat. In einer benutzerdefinierten Funktion bezieht er sich jedoch auf die Zelle, die aktiv neu berechnet wird.

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

Rückflug

Range: Der aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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.

Wurde ein einzelner Bereich ausgewählt, entspricht dies einem getActiveRange()-Aufruf.

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

Rückflug

RangeList: die Liste mit aktiven Bereichen

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Weitere Informationen


getBandings()

Gibt alle Streifen 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 Streifen in diesem Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getCharts()

Gibt ein Array von Diagrammen auf diesem Tabellenblatt zurück

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

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

Rückflug

EmbeddedChart[]: ein Array von Diagrammen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getColumnGroup(columnIndex, groupDepth)

Gibt die Spaltengruppe mit dem angegebenen Index und der angegebenen Gruppentiefe zurück

var 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.
var columnGroup = sheet.getColumnGroup(2, 1);

Parameter

NameTypBeschreibung
columnIndexIntegerSpaltenindex der Gruppensteuerung oder ein Index innerhalb der Gruppe.
groupDepthIntegerTiefe der Gruppe.

Rückflug

Group: Die Spaltengruppe im Kontrollindex und in der Tiefe. Außerdem wird eine Ausnahme ausgelöst, wenn die Gruppe nicht vorhanden ist.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getColumnGroupControlPosition()

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

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

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getColumnGroupDepth(columnIndex)

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

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

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

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

Parameter

NameTypBeschreibung
columnIndexIntegerIndex der Spalte

Rückflug

Integer: die Gruppentiefe der Spalte beim angegebenen Index.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getColumnWidth(columnPosition)

Ruft die Breite der angegebenen Spalte in Pixeln ab

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getConditionalFormatRules()

In diesem Tabellenblatt finden Sie alle Regeln für die bedingte Formatierung.

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

Rückflug

ConditionalFormatRule[]: ein Array aller Regeln im Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 Zelle vorhanden ist. Die aktuelle Zelle ist die Zelle, die den Fokus in der Google Tabellen-Benutzeroberfläche hat und durch einen dunklen Rahmen hervorgehoben wird. Es ist nie mehr als eine aktuelle Zelle vorhanden. Wenn ein Nutzer einen oder mehrere Zellenbereiche auswählt, ist eine der Zellen in der Auswahl die aktuelle Zelle.

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

Rückflug

Range: die aktuelle Zelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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.

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

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

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

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var 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 mit allen Daten in der Tabelle

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSourceFormulas()

Ruft alle Formeln in Datenquellen ab

Rückflug

DataSourceFormula[]: Eine Liste mit Formeln für Datenquellen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSourcePivotTables()

Ruft alle Datenquellen-Pivot-Tabellen ab.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDataSourceTables()

Ruft alle Datenquellentabellen ab

Rückflug

DataSourceTable[]: Eine Liste der Datenquellentabellen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getDeveloperMetadata()

Alle mit diesem Tabellenblatt verknüpften Entwicklermetadaten abrufen.

// 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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[]: Die Liste der Zeichnungen in diesem Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();

Rückflug

Filter: Der Filter.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getFormUrl()

Gibt die URL für das Formular zurück, das die Antworten an dieses Tabellenblatt sendet, oder null, wenn diesem Tabellenblatt kein Formular zugeordnet ist.

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

Rückflug

String: Die URL für das Formular, in dem die Antworten in diese Tabelle eingetragen werden, oder null, wenn dieser Tabelle kein Formular zugeordnet ist.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getFrozenColumns()

Gibt die Anzahl der eingefrorenen Spalten zurück.

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

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

Rückflug

Integer: die Anzahl der eingefrorenen Spalten

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getFrozenRows()

Gibt die Anzahl der eingefrorenen Zeilen zurück.

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

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

Rückflug

Integer: die Anzahl der eingefrorenen Zeilen

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getImages()

Gibt alle Rasterbilder auf dem Tabellenblatt zurück

Rückflug

OverGridImage[]: ein Array von Bildern ohne Raster

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 bei 1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getLastColumn()

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

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

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

Rückflug

Integer: Die letzte Spalte des Tabellenblatts, das Inhalte enthält.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getLastRow()

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

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

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

Rückflug

Integer: Die letzte Zeile des Tabellenblatts, das Inhalte enthält.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxColumns());

Rückflug

Integer: die maximale Breite des Tabellenblatts.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("first");
Logger.log(first.getMaxRows());

Rückflug

Integer: Die maximale Höhe des Tabellenblatts.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getName()

Gibt den Namen des Tabellenblatts zurück

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

Rückflug

String: Der Name des Tabellenblatts.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getNamedRanges()

Ruft alle benannten Bereiche in diesem Tabellenblatt ab

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getParent()

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

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

Rückflug

Spreadsheet: Die übergeordnete Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 in diesem Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getProtections(type)

Ruft ein Array von Objekten ab, die alle geschützten Bereiche im Tabellenblatt repräsentieren, oder ein Array mit einem einzigen Element, das die Schutzmaßnahme für das Tabellenblatt selbst darstellt.

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

Parameter

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

Rückflug

Protection[] (Array): ein Array von Objekten, die alle geschützten Bereiche im Tabellenblatt repräsentieren, oder ein Array mit einem einzigen Element, das den Schutz des Tabellenblatts selbst darstellt

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRange(row, column)

Gibt den Bereich mit der oberen linken Zelle bei den gegebenen Koordinaten zurück

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
var range = sheet.getRange(1, 1);
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 mit den angegebenen Koordinaten und mit der angegebenen Anzahl von Zeilen zurück

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

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

Parameter

NameTypBeschreibung
rowIntegerDer Anfangszeilenindex 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 und der Anzahl der angegebenen Zeilen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRange(row, column, numRows, numColumns)

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

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

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

Parameter

NameTypBeschreibung
rowIntegerDer Anfangszeilenindex des Bereichs. Die Zeilenindexierung beginnt mit 1.
columnIntegerDer Anfangsspaltenindex des Bereichs. 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 Bereich entspricht.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRange(a1Notation)

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

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

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

Parameter

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

Rückflug

Range: Der Bereich am angegebenen Standort.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRangeList(a1Notations)

Gibt die Sammlung RangeList zurück, die die Bereiche im selben Tabellenblatt darstellt, die durch eine nicht leere Liste von A1- oder R1C1-Notationen angegeben sind.

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

Parameter

NameTypBeschreibung
a1NotationsString[]Die Liste der zurückzugebenden Bereiche gemäß der A1- oder R1C1-Notation.

Rückflug

RangeList: die Bereichsliste am angegebenen Standort

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRowGroup(rowIndex, groupDepth)

Gibt die Zeilengruppe mit dem angegebenen Index und der angegebenen Gruppentiefe zurück

var 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.
var rowGroup = sheet.getRowGroup(2, 1);

Parameter

NameTypBeschreibung
rowIndexIntegerDer Zeilenindex der Gruppensteuerung oder ein Index innerhalb der Gruppe.
groupDepthIntegerTiefe der Gruppe.

Rückflug

Group: Die Zeilengruppe im Kontrollindex und in der Tiefe. Eine Ausnahme wird ausgelöst, wenn die Gruppe nicht vorhanden ist.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRowGroupControlPosition()

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

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

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

Rückflug

GroupControlTogglePosition: true, wenn die Ein-/Aus-Schaltfläche für die Zeilengruppierung nach der Gruppe in dieser Tabelle angezeigt wird, andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRowGroupDepth(rowIndex)

Gibt die Gruppentiefe der Zeile im angegebenen Index zurück.

Die Gruppentiefe gibt an, wie viele Gruppen sich mit der Zeile überschneiden. Werte reichen von null bis acht.

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

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

Parameter

NameTypBeschreibung
rowIndexIntegerIndex der Zeile

Rückflug

Integer: die Gruppentiefe der Zeile im angegebenen Index.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getRowHeight(rowPosition)

Ruft die Höhe der angegebenen Zeile in Pixeln ab

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu überprüfenden Zeile.

Rückflug

Integer: Zeilenhöhe in Pixeln

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSelection()

Gibt das aktuelle Selection in der Tabelle zurück

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

Rückflug

Selection: die aktuelle Auswahl

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSheetId()

Gibt die ID des durch dieses Objekt dargestellten Tabellenblatts zurück

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

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

Logger.log(sheet.getSheetId());

Rückflug

Integer: eine ID für das Tabellenblatt, das für die Tabelle eindeutig ist.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSheetName()

Gibt den Namen des Tabellenblatts zurück

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

Logger.log(sheet.getSheetName());

Rückflug

String: der Name des Tabellenblatts

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Gibt das rechteckige Raster von Werten für diesen Bereich zurück, beginnend an den angegebenen Koordinaten. Ein Wert von -1, der als Zeilen- oder Spaltenposition angegeben wird, entspricht dem Abrufen der letzten Zeile oder Spalte, die Daten in dem Tabellenblatt enthält.

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

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

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

Parameter

NameTypBeschreibung
startRowIntegerDie Position der Startzeile.
startColumnIntegerDie Position der Ausgangsspalte.
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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getSlicers()

Gibt ein Array von Datenschnitten im 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[]: Die Liste der Datenschnitte in diesem Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getTabColorObject()

Ruft die Farbe des Tabellenblatt-Tabs ab oder null, wenn der Tabellenblatt-Tab keine Farbe hat

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

getType()

Gibt den Typ des Tabellenblatts zurück.

Der Standardtyp des Tabellenblatts ist SheetType.GRID. Ein Tabellenblatt, das ein einzelnes eingebettetes Objekt wie EmbeddedChart enthält, ist ein Tabellenblatt von SheetType.OBJECT.

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

Rückflug

SheetType: Der Typ des Tabellenblatts.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hasHiddenGridlines()

Gibt true zurück, wenn die Gitternetzlinien des Tabellenblatts ausgeblendet sind. Andernfalls wird false zurückgegeben. Gitternetzlinien 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 Gitterlinien ausgeblendet sind. Andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hideColumn(column)

Blendet die Spalte(n) im angegebenen Bereich aus

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

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

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

Parameter

NameTypBeschreibung
columnRangeDer Spaltenbereich, der ausgeblendet werden soll.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hideColumns(columnIndex)

Blendet eine einzelne Spalte im angegebenen Index aus. Für diese Methode muss ein 1-Index verwendet werden.

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

Mit hideColumn() können Sie mehrere Spalten mithilfe eines Bereichs ausblenden.

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

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index der Spalte, die ausgeblendet werden soll.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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. Für diese Methode muss ein 1-Index verwendet werden.

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

Parameter

NameTypBeschreibung
columnIndexIntegerDer Anfangsindex der Spalten, die ausgeblendet werden sollen.
numColumnsIntegerDie Anzahl der Spalten, die ausgeblendet werden sollen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hideRow(row)

Blendet die Zeilen im angegebenen Bereich aus.

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

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

Parameter

NameTypBeschreibung
rowRangeDer zu ausblendende Zeilenbereich.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hideRows(rowIndex)

Blendet die Zeile im angegebenen Index aus.

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

Parameter

NameTypBeschreibung
rowIndexIntegerDer Index der Zeile, die ausgeblendet werden soll

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hideRows(rowIndex, numRows)

Blendet eine oder mehrere aufeinanderfolgende Zeilen ab dem angegebenen Index aus.

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

Parameter

NameTypBeschreibung
rowIndexIntegerDer Ausgangsindex der Zeilen, die ausgeblendet werden sollen.
numRowsIntegerDie Anzahl der Zeilen, die ausgeblendet werden sollen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

hideSheet()

Dieses Tabellenblatt wird ausgeblendet. Wenn das Tabellenblatt bereits ausgeblendet ist, hat dies keine Auswirkungen. Wenn diese Methode für das einzige sichtbare Tabellenblatt aufgerufen wird, wird eine Ausnahme ausgelöst.

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

Rückflug

Sheet: Das aktuelle Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertChart(chart)

Dadurch wird diesem Tabellenblatt ein neues Diagramm hinzugefügt.

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

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumnAfter(afterPosition)

Fügt eine Spalte nach der angegebenen Spaltenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumnBefore(beforePosition)

Fügt eine Spalte vor der angegebenen Spaltenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 hinzugefügt werden soll.

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumns(columnIndex)

Fügt an dem angegebenen Ort eine leere Spalte in ein Tabellenblatt ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumns(columnIndex, numColumns)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumnsAfter(afterPosition, howMany)

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

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

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

Parameter

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

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertColumnsBefore(beforePosition, howMany)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 hinzugefügt werden soll.
howManyIntegerDie Anzahl der einzufügenden Spalten.

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertImage(blobSource, column, row)

Fügt ein BlobSource-Element als Bild in das Dokument in einer bestimmten Zeile und Spalte ein. Die Bildgröße wird aus den Blob-Inhalten abgerufen. Die maximal zulässige Blob-Größe beträgt 2 MB.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Parameter

NameTypBeschreibung
blobSourceBlobSourceDas Blob mit dem Bildinhalt, dem MIME-Typ und optional dem Namen.
columnIntegerSpaltenposition
rowIntegerDie Zeilenposition.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

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

Fügt ein BlobSource-Bild als Bild in das Dokument in einer bestimmten Zeile und Spalte ein, mit Pixel-Offset. Die Bildgröße wird aus den Blob-Inhalten abgerufen. Die maximal unterstützte Blob-Größe beträgt 2 MB.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Parameter

NameTypBeschreibung
blobSourceBlobSourceDas Blob mit dem Bildinhalt, dem MIME-Typ und optional dem Namen.
columnIntegerSpaltenposition
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Abstand zur Zellenecke in Pixeln.
offsetYIntegerDer vertikale Abstand zur Zellenecke in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertImage(url, column, row)

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

Die angegebene URL muss öffentlich zugänglich sein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

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

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

Die angegebene URL muss öffentlich zugänglich sein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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.
columnIntegerSpaltenposition
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Abstand zur Zellenecke in Pixeln.
offsetYIntegerDer vertikale Abstand zur Zellenecke in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRowAfter(afterPosition)

Fügt eine Zeile nach der angegebenen Zeilenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRowBefore(beforePosition)

Fügt eine Zeile vor der angegebenen Zeilenposition ein.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRows(rowIndex)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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, das an der angegebenen Stelle beginnt.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRowsAfter(afterPosition, howMany)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertRowsBefore(beforePosition, howMany)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 hinzugefügt werden sollen.
howManyIntegerDie Anzahl der einzufügenden Zeilen.

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

insertSlicer(range, anchorRowPos, anchorColPos)

Fügt diesem Tabellenblatt einen neuen Datenschnitt 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, für den der Datenschnitt erstellt wird.
anchorRowPosIntegerDie obere Seite des Datenschnitts ist in dieser Zeile verankert.
anchorColPosIntegerDie obere Seite des Datenschnitts ist in dieser Spalte verankert.

Rückflug

Slicer: Der neu eingefügte Datenschnitt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 Datenschnitt 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, für den der Datenschnitt erstellt wird.
anchorRowPosIntegerDie obere Seite des Datenschnitts ist in dieser Zeile verankert.
anchorColPosIntegerDie obere Seite des Datenschnitts ist in dieser Spalte verankert.
offsetXIntegerDer horizontale Abstand zur Zellenecke in Pixeln.
offsetYIntegerDer vertikale Abstand zur Zellenecke in Pixeln.

Rückflug

Slicer: Der neu eingefügte Datenschnitt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isColumnHiddenByUser(columnPosition)

Gibt an, ob die jeweilige Spalte vom Nutzer ausgeblendet wurde.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isRightToLeft()

Gibt true zurück, wenn das Tabellenblattlayout von rechts nach links festgelegt wird. Gibt false zurück, wenn das Tabellenblatt das Standardlayout von links nach rechts verwendet.

// 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, wenn von rechts nach links; andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isRowHiddenByFilter(rowPosition)

Gibt an, ob die jeweilige Zeile durch einen Filter (nicht eine Filteransicht) ausgeblendet wird.

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu überprüfenden Zeile.

Rückflug

Boolean: true, wenn die Zeile ausgeblendet ist. Andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isRowHiddenByUser(rowPosition)

Gibt an, ob die jeweilige Zeile für den Nutzer ausgeblendet ist.

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu überprüfenden Zeile.

Rückflug

Boolean: true, wenn die Zeile ausgeblendet ist. Andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

isSheetHidden()

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

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

Rückflug

Boolean: true, wenn das Tabellenblatt ausgeblendet ist. Andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

moveColumns(columnSpec, destinationIndex)

Verschiebt die vom angegebenen Bereich ausgewählten Spalten an die durch destinationIndex angegebene Position. columnSpec muss nicht genau eine ganze Spalte oder Gruppe von zu verschiebenden Spalten darstellen. Es werden alle Spalten ausgewählt, die sich über den Bereich erstrecken.

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

Parameter

NameTypBeschreibung
columnSpecRangeEinen Bereich für die Spalten, die verschoben werden sollen.
destinationIndexIntegerDer Index, in den die Spalten verschoben werden sollen. Beachten Sie, dass dieser Index auf den Koordinaten basiert, bevor die Spalten verschoben werden. Vorhandene Daten werden nach rechts verschoben, um Platz für die verschobenen Spalten zu machen, während die Quellspalten aus dem Raster entfernt werden. Daher befinden sich die Daten möglicherweise in einem anderen Index als ursprünglich angegeben.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 durch destinationIndex angegebene Position. Der rowSpec selbst muss nicht genau eine ganze Zeile oder Gruppe von zu verschiebenden Zeilen darstellen. Es werden alle Zeilen ausgewählt, die sich über den Bereich erstrecken.

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

Parameter

NameTypBeschreibung
rowSpecRangeEinen Bereich für die Zeilen, die verschoben werden sollen.
destinationIndexIntegerDer Index, in den die Zeilen verschoben werden sollen. Beachten Sie, dass dieser Index auf den Koordinaten basiert, bevor die Zeilen verschoben werden. Vorhandene Daten werden nach unten verschoben, um Platz für die verschobenen Zeilen zu machen, während die Quellzeilen aus dem Raster entfernt werden. Daher befinden sich die Daten möglicherweise in einem anderen Index als ursprünglich angegeben.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

newChart()

Gibt einen Builder zurück, um ein neues Diagramm für dieses Tabellenblatt zu erstellen.

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

var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange("A1:B8");
var 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, das verhindern kann, dass das Tabellenblatt bearbeitet wird, außer von Nutzern mit entsprechender Berechtigung. Bis das Skript die Liste der Bearbeiter des Tabellenblatts tatsächlich ändert (durch Aufrufen von Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) oder durch Festlegen eines neuen Werts für Protection.setDomainEdit(editable)), spiegeln die Berechtigungen die Werte der Tabelle selbst wider. Das Tabellenblatt ist also ungeschützt. Wenn das Tabellenblatt bereits geschützt ist, gibt diese Methode ein Objekt zurück, das die vorhandenen Schutzeinstellungen darstellt. Ein geschütztes Tabellenblatt kann nicht geschützte Regionen enthalten.

// Protect the active sheet, then remove all other users from the list of editors.
var sheet = SpreadsheetApp.getActiveSheet();
var 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.
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

removeChart(chart)

Entfernt ein Diagramm aus dem übergeordneten Tabellenblatt.

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

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

Parameter

NameTypBeschreibung
chartEmbeddedChartDas zu entfernende Diagramm.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setActiveRange(range)

Legt den angegebenen Bereich als active range im aktiven Tabellenblatt fest, wobei die linke obere Zelle im Bereich den Wert current cell hat.

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

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

Parameter

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

Rückflug

Range: Der neu aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 wurde als active range festgelegt.

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

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

Parameter

NameTypBeschreibung
rangeListRangeListDie Liste der auszuwählenden Bereiche.

Rückflug

RangeList: Die neu ausgewählte Liste von Bereichen

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setActiveSelection(range)

Legt den aktiven Auswahlbereich für das Tabellenblatt fest.

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

var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setActiveSelection(a1Notation)

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

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

sheet.setActiveSelection("A1:D4");

Parameter

NameTypBeschreibung
a1NotationStringDer auf „aktiv“ eingestellte Bereich wie in A1- oder R1C1-Notation angegeben.

Rückflug

Range: Der neu aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setColumnGroupControlPosition(position)

Legt die Ein-/Aus-Schaltfläche für die Spaltengruppensteuerung im Tabellenblatt fest.

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

Parameter

NameTypBeschreibung
positionGroupControlTogglePositionDie Position der Ein-/Aus-Schaltfläche der Spaltengruppensteuerung.

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setColumnWidth(columnPosition, width)

Legt die Breite der angegebenen Spalte in Pixeln fest.

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der angegebenen Spalte.
widthIntegerDie Breite in Pixeln, um sie festzulegen

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setColumnWidths(startColumn, numColumns, width)

Legt die Breite der angegebenen Spalten in Pixeln fest.

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

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

Parameter

NameTypBeschreibung
startColumnIntegerDie Position der Ausgangsspalte, die geändert werden soll.
numColumnsIntegerDie Anzahl der zu ändernden Spalten.
widthIntegerDie Breite in Pixeln, um sie festzulegen

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setConditionalFormatRules(rules)

Ersetzt alle vorhandenen Regeln für bedingte Formate im Tabellenblatt durch die Eingaberegeln. Die Regeln werden in ihrer Eingabereihenfolge ausgewertet.

// Remove one of the existing conditional format rules.
var sheet = SpreadsheetApp.getActiveSheet();
var 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

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setCurrentCell(cell)

Legt die angegebene Zelle als current cell fest.

Wenn die angegebene Zelle in einem bereits ausgewählten Bereich vorhanden ist, wird dieser Bereich zum aktiven Bereich, wobei die Zelle als aktuelle Zelle gilt.

Ist die angegebene Zelle in keinem der ausgewählten Bereiche vorhanden, 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, sonst wird eine Ausnahme ausgelöst.

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

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

Parameter

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

Rückflug

Range: die neu festgelegte aktuelle Zelle

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setFrozenColumns(columns)

Einfriert die angegebene Anzahl von Spalten. Bei Null sind keine Spalten eingefroren.

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

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

Parameter

NameTypBeschreibung
columnsIntegerDie Anzahl der Spalten, die fixiert werden sollen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setFrozenRows(rows)

Einfriert die angegebene Anzahl von Zeilen ein. Bei Null werden keine Zeilen eingefroren.

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

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

Parameter

NameTypBeschreibung
rowsIntegerDie Anzahl der zu fixierenden Zeilen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 Gitterlinien in diesem Tabellenblatt ausgeblendet. Andernfalls werden die Gitterlinien angezeigt.

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setName(name)

Legt den Namen des Tabellenblatts fest.

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

Parameter

NameTypBeschreibung
nameStringDer neue Name des Tabellenblatts.

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setRightToLeft(rightToLeft)

Legt das Layout des Tabellenblatts auf Linksläufig fest oder deaktiviert sie.

// 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 wird das Tabellenblatt-Layout auf linksläufig festgelegt, wobei Zelle A1 rechts oben zu sehen ist. Bei false wird das Tabellenblatt-Layout auf die Standardeinstellung von links nach rechts festgelegt, wobei Zelle A1 oben links steht.

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setRowGroupControlPosition(position)

Legt die Position der Ein-/Aus-Schaltfläche der Zeilengruppe im Tabellenblatt fest.

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

Parameter

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

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setRowHeight(rowPosition, height)

Legt die Zeilenhöhe der jeweiligen Zeile in Pixeln fest. Standardmäßig werden Zeilen an den Inhalt der Zelle angepasst. Wenn Sie Zeilen auf eine bestimmte Höhe erzwingen möchten, verwenden Sie setRowHeightsForced(startRow, numRows, height).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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, um sie festzulegen

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 an den Inhalt der Zelle angepasst. Wenn Sie Zeilen auf eine bestimmte Höhe erzwingen möchten, verwenden Sie setRowHeightsForced(startRow, numRows, height).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 zu ändernden Zeilen.
heightIntegerDie Höhe in Pixeln, um sie festzulegen

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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 an den Inhalt der Zelle angepasst. Mit setRowHeightsForced werden Zeilen auf die angegebene Höhe erzwungen, auch wenn der Zelleninhalt höher ist als die Zeilenhöhe.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 zu ändernden Zeilen.
heightIntegerDie Höhe in Pixeln, um sie festzulegen

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setTabColor(color)

Legt die Tab-Farbe des Tabellenblatts fest.

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

Parameter

NameTypBeschreibung
colorStringEin Farbcode in CSS-Notation wie '#ffffff' oder 'white' oder null zum Zurücksetzen der Tabfarbe.

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

setTabColorObject(color)

Legt die Tab-Farbe des Tabellenblatts fest.

// This example assumes there is a sheet named "Sheet1"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var first = ss.getSheetByName("Sheet1");
var 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 Tabellenblatt-Tabs

Rückflug

Sheet: Dieses Tabellenblatt wird zum Verketten verwendet.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

showColumns(columnIndex)

Blendet die Spalte im angegebenen Index wieder ein.

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

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index der Spalte, die eingeblendet werden soll.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

  • 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.

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

Parameter

NameTypBeschreibung
columnIndexIntegerDer Ausgangsindex der Spalten, die eingeblendet werden sollen.
numColumnsIntegerDie Anzahl der Spalten, die eingeblendet werden sollen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

showRows(rowIndex)

Blendet die Zeile im angegebenen Index wieder ein.

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

Parameter

NameTypBeschreibung
rowIndexIntegerDer Index der Zeile, die eingeblendet werden soll

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

showRows(rowIndex, numRows)

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

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

Parameter

NameTypBeschreibung
rowIndexIntegerDer Ausgangsindex der Zeilen, die eingeblendet werden sollen.
numRowsIntegerDie Anzahl der Zeilen, die eingeblendet werden sollen.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

showSheet()

Das Tabellenblatt wird sichtbar. Wenn das Tabellenblatt bereits sichtbar ist, hat dies keine Auswirkungen.

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

Rückflug

Sheet: Das aktuelle Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

sort(columnPosition)

Sortieren Sie ein Tabellenblatt aufsteigend.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

sort(columnPosition, ascending)

Sortiert eine Tabelle nach Spalte. Gibt einen Parameter an, mit dem aufsteigend oder absteigend angegeben wird.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 aufsteigende Sortierungen, false für absteigend.

Rückflug

Sheet: das Tabellenblatt, das für die Methodenverkettung nützlich ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

unhideColumn(column)

Blendet die Spalte im angegebenen Bereich wieder ein.

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

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

Parameter

NameTypBeschreibung
columnRangeBereich, der eingeblendet werden soll, wenn er ausgeblendet ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

unhideRow(row)

Blendet die Zeile im angegebenen Bereich wieder ein.

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

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

Parameter

NameTypBeschreibung
rowRangeBereich, der eingeblendet werden soll, wenn er ausgeblendet ist

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

updateChart(chart)

Aktualisiert das Diagramm in diesem Tabellenblatt.

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

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

Parameter

NameTypBeschreibung
chartEmbeddedChartDas zu aktualisierende Diagramm.

Autorisierung

Skripts, die diese Methode verwenden, müssen mit einem oder mehreren der folgenden Bereiche autorisiert werden:

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

Verworfene Methoden