Class Sheet

Sheets

Auf Tabellenblätter zugreifen und sie bearbeiten Gängige Vorgänge sind das Umbenennen eines Tabellenblatts und den Zugriff auf den Bereich. aus dem Tabellenblatt.

Methoden

MethodeRückgabetypKurzbeschreibung
activate()SheetAktiviert dieses Tabellenblatt.
addDeveloperMetadata(key)SheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.
addDeveloperMetadata(key, visibility)SheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und der Sichtbarkeit hinzu.
addDeveloperMetadata(key, value)SheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel und Wert hinzu.
addDeveloperMetadata(key, value, visibility)SheetFügt der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel, Wert und der Sichtbarkeit hinzu.
appendRow(rowContents)SheetFügt eine Zeile am Ende des aktuellen Datenbereichs im Tabellenblatt an.
asDataSourceSheet()DataSourceSheetGibt das Tabellenblatt als DataSourceSheet zurück, wenn das Tabellenblatt vom Typ SheetType.DATASOURCE ist, andernfalls als null.
autoResizeColumn(columnPosition)SheetLegt die Breite der gegebenen Spalte so fest, dass sie ihrem Inhalt entspricht.
autoResizeColumns(startColumn, numColumns)SheetLegt die Breite aller Spalten beginnend an der angegebenen Spaltenposition so fest, dass sie auf ihren Inhalt passt.
autoResizeRows(startRow, numRows)SheetLegt die Höhe aller Zeilen ab der angegebenen Zeilenposition so fest, dass sie auf ihren Inhalt passen.
clear()SheetLöscht das Tabellenblatt mit den Inhalts- und Formatierungsinformationen.
clear(options)SheetLöscht den Inhalt und/oder das Format des Tabellenblatts entsprechend den angegebenen erweiterten Optionen.
clearConditionalFormatRules()voidDadurch werden alle Regeln für die bedingte Formatierung aus dem Tabellenblatt entfernt.
clearContents()SheetLöscht den Inhalt des Tabellenblatts, behält aber die Formatierungsinformationen bei.
clearFormats()SheetLöscht das Formatierungsblatt, behält aber den Inhalt bei.
clearNotes()SheetLöscht alle Notizen im Tabellenblatt.
collapseAllColumnGroups()SheetMinimiert alle Spaltengruppen im Tabellenblatt.
collapseAllRowGroups()SheetMinimiert alle Zeilengruppen im Tabellenblatt.
copyTo(spreadsheet)SheetKopiert das Tabellenblatt in eine bestimmte Tabellenkalkulation, die der Quelltabelle entsprechen kann.
createDeveloperMetadataFinder()DeveloperMetadataFinderGibt eine DeveloperMetadataFinder zurück, um Entwicklermetadaten im Bereich von auf diesem Blatt.
createTextFinder(findText)TextFinderErstellt einen Textsucher für das Tabellenblatt, mit dem Text im Tabellenblatt gesucht und ersetzt werden kann.
deleteColumn(columnPosition)SheetLöscht die Spalte an der angegebenen Spaltenposition.
deleteColumns(columnPosition, howMany)voidLöscht eine Anzahl von Spalten ab der angegebenen Spaltenposition.
deleteRow(rowPosition)SheetLöscht die Zeile an der angegebenen Zeilenposition.
deleteRows(rowPosition, howMany)voidLöscht eine Anzahl von Zeilen ab der angegebenen Zeilenposition.
expandAllColumnGroups()SheetMaximiert alle Spaltengruppen im Tabellenblatt.
expandAllRowGroups()SheetMaximiert alle Zeilengruppen im Tabellenblatt.
expandColumnGroupsUpToDepth(groupDepth)SheetMaximiert alle Spaltengruppen bis zur angegebenen Tiefe und minimiert alle anderen.
expandRowGroupsUpToDepth(groupDepth)SheetMaximiert alle Zeilengruppen bis zur angegebenen Tiefe und minimiert alle anderen.
getActiveCell()RangeGibt die aktive Zelle in diesem Tabellenblatt zurück.
getActiveRange()RangeGibt den ausgewählten Bereich im aktiven Tabellenblatt oder null zurück, wenn kein Bereich aktiv ist.
getActiveRangeList()RangeListGibt die Liste der aktiven Bereiche im aktiven Tabellenblatt oder null zurück, wenn keine aktiven Bereiche vorhanden sind Bereiche.
getBandings()Banding[]Gibt alle Bandierungen 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 am angegebenen Index zurück.
getColumnWidth(columnPosition)IntegerRuft die Breite der gegebenen 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 oder null zurück, 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 für die Datenquelle ab.
getDataSourcePivotTables()DataSourcePivotTable[]Ruft alle Pivot-Tabellen der Datenquelle ab.
getDataSourceTables()DataSourceTable[]Ruft alle Datenquellentabellen ab.
getDeveloperMetadata()DeveloperMetadata[]Hiermit werden alle Entwicklermetadaten abgerufen, die mit diesem Tabellenblatt verknüpft sind.
getDrawings()Drawing[]Gibt ein Array von Zeichnungen auf dem Tabellenblatt zurück.
getFilter()FilterGibt den Filter in diesem Tabellenblatt oder null zurück, 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 dieses Tabellenblatt hat kein verknüpftes Formular.
getFrozenColumns()IntegerGibt die Anzahl der fixierten Spalten zurück.
getFrozenRows()IntegerGibt die Anzahl der fixierten Zeilen zurück.
getImages()OverGridImage[]Gibt alle über das Raster gelegten Bilder auf dem Tabellenblatt zurück.
getIndex()IntegerRuft die Position des Tabellenblatts in der übergeordneten Tabelle ab.
getLastColumn()IntegerGibt die Position der letzten Spalte mit Inhalt zurück.
getLastRow()IntegerGibt die Position der letzten Zeile mit Inhalt zurück
getMaxColumns()IntegerGibt die aktuelle Anzahl der Spalten im Tabellenblatt zurück, unabhängig vom Inhalt.
getMaxRows()IntegerGibt die aktuelle Anzahl der Zeilen im Tabellenblatt zurück, unabhängig vom Inhalt.
getName()StringGibt den Namen des Tabellenblatts zurück
getNamedRanges()NamedRange[]Ruft alle benannten Bereiche aus diesem Tabellenblatt ab.
getParent()SpreadsheetGibt die Spreadsheet zurück, die dieses Tabellenblatt enthält
getPivotTables()PivotTable[]Gibt alle Pivot-Tabellen auf diesem Tabellenblatt zurück.
getProtections(type)Protection[]Ruft ein Array von Objekten ab, die alle geschützten Bereiche im Tabellenblatt oder ein einzelnes Element darstellen Array, das den Schutz auf dem Tabellenblatt selbst darstellt.
getRange(row, column)RangeGibt den Bereich mit der oberen linken Zelle an den angegebenen Koordinaten zurück.
getRange(row, column, numRows)RangeGibt den Bereich zurück, bei dem sich die obere linke Zelle an den angegebenen Koordinaten befindet. Zeilen.
getRange(row, column, numRows, numColumns)RangeGibt den Bereich mit der oberen linken Zelle an den angegebenen Koordinaten mit der angegebenen Anzahl von Zeilen zurück und Spalten.
getRange(a1Notation)RangeGibt den Bereich entsprechend der A1-Schreibweise oder R1C1-Schreibweise zurück.
getRangeList(a1Notations)RangeListGibt die Sammlung RangeList zurück, die die Bereiche im angegebenen Tabellenblatt darstellt nicht leere Liste von A1- oder R1C1-Notationen.
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 am angegebenen Index zurück.
getRowHeight(rowPosition)IntegerRuft die Höhe der angegebenen Zeile in Pixeln ab.
getSelection()SelectionGibt den aktuellen Wert für Selection in der Tabelle zurück.
getSheetId()IntegerGibt die ID des Tabellenblatts zurück, das durch dieses Objekt dargestellt wird.
getSheetName()StringGibt den Namen des Tabellenblatts zurück.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]Gibt das rechteckige Werteraster für diesen Bereich zurück, beginnend bei den angegebenen Koordinaten.
getSlicers()Slicer[]Gibt ein Array von Datenschnitten auf dem Tabellenblatt zurück.
getTabColorObject()ColorRuft die Tab-Farbe des Tabellenblatts ab oder null, wenn der Tab des Tabellenblatts 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 am angegebenen Index aus.
hideColumns(columnIndex, numColumns)voidBlendet eine oder mehrere aufeinanderfolgende Spalten ab dem angegebenen Index aus.
hideRow(row)voidBlendet die Zeilen im angegebenen Bereich aus.
hideRows(rowIndex)voidBlendet die Zeile am angegebenen Index aus.
hideRows(rowIndex, numRows)voidBlendet eine oder mehrere aufeinanderfolgende Zeilen ab dem angegebenen Index aus.
hideSheet()SheetBlendet dieses Tabellenblatt aus.
insertChart(chart)voidFügt diesem Tabellenblatt ein neues Diagramm hinzu.
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 der angegebenen Position eine leere Spalte in ein Tabellenblatt ein.
insertColumns(columnIndex, numColumns)voidFügt eine oder mehrere aufeinanderfolgende leere Spalten in ein Tabellenblatt ein, beginnend an der angegebenen Position.
insertColumnsAfter(afterPosition, howMany)SheetFügt nach der angegebenen Spaltenposition eine bestimmte Anzahl von Spalten ein.
insertColumnsBefore(beforePosition, howMany)SheetFügt eine Anzahl von Spalten vor der angegebenen Spaltenposition ein.
insertImage(blobSource, column, row)OverGridImageFügt eine BlobSource als Bild an einer bestimmten Zeile und Spalte in das Dokument ein.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageFügt eine BlobSource als Bild an einer bestimmten Zeile und Spalte in das Dokument ein, mit einem Pixelversatz.
insertImage(url, column, row)OverGridImageFügt ein Bild an einer bestimmten Zeile und Spalte in das Dokument ein.
insertImage(url, column, row, offsetX, offsetY)OverGridImageFügt bei 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 an der angegebenen Position eine leere Zeile in ein Tabellenblatt ein.
insertRows(rowIndex, numRows)voidFügt eine oder mehrere aufeinanderfolgende leere Zeilen in ein Tabellenblatt ein, beginnend an der angegebenen Position.
insertRowsAfter(afterPosition, howMany)SheetFügt eine Anzahl 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 zurück, ob die angegebene Spalte vom Nutzer ausgeblendet ist.
isRightToLeft()BooleanGibt true zurück, wenn das Layout des Tabellenblatts linksläufig ist.
isRowHiddenByFilter(rowPosition)BooleanGibt zurück, ob die angegebene Zeile durch einen Filter (nicht durch eine Filteransicht) ausgeblendet ist.
isRowHiddenByUser(rowPosition)BooleanGibt zurück, ob die angegebene Zeile vom Nutzer ausgeblendet wurde.
isSheetHidden()BooleanGibt true zurück, wenn das Tabellenblatt derzeit ausgeblendet ist.
moveColumns(columnSpec, destinationIndex)voidVerschiebt die durch den angegebenen Bereich ausgewählten Spalten an die in destinationIndex angegebene Position.
moveRows(rowSpec, destinationIndex)voidVerschiebt die durch den angegebenen Bereich ausgewählten Zeilen an die in destinationIndex angegebene Position.
newChart()EmbeddedChartBuilderGibt einen Builder zurück, mit dem ein neues Diagramm für dieses Tabellenblatt erstellt werden kann.
protect()ProtectionErstellt ein Objekt, das verhindern kann, dass das Tabellenblatt bearbeitet wird, außer von Nutzern, die 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 obere linke Zelle im Bereich als current cell.
setActiveRangeList(rangeList)RangeListLegt die angegebene Liste von Bereichen als active ranges in der aktiven Tabellenblatt.
setActiveSelection(range)RangeLegt den aktiven Auswahlbereich für dieses Tabellenblatt fest.
setActiveSelection(a1Notation)RangeLegt die aktive Auswahl entsprechend der A1-Schreibweise oder R1C1-Notation fest.
setColumnGroupControlPosition(position)SheetLegt die Position der Ein/Aus-Schaltfläche für die Spaltengruppensteuerung auf dem Tabellenblatt fest.
setColumnWidth(columnPosition, width)SheetLegt die Breite der gegebenen Spalte in Pixeln fest.
setColumnWidths(startColumn, numColumns, width)SheetLegt die Breite der gegebenen Spalten in Pixeln fest.
setConditionalFormatRules(rules)voidAlle aktuell vorhandenen Regeln für die bedingte Formatierung im Tabellenblatt werden durch die Eingaberegeln ersetzt.
setCurrentCell(cell)RangeLegt die angegebene Zelle als current cell fest.
setFrozenColumns(columns)voidFixiert die angegebene Anzahl von Spalten.
setFrozenRows(rows)voidFixiert die angegebene Anzahl von Zeilen.
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 hebt dies auf.
setRowGroupControlPosition(position)SheetLegt die Position der Ein/Aus-Schaltfläche für die Zeilengruppensteuerung auf dem Tabellenblatt fest.
setRowHeight(rowPosition, height)SheetLegt die Zeilenhöhe der gegebenen Zeile in Pixeln fest.
setRowHeights(startRow, numRows, height)SheetLegt die Höhe der angegebenen Zeilen in Pixeln fest.
setRowHeightsForced(startRow, numRows, height)SheetLegt die Höhe der angegebenen Zeilen in Pixeln fest.
setTabColor(color)SheetLegt die Farbe des Tabellenblatt-Tabs fest.
setTabColorObject(color)SheetLegt die Farbe des Tabellenblatt-Tabs fest.
showColumns(columnIndex)voidBlendet die Spalte am angegebenen Index ein
showColumns(columnIndex, numColumns)voidBlendet eine oder mehrere aufeinanderfolgende Spalten beginnend beim angegebenen Index ein
showRows(rowIndex)voidBlendet die Zeile am angegebenen Index ein
showRows(rowIndex, numRows)voidBlendet eine oder mehrere aufeinanderfolgende Zeilen ab dem angegebenen Index ein
showSheet()SheetMacht das Tabellenblatt sichtbar.
sort(columnPosition)SheetSortiert ein Tabellenblatt aufsteigend nach Spalten.
sort(columnPosition, ascending)SheetSortiert ein Tabellenblatt nach Spalte.
unhideColumn(column)voidBlendet die Spalte im angegebenen Bereich ein.
unhideRow(row)voidBlendet die Zeile im angegebenen Bereich ein
updateChart(chart)voidAktualisiert das Diagramm auf diesem Tabellenblatt.

Detaillierte Dokumentation

activate()

Aktiviert dieses Tabellenblatt. Ändert nicht das Tabellenblatt selbst, sondern nur die Definition des übergeordneten Elements Tabellenblatt.

// 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 der Tabelle Entwicklermetadaten mit dem angegebenen Schlüssel hinzu.

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

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

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

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

Parameter

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

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addDeveloperMetadata(key, visibility)

Fügt der Tabelle 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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addDeveloperMetadata(key, value)

Fügt der Tabelle 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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

addDeveloperMetadata(key, value, visibility)

Fügt der Tabelle 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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

appendRow(rowContents)

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

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

asDataSourceSheet()

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

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

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

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

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

Rückflug

DataSourceSheet: Ein Tabellenblatt mit der Datenquelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

autoResizeColumn(columnPosition)

Legt die Breite der gegebenen Spalte so fest, dass sie ihrem Inhalt entspricht.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

autoResizeColumns(startColumn, numColumns)

Legt die Breite aller Spalten beginnend an der angegebenen Spaltenposition so fest, dass sie auf ihren Inhalt passt.

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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 so fest, dass sie auf ihren Inhalt passen.

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, deren Größe automatisch angepasst werden soll.
numRowsIntegerDie Anzahl der Zeilen, deren Größe automatisch angepasst werden soll.

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

clear()

Löscht das Tabellenblatt mit den Inhalts- und 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

clear(options)

Löscht den Inhalt und/oder das Format des Tabellenblatts entsprechend den angegebenen erweiterten Optionen.

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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

clearConditionalFormatRules()

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

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

clearContents()

Löscht den Inhalt des Tabellenblatts, behält aber 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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

clearFormats()

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

Die Formatierung bezieht sich darauf, wie Daten gemäß den Auswahlmöglichkeiten unter „Format“ formatiert werden. Menü (z. B. fett, kursiv, bedingte Formatierung) und nicht auf die Breite oder Höhe von Zellen.

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

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

clearNotes()

Löscht alle Notizen im Tabellenblatt.

// 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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

collapseAllColumnGroups()

Minimiert alle Spaltengruppen im Tabellenblatt.

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

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

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

copyTo(spreadsheet)

Kopiert das Tabellenblatt in eine bestimmte Tabellenkalkulation, die der Quelltabelle entsprechen kann. Die Das kopierte Tabellenblatt hat den Namen „Kopie von [Name des Originals]“.

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

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

Parameter

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

Rückflug

Sheet: Das neue Tabellenblatt für die Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

createDeveloperMetadataFinder()

Gibt eine DeveloperMetadataFinder zurück, um Entwicklermetadaten im Bereich von auf diesem Blatt. Metadaten gehören zum Geltungsbereich eines bestimmten Tabellenblatts, wenn sie entweder mit dem Tabellenblatts selbst oder mit einer Zeile, Spalte oder einem Bereich auf 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: Ein Tool für Entwicklermetadaten, mit dem nach Metadaten im Bereich dieses Tabellenblatts gesucht werden kann.


createTextFinder(findText)

Erstellt einen Textsucher für das Tabellenblatt, mit dem Text im Tabellenblatt gesucht und ersetzt werden 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
findTextStringText, nach dem gesucht werden soll

Rückflug

TextFinder: Die TextFinder 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

deleteColumns(columnPosition, howMany)

Löscht eine Anzahl 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

deleteRow(rowPosition)

Löscht die Zeile an der angegebenen Zeilenposition.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

deleteRows(rowPosition, howMany)

Löscht eine Anzahl 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

expandAllColumnGroups()

Maximiert alle Spaltengruppen im Tabellenblatt. Diese Methode erfordert mindestens eine Spaltengruppe.

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

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

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

expandAllRowGroups()

Maximiert alle Zeilengruppen im Tabellenblatt. Für diese 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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

expandColumnGroupsUpToDepth(groupDepth)

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

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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

expandRowGroupsUpToDepth(groupDepth)

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

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 zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getActiveCell()

Gibt die aktive Zelle in diesem Tabellenblatt zurück.

Hinweis: Wir empfehlen die Verwendung von getCurrentCell(), das den aktuellen Wert hervorgehobene Zelle.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getActiveRange()

Gibt den ausgewählten Bereich im aktiven Tabellenblatt oder null zurück, 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Weitere Informationen


getActiveRangeList()

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

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

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

Rückflug

RangeList – Liste der aktiven Bereiche

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Weitere Informationen


getBandings()

Gibt alle Bandierungen 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 Bandungen auf diesem Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getCharts()

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

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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
columnIndexIntegerDer Spaltenindex der Ein/Aus-Schaltfläche für die Gruppensteuerung oder ein Index innerhalb der Gruppe.
groupDepthIntegerDie Tiefe der Gruppe.

Rückflug

Group: Die Spaltengruppe am Kontrollindex und in der Kontrolltiefe oder löst eine Ausnahme aus, wenn die Gruppe existiert nicht.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 Tabellenblatts und andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getColumnGroupDepth(columnIndex)

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

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

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

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

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index der Spalte.

Rückflug

Integer – Die Gruppentiefe der Spalte am angegebenen Index.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getColumnWidth(columnPosition)

Ruft die Breite der gegebenen 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 untersuchenden Spalte.

Rückflug

Integer – Spaltenbreite in Pixeln

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getCurrentCell()

Gibt die aktuelle Zelle im aktiven Tabellenblatt oder null zurück, wenn keine Zelle vorhanden ist. Die Die aktuelle Zelle ist die Zelle, die in der Benutzeroberfläche von Google Tabellen hervorgehoben ist und mit einem dunklen Rahmen. Es gibt nie mehr als eine Zelle. Wenn Nutzende einen oder mehrere Zellenbereiche auswählen, Eine der Zellen in der Auswahl ist 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDataRange()

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

Funktional entspricht dies der Erstellung eines durch A1 begrenzten Bereichs (Sheet.getLastColumn(), Sheet.getLastRow()).

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, der alle Daten der Tabelle umfasst

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDataSourceFormulas()

Ruft alle Formeln für die Datenquelle ab.

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

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

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

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDataSourcePivotTables()

Ruft alle Pivot-Tabellen der Datenquelle ab.

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

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

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

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDataSourceTables()

Ruft alle Datenquellentabellen ab.

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

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

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

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

Rückflug

DataSourceTable[]: Eine Liste der Datenquellentabellen.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDeveloperMetadata()

Hiermit werden alle Entwicklermetadaten abgerufen, die mit diesem Tabellenblatt verknüpft sind.

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

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

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

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

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDrawings()

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

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

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

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

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

Rückflug

Drawing[]: Die Liste der Zeichnungen auf diesem Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFilter()

Gibt den Filter in diesem Tabellenblatt oder null zurück, 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 dieses Tabellenblatt hat kein verknüpftes Formular.

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

Rückflug

String: die URL des Formulars, in dem die Antworten in diesem Tabellenblatt abgelegt werden, oder null, wenn dies Tabellenblatt hat kein verknüpftes Formular.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFrozenColumns()

Gibt die Anzahl der fixierten Spalten zurück.

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

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

Rückflug

Integer – Die Anzahl der fixierten Spalten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getFrozenRows()

Gibt die Anzahl der fixierten Zeilen zurück.

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

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

Rückflug

Integer – Anzahl der fixierten Zeilen

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getImages()

Gibt alle über das Raster gelegten Bilder auf dem Tabellenblatt zurück.

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

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

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

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

Rückflug

OverGridImage[]: Ein Array von über das Raster gelegten Bildern.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getIndex()

Ruft die Position des Tabellenblatts in der übergeordneten Tabelle ab. Beginnt um 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: Position des Tabellenblatts in der übergeordneten Tabelle.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getLastColumn()

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

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 mit Inhalt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getLastRow()

Gibt die Position der letzten Zeile mit Inhalt zurück

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 mit Inhalt

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getMaxColumns()

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

// This example assumes there is a sheet named "first"
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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getMaxRows()

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

// This example assumes there is a sheet named "first"
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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getNamedRanges()

Ruft alle benannten Bereiche aus 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getParent()

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

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getPivotTables()

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

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

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

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

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

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 oder ein einzelnes Element darstellen Array, das den Schutz auf dem 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
typeProtectionTypeDie Art des Schutzgebiets, entweder SpreadsheetApp.ProtectionType.RANGE oder SpreadsheetApp.ProtectionType.SHEET.

Rückflug

Protection[]: ein Array von Objekten, die alle geschützten Bereiche im Tabellenblatt darstellen, oder ein einzelnes Element Array, das den Schutz auf dem Tabellenblatt selbst darstellt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getRange(row, column)

Gibt den Bereich mit der oberen linken Zelle an den angegebenen 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
rowIntegerZeilenindex der Zelle, die zurückgegeben werden soll die Zeilenindexierung beginnt mit 1.
columnIntegerSpaltenindex der Zelle, die zurückgegeben werden soll die Spaltenindexierung mit 1 beginnt.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getRange(row, column, numRows)

Gibt den Bereich zurück, bei dem sich die obere linke Zelle an den angegebenen Koordinaten befindet. Zeilen.

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 Startzeilenindex des Bereichs. die Zeilenindexierung beginnt mit 1.
columnIntegerDer Spaltenindex des Bereichs. die Spaltenindexierung mit 1 beginnt.
numRowsIntegerDie Anzahl der zurückzugebenden Zeilen.

Rückflug

Range: Ein Bereich, der eine einzelne Datenspalte mit der angegebenen Anzahl von Zeilen enthält.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getRange(row, column, numRows, numColumns)

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

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 Startzeilenindex des Bereichs. die Zeilenindexierung beginnt mit 1.
columnIntegerDer Startspaltenindex des Bereichs. die Spaltenindexierung mit 1 beginnt.
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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getRange(a1Notation)

Gibt den Bereich entsprechend der A1-Schreibweise oder R1C1-Schreibweise 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
a1NotationStringBereich, der gemäß A1-Schreibweise oder R1C1-Notation zurückgegeben werden soll.

Rückflug

Range: der Bereich am angegebenen Standort

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 angegebenen Tabellenblatt darstellt nicht leere Liste von A1- oder R1C1-Notationen.

// 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äß A1-Schreibweise oder R1C1-Notation.

Rückflug

RangeList – die Bereichsliste am angegebenen Standort

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 Ein/Aus-Schaltfläche für die Gruppensteuerung oder ein Index innerhalb der Gruppe.
groupDepthIntegerDie Tiefe der Gruppe.

Rückflug

Group: Die Zeilengruppe für den Kontrollindex und die Kontrolltiefe oder löst eine Ausnahme aus, wenn die Gruppe existiert nicht.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 auf diesem Tabellenblatt angezeigt wird und andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getRowGroupDepth(rowIndex)

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

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

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

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

Parameter

NameTypBeschreibung
rowIndexIntegerDer Index der Zeile.

Rückflug

Integer: Die Gruppentiefe der Zeile am angegebenen Index.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Rückflug

Integer – Zeilenhöhe in Pixeln

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSelection()

Gibt den aktuellen Wert für 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSheetId()

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

Dies ist eine eindeutige ID für das Tabellenblatt. Die ID ist ein monoton zunehmende Ganzzahl, die beim Erstellen des Tabellenblatts zugewiesen wurde, unabhängig von der Position des Tabellenblatts. Dieses 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 Arbeitsblatt dieser Tabelle

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSheetValues(startRow, startColumn, numRows, numColumns)

Gibt das rechteckige Werteraster für diesen Bereich zurück, beginnend bei den angegebenen Koordinaten. A–1 Der als Zeilen- oder Spaltenposition angegebene Wert entspricht dem Abrufen der letzten Zeile oder Spalte. die Daten im 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 Startspalte.
numRowsIntegerDie Anzahl der Zeilen, für die Werte zurückgegeben werden sollen.
numColumnsIntegerDie Anzahl der Spalten, für die Werte zurückgegeben werden sollen.

Rückflug

Object[][] – ein zweidimensionales Array von Werten

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getSlicers()

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

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

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

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

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

Rückflug

Slicer[]: Die Liste der Datenschnitte auf diesem Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getTabColorObject()

Ruft die Tab-Farbe des Tabellenblatts ab oder null, wenn der Tab des Tabellenblatts 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 Tab des Tabellenblatts keine Farbe hat.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getType()

Gibt den Typ des Tabellenblatts zurück.

Der Standardtabellentyp ist SheetType.GRID. Ein Tabellenblatt mit einem einzigen eingebetteten wie z. B. EmbeddedChart, ist ein SheetType.OBJECT-Tabellenblatt.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 Gitternetzlinien ausgeblendet sind Andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

hideColumns(columnIndex)

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

Verwenden Sie hideColumns(columnIndex, numColumns), um mehr als eine Spalte mithilfe eines Index auszublenden.

Um mehr als eine Spalte mithilfe eines Bereichs auszublenden, verwenden Sie hideColumn().

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

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index der ausgeblendeten Spalte.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

hideColumns(columnIndex, numColumns)

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

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

Parameter

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

hideRow(row)

Blendet die Zeilen im angegebenen Bereich aus.

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 Zeilenbereich, der ausgeblendet werden soll.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

hideRows(rowIndex)

Blendet die Zeile am 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 Startindex der auszublendenden Zeilen.
numRowsIntegerDie Anzahl der Zeilen, die ausgeblendet werden sollen.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

hideSheet()

Blendet dieses Tabellenblatt aus. Hat keine Auswirkungen, wenn das Tabellenblatt bereits ausgeblendet ist. Wird diese Methode im nur sichtbares Blatt aus, wird eine Ausnahme ausgelöst.

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

Rückflug

Sheet: Das aktuelle Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertChart(chart)

Fügt diesem Tabellenblatt ein neues Diagramm hinzu.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 hinzugefügt werden soll.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertColumns(columnIndex)

Fügt an der angegebenen Position 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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, beginnend an der angegebenen Position.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertColumnsAfter(afterPosition, howMany)

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

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

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

Parameter

NameTypBeschreibung
afterPositionIntegerDie Spalte, nach der die neue Spalte 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertColumnsBefore(beforePosition, howMany)

Fügt eine Anzahl 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertImage(blobSource, column, row)

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

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) Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

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

Fügt eine BlobSource als Bild an einer bestimmten Zeile und Spalte in das Dokument ein, mit einem Pixelversatz. Die Bildgröße wird aus dem Blob-Inhalt abgerufen. Das maximal unterstützte Blob die Größe 2 MB beträgt.

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) Namen.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Versatz von der Ecke der Zelle in Pixeln.
offsetYIntegerDer vertikale Versatz von der Ecke der Zelle in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertImage(url, column, row)

Fügt ein Bild an einer bestimmten Zeile und Spalte 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

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

Fügt bei 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.
columnIntegerDie Spaltenposition.
rowIntegerDie Zeilenposition.
offsetXIntegerDer horizontale Versatz von der Ecke der Zelle in Pixeln.
offsetYIntegerDer vertikale Versatz von der Ecke der Zelle in Pixeln.

Rückflug

OverGridImage: Das eingefügte Bild.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertRowAfter(afterPosition)

Fügt eine Zeile nach der angegebenen Zeilenposition ein.

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 hinzugefügt werden soll.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertRowBefore(beforePosition)

Fügt eine Zeile vor der angegebenen Zeilenposition ein.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertRows(rowIndex)

Fügt an der angegebenen Position eine leere Zeile in ein Tabellenblatt 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertRows(rowIndex, numRows)

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

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertRowsAfter(afterPosition, howMany)

Fügt eine Anzahl 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 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

insertSlicer(range, anchorRowPos, anchorColPos)

Fügt diesem Tabellenblatt einen neuen 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 Datenschnitte erstellt werden.
anchorRowPosIntegerIn dieser Zeile ist die obere Seite des Datenschnitts 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

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

Fügt diesem Tabellenblatt einen neuen 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 Datenschnitte erstellt werden.
anchorRowPosIntegerIn dieser Zeile ist die obere Seite des Datenschnitts verankert.
anchorColPosIntegerDie obere Seite des Datenschnitts ist in dieser Spalte verankert.
offsetXIntegerDer horizontale Versatz von der Ecke der Zelle in Pixeln.
offsetYIntegerDer vertikale Versatz von der Ecke der Zelle in Pixeln.

Rückflug

Slicer: Der neu eingefügte Datenschnitt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isColumnHiddenByUser(columnPosition)

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

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

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

Parameter

NameTypBeschreibung
columnPositionIntegerDie Position der zu untersuchenden Spalte.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isRightToLeft()

Gibt true zurück, wenn das Layout des Tabellenblatts linksläufig ist. Gibt false zurück, wenn das Tabellenblatt wird 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 linksläufig; Andernfalls false.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isRowHiddenByFilter(rowPosition)

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isRowHiddenByUser(rowPosition)

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

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

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

Parameter

NameTypBeschreibung
rowPositionIntegerDie Position der zu untersuchenden Zeile.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

isSheetHidden()

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

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

moveColumns(columnSpec, destinationIndex)

Verschiebt die durch den angegebenen Bereich ausgewählten Spalten an die in destinationIndex angegebene Position. Das columnSpec selbst muss nicht genau ein ganzes Spalte oder Gruppe von Spalten, die verschoben werden sollen, 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
columnSpecRangeEin Bereich, der die Spalten umfasst, die verschoben werden sollen.
destinationIndexIntegerDer Index, in den die Spalten verschoben werden sollen. Beachten Sie, dass dieser Index basierend auf den Koordinaten vor dem Verschieben der Spalten. Vorhandene Daten werden nach rechts und Platz für die verschobenen Spalten schaffen, während die Quellspalten aus dem Raster entfernt werden. Daher kann es sein, dass sich die Daten in einem anderen Index als ursprünglich angegeben befinden.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

moveRows(rowSpec, destinationIndex)

Verschiebt die durch den angegebenen Bereich ausgewählten Zeilen an die in destinationIndex angegebene Position. Die rowSpec selbst muss nicht genau eine ganze Zeile darstellen oder eine Gruppe von Zeilen, die verschoben werden sollen, 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
rowSpecRangeEin Bereich, der die zu verschiebenden Zeilen umfasst.
destinationIndexIntegerDer Index, in den die Zeilen verschoben werden sollen. Beachten Sie, dass dieser Index basierend auf den Koordinaten vor dem Verschieben der Zeilen. Vorhandene Daten werden nach unten verschoben, verschoben werden, während die Quellzeilen aus dem Raster entfernt werden. Dementsprechend wird der können Daten zu einem anderen Index führen als ursprünglich angegeben.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

newChart()

Gibt einen Builder zurück, mit dem ein neues Diagramm für dieses Tabellenblatt erstellt werden kann.

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, die Berechtigung. Bis das Skript die Liste der Bearbeiter für das Tabellenblatt ändert (durch Aufrufen Protection.removeEditor(emailAddress), Protection.removeEditor(user), Protection.removeEditors(emailAddresses), Protection.addEditor(emailAddress), Protection.addEditor(user), Protection.addEditors(emailAddresses) oder es wird ein neuer für Protection.setDomainEdit(editable)), entsprechen die Berechtigungen denen der Tabelle selbst, was bedeutet, dass das Tabellenblatt ungeschützt bleibt. Wenn das Tabellenblatt bereits geschützt ist, gibt diese Methode ein Objekt zurück, das die vorhandenen Schutzeinstellungen darstellt. Ein geschütztes Tabellenblatt kann ungeschützte Bereiche enthalten.

// Protect the active sheet, then remove all other users from the list of editors.
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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

removeChart(chart)

Entfernt ein Diagramm aus dem übergeordneten Tabellenblatt.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 obere linke Zelle im Bereich als current cell.

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 neue aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setActiveRangeList(rangeList)

Legt die angegebene Liste von Bereichen als active ranges in der aktiven Tabellenblatt. Der letzte Bereich in der Liste ist 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setActiveSelection(range)

Legt den aktiven Auswahlbereich für dieses Tabellenblatt fest.

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 neue aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setActiveSelection(a1Notation)

Legt die aktive Auswahl entsprechend der A1-Schreibweise oder R1C1-Notation fest.

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

sheet.setActiveSelection("A1:D4");

Parameter

NameTypBeschreibung
a1NotationStringDer als aktiv festzulegende Bereich gemäß A1-Schreibweise oder R1C1-Notation.

Rückflug

Range – der neue aktive Bereich

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setColumnGroupControlPosition(position)

Legt die Position der Ein/Aus-Schaltfläche für die Spaltengruppensteuerung auf dem Tabellenblatt fest.

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

Parameter

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

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setColumnWidth(columnPosition, width)

Legt die Breite der gegebenen 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 festzulegenden Spalte.
widthIntegerDie Breite in Pixeln, die festgelegt werden soll.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setColumnWidths(startColumn, numColumns, width)

Legt die Breite der gegebenen 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 Ausgangsposition der Spalte, die geändert werden soll.
numColumnsIntegerDie Anzahl der zu ändernden Spalten.
widthIntegerDie Breite in Pixeln, die festgelegt werden soll.

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setConditionalFormatRules(rules)

Alle aktuell vorhandenen Regeln für die bedingte Formatierung im Tabellenblatt werden durch die Eingaberegeln ersetzt. Regeln werden in der 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 zur aktiven Bereich, wobei die Zelle die aktuelle Zelle ist.

Wenn die angegebene Zelle in keinem der ausgewählten Bereiche vorhanden ist, wird eine vorhandene Auswahl entfernt wird und die Zelle zur aktuellen Zelle und zum aktiven Bereich wird.

Hinweis:Die angegebene Range muss aus einer Zelle bestehen. Andernfalls wird ein Fehler ausgegeben. Ausnahme.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setFrozenColumns(columns)

Fixiert die angegebene Anzahl von Spalten. Wenn null, werden keine Spalten fixiert.

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

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

Parameter

NameTypBeschreibung
columnsIntegerDie Anzahl der zu fixierenden Spalten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setFrozenRows(rows)

Fixiert die angegebene Anzahl von Zeilen. Wenn null, werden keine Zeilen fixiert.

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

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

Parameter

NameTypBeschreibung
rowsIntegerDie Anzahl der Zeilen, die fixiert werden sollen.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setHiddenGridlines(hideGridlines)

Blendet die Gitternetzlinien des Tabellenblatts ein oder aus.

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

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

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

Parameter

NameTypBeschreibung
hideGridlinesBooleanBei true werden die Gitternetzlinien in diesem Tabellenblatt ausgeblendet. Andernfalls wird die Gitternetzlinien.

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 hebt dies auf.

// 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
rightToLeftBooleanWenn true festgelegt ist, wird das Tabellenblattlayout auf linksläufig festgelegt, wobei Zelle A1 in in der oberen rechten Ecke. Wenn false festgelegt ist, wird das Tabellenblattlayout auf die Standardeinstellung gesetzt von links nach rechts, wobei Zelle A1 oben links ist.

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setRowGroupControlPosition(position)

Legt die Position der Ein/Aus-Schaltfläche für die Zeilengruppensteuerung auf dem Tabellenblatt fest.

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

Parameter

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

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setRowHeight(rowPosition, height)

Legt die Zeilenhöhe der gegebenen Zeile in Pixeln fest. Standardmäßig werden Zeilen so vergrößert, dass sie in den Zelleninhalt passen. Wenn 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, auf die festgelegt werden soll.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setRowHeights(startRow, numRows, height)

Legt die Höhe der angegebenen Zeilen in Pixeln fest. Standardmäßig werden die Zeilen so angepasst, dass sie in den Zelleninhalt passen. 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 Startzeilenposition, die geändert werden soll.
numRowsIntegerDie Anzahl der Zeilen, die geändert werden sollen.
heightIntegerDie Höhe in Pixeln, auf die festgelegt werden soll.

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setRowHeightsForced(startRow, numRows, height)

Legt die Höhe der angegebenen Zeilen in Pixeln fest. Standardmäßig werden die Zeilen so angepasst, dass sie in den Zelleninhalt passen. Wann? setRowHeightsForced verwenden, werden Zeilen auf die angegebene Höhe erzwungen, auch wenn der Zelleninhalte höher als die Zeilenhöhe sind.

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 Startzeilenposition, die geändert werden soll.
numRowsIntegerDie Anzahl der Zeilen, die geändert werden sollen.
heightIntegerDie Höhe in Pixeln, auf die festgelegt werden soll.

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setTabColor(color)

Legt die Farbe des Tabellenblatt-Tabs 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
colorStringeinen Farbcode in CSS-Notation (z. B. '#ffffff' oder 'white') oder null, um die Tab-Farbe zurückzusetzen.

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

setTabColorObject(color)

Legt die Farbe des Tabellenblatt-Tabs 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 festzulegende Farbe des Tabellenblatt-Tabs.

Rückflug

Sheet: Dieses Tabellenblatt zur Verkettung.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

showColumns(columnIndex)

Blendet die Spalte am angegebenen Index ein

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

Parameter

NameTypBeschreibung
columnIndexIntegerDer Index der einzublendenden Spalte.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

showColumns(columnIndex, numColumns)

Blendet eine oder mehrere aufeinanderfolgende Spalten beginnend beim angegebenen Index ein

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

Parameter

NameTypBeschreibung
columnIndexIntegerDer Startindex der einzublendenden Spalten.
numColumnsIntegerDie Anzahl der einzublendenden Spalten.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

showRows(rowIndex)

Blendet die Zeile am angegebenen Index 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

  • 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 Startindex der einzublendenden Zeilen.
numRowsIntegerDie Anzahl der einzublendenden Zeilen.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

showSheet()

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

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

Rückflug

Sheet: Das aktuelle Tabellenblatt.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

sort(columnPosition)

Sortiert ein Tabellenblatt aufsteigend nach Spalten.

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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

sort(columnPosition, ascending)

Sortiert ein Tabellenblatt nach Spalte. Verwendet einen Parameter, um aufsteigend oder absteigend anzugeben.

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 Sortierung, false für absteigende Sortierung.

Rückflug

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

unhideColumn(column)

Blendet die Spalte im angegebenen Bereich 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
columnRangeDer Bereich, der eingeblendet werden soll, falls ausgeblendet.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

unhideRow(row)

Blendet die Zeile im angegebenen Bereich ein

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
rowRangeDer Bereich, der eingeblendet werden soll, falls ausgeblendet.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

updateChart(chart)

Aktualisiert das Diagramm auf 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, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Verworfene Methoden