Builder für Tabellendiagramme. Weitere Informationen finden Sie in der Gviz-Dokumentation.
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
add | Embedded | Fügt dem Diagramm, das von diesem Builder geändert wird, einen Bereich hinzu. |
as | Embedded | Legt den Diagrammtyp auf „AreaChart“ fest und gibt ein Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „BarChart“ fest und gibt ein Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „ColumnChart“ fest und gibt ein Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „ComboChart“ fest und gibt ein Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf HistogramChart fest und gibt ein Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf LineChart fest und gibt ein Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „PieChart“ fest und gibt ein Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „ScatterChart“ fest und gibt ein Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „TableChart“ fest und gibt ein Embedded zurück. |
build() | Embedded | Erstellt das Diagramm neu, um alle Änderungen zu berücksichtigen. |
clear | Embedded | Entfernt alle Bereiche aus dem Diagramm, das mit diesem Builder geändert wird. |
enable | Embedded | Legt fest, ob das Paging durch die Daten aktiviert werden soll. |
enable | Embedded | Aktiviert die Paginierung und legt die Anzahl der Zeilen auf jeder Seite fest. |
enable | Embedded | Aktiviert die Paginierung, legt die Anzahl der Zeilen auf jeder Seite und die erste anzuzeigende Tabellenseite fest (Seitenzahlen sind nullbasiert). |
enable | Embedded | Fügt grundlegende Unterstützung für rechtsläufige Sprachen (z. B. Arabisch oder Hebräisch) hinzu, indem die Spaltenreihenfolge der Tabelle umgekehrt wird. Spalte 0 ist also die Spalte ganz rechts und die letzte Spalte ist die Spalte ganz links. |
enable | Embedded | Legt fest, ob Spalten sortiert werden sollen, wenn der Nutzer auf eine Spaltenüberschrift klickt. |
get | Chart | Gibt den aktuellen Diagrammtyp zurück. |
get | Container | Gibt das Diagramm Container zurück, das die Position des Diagramms im Tabellenblatt angibt. |
get | Range[] | Gibt eine Kopie der Liste der Bereiche zurück, die derzeit Daten für dieses Diagramm liefern. |
remove | Embedded | Entfernt den angegebenen Bereich aus dem Diagramm, das von diesem Builder geändert wird. |
set | Embedded | Ändert den Diagrammtyp. |
set | Embedded | Legt die Zeilennummer für die erste Zeile in der Datentabelle fest. |
set | Embedded | Legt die Strategie für ausgeblendete Zeilen und Spalten fest. |
set | Embedded | Legt den Index der Spalte fest, nach der die Tabelle anfänglich sortiert werden soll (aufsteigend). |
set | Embedded | Legt den Index der Spalte fest, nach der die Tabelle anfänglich sortiert werden soll (absteigend). |
set | Embedded | Legt die Zusammenführungsstrategie fest, die verwendet werden soll, wenn mehrere Bereiche vorhanden sind. |
set | Embedded | Legt die Anzahl der Zeilen oder Spalten des Bereichs fest, die als Überschriften behandelt werden sollen. |
set | Embedded | Legt erweiterte Optionen für dieses Diagramm fest. |
set | Embedded | Legt die Position fest und ändert so, wo das Diagramm auf dem Tabellenblatt angezeigt wird. |
set | Embedded | Legt fest, ob die Zeilen und Spalten des Diagramms transponiert werden. |
show | Embedded | Legt fest, ob die Zeilennummer als erste Spalte der Tabelle angezeigt werden soll. |
use | Embedded | Legt fest, ob ungeraden und geraden Zeilen eines Tabellendiagramms ein abwechselnder Farbstil zugewiesen wird. |
Detaillierte Dokumentation
addRange(range)
Fügt dem Diagramm, das von diesem Builder geändert wird, einen Bereich hinzu. Der Bereich wird nicht hinzugefügt, wenn er dem Diagramm bereits hinzugefügt wurde.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
range | Range | Der hinzuzufügende Bereich. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
asAreaChart()
Legt den Diagrammtyp auf „AreaChart“ fest und gibt ein EmbeddedAreaChartBuilder zurück.
Rückflug
EmbeddedAreaChartBuilder – Ein Builder für ein Flächendiagramm.
asBarChart()
Legt den Diagrammtyp auf „BarChart“ fest und gibt ein EmbeddedBarChartBuilder zurück.
Rückflug
EmbeddedBarChartBuilder – Ein Builder für ein Balkendiagramm.
asColumnChart()
Legt den Diagrammtyp auf „ColumnChart“ fest und gibt ein EmbeddedColumnChartBuilder zurück.
Rückflug
EmbeddedColumnChartBuilder: Ein Builder für ein Säulendiagramm.
asComboChart()
Legt den Diagrammtyp auf „ComboChart“ fest und gibt ein EmbeddedComboChartBuilder zurück.
Rückflug
EmbeddedComboChartBuilder – Ein Builder für ein Kombinationsdiagramm.
asHistogramChart()
Legt den Diagrammtyp auf HistogramChart fest und gibt ein EmbeddedHistogramChartBuilder zurück.
Rückflug
EmbeddedHistogramChartBuilder – Ein Builder für ein Histogramm.
asLineChart()
Legt den Diagrammtyp auf LineChart fest und gibt ein EmbeddedLineChartBuilder zurück.
Rückflug
EmbeddedLineChartBuilder: Ein Builder für ein Liniendiagramm.
asPieChart()
Legt den Diagrammtyp auf „PieChart“ fest und gibt ein EmbeddedPieChartBuilder zurück.
Rückflug
EmbeddedPieChartBuilder: Ein Builder für ein Kreisdiagramm.
asScatterChart()
Legt den Diagrammtyp auf „ScatterChart“ fest und gibt ein EmbeddedScatterChartBuilder zurück.
Rückflug
EmbeddedScatterChartBuilder: Ein Builder für ein Streudiagramm.
asTableChart()
Legt den Diagrammtyp auf „TableChart“ fest und gibt ein EmbeddedTableChartBuilder zurück.
Rückflug
EmbeddedTableChartBuilder: Ein Builder für ein Tabellendiagramm.
build()
Erstellt das Diagramm neu, um alle Änderungen zu berücksichtigen.
Bei dieser Methode wird das Diagramm nicht automatisch über der Tabelle gezeichnet. Ein neues Diagramm muss über sheet.insertChart(chart) eingefügt und ein vorhandenes Diagramm über sheet.updateChart(chart) aktualisiert werden.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Rückflug
EmbeddedChart: Das erstellte Diagramm, das noch der Tabelle hinzugefügt werden muss.
clearRanges()
Entfernt alle Bereiche aus dem Diagramm, das mit diesem Builder geändert wird.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; // This code updates the chart to use only the new ranges while preserving the // existing formatting of the chart. const chart = sheet.getCharts()[0]; const newChart = chart.modify() .clearRanges() .addRange(sheet.getRange('A1:A5')) .addRange(sheet.getRange('B1:B5')) .build(); sheet.updateChart(newChart);
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
enablePaging(enablePaging)
Legt fest, ob das Paging durch die Daten aktiviert werden soll.
Standardmäßig ist die Paginierung deaktiviert. Wenn die Paginierung aktiviert ist, beträgt die Standardseitengröße 10.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
enable | Boolean | true, wenn die Paginierung aktiviert werden soll, andernfalls false. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
enablePaging(pageSize)
Aktiviert die Paginierung und legt die Anzahl der Zeilen auf jeder Seite fest.
Die Standardseitengröße ist 10.
// Creates a table chart builder and enables paging with page size of 5. const builder = Charts.newTableChart(); builder.enablePaging(5);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
page | Integer | Die Anzahl der Zeilen auf jeder Seite der Tabelle. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
enablePaging(pageSize, startPage)
Aktiviert die Paginierung, legt die Anzahl der Zeilen auf jeder Seite und die erste anzuzeigende Tabellenseite fest (Seitenzahlen sind nullbasiert).
Die Standardseitengröße ist 10 und die Standardstartseite ist 0.
// Creates a table chart builder and enables paging with page size of 5 and // displays page 2 first. const builder = Charts.newTableChart(); builder.enablePaging(5, 2);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
page | Integer | Die Anzahl der Zeilen auf jeder Seite der Tabelle. |
start | Integer | Die erste Tabellenseite, die angezeigt werden soll (Seitenzahlen sind nullbasiert). |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
enableRtlTable(rtlEnabled)
Fügt grundlegende Unterstützung für rechtsläufige Sprachen (z. B. Arabisch oder Hebräisch) hinzu, indem die Spaltenreihenfolge der Tabelle umgekehrt wird. Spalte 0 ist also die Spalte ganz rechts und die letzte Spalte ist die Spalte ganz links.
Dies hat keine Auswirkungen auf den Spaltenindex in den zugrunde liegenden Daten, sondern nur auf die Reihenfolge der Darstellung. Die vollständige bidirektionale (BiDi) Sprachanzeige wird von der Tabellenvisualisierung auch mit dieser Option nicht unterstützt. Diese Option wird ignoriert, wenn Sie die Paginierung aktivieren (mit der Option „page“) oder wenn die Tabelle Scrollbalken hat, weil Sie Optionen für Höhe und Breite angegeben haben, die kleiner als die erforderliche Tabellengröße sind. Standardmäßig ist die RTL-Unterstützung deaktiviert.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
rtl | Boolean | true, wenn die Unterstützung für die Leserichtung von rechts nach links aktiviert werden soll, andernfalls false. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
enableSorting(enableSorting)
Legt fest, ob Spalten sortiert werden sollen, wenn der Nutzer auf eine Spaltenüberschrift klickt.
Wenn die Sortierung aktiviert ist, werden die Zeilen automatisch sortiert, wenn Nutzer auf die Spaltenüberschrift klicken. Standardmäßig ist die Sortierung aktiviert.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
enable | Boolean | true, um das Sortieren durch Klicken auf Spaltenüberschriften zu aktivieren, false andernfalls. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
getChartType()
getContainer()
Gibt das Diagramm ContainerInfo zurück, das die Position des Diagramms im Tabellenblatt angibt.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0); // This method returns the exact same data as Chart#getContainerInfo() const containerInfo = chartBuilder.getContainer(); // Logs the values used in setPosition() Logger.log( 'Anchor Column: %s\r\nAnchor Row %s\r\nOffset X %s\r\nOffset Y %s', containerInfo.getAnchorColumn(), containerInfo.getAnchorRow(), containerInfo.getOffsetX(), containerInfo.getOffsetY(), );
Rückflug
ContainerInfo: Ein Objekt mit der Position des Diagrammcontainers.
getRanges()
Gibt eine Kopie der Liste der Bereiche zurück, die derzeit Daten für dieses Diagramm liefern. Verwenden Sie addRange(range) und removeRange(range), um diese Liste zu ändern.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange('A1:B8')) .setPosition(5, 5, 0, 0); const ranges = chartBuilder.getRanges(); // There's only one range as a data source for this chart, // so this logs "A1:B8" for (const i in ranges) { const range = ranges[i]; Logger.log(range.getA1Notation()); }
Rückflug
Range[]: Ein Array von Bereichen, die als Datenquelle für das zu erstellende Diagramm dienen.
removeRange(range)
Entfernt den angegebenen Bereich aus dem Diagramm, das von diesem Builder geändert wird. Es wird kein Fehler ausgegeben, wenn der Bereich nicht in diesem Diagramm enthalten ist.
Der entfernte Bereich muss mit einem Bereich übereinstimmen, der über addRange(range) hinzugefügt wurde. Andernfalls wird das Diagramm nicht geändert. Mit dieser Methode können Werte nicht teilweise aus einem Bereich entfernt werden.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const firstRange = sheet.getRange('A1:B5'); const secondRange = sheet.getRange('A6:B8'); const chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(firstRange) // This range renders in a different color .addRange(secondRange) .setPosition(5, 5, 0, 0); // Note that you can use either of these two formats, but the range // MUST match up with a range that was added via addRange(), or it // is not removed, and does not throw an exception chartBuilder.removeRange(firstRange); chartBuilder.removeRange(sheet.getRange('A6:B8')); const chart = chartBuilder.build(); sheet.insertChart(chart);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
range | Range | Der zu entfernende Bereich. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
setChartType(type)
Ändert den Diagrammtyp. Derzeit werden nicht alle eingebetteten Diagrammtypen unterstützt. ChartType ansehen.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
type | Chart | Der Typ, in den dieses Diagramm geändert werden soll. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
setFirstRowNumber(number)
Legt die Zeilennummer für die erste Zeile in der Datentabelle fest.
Die Standardzeilennummer der ersten Zeile ist 1.
// Creates a table chart builder and sets the first row to be 2. const builder = Charts.newTableChart(); builder.setFirstRowNumber(2);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
number | Integer | Die Zeilennummer der ersten Zeile in der Datentabelle. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
setHiddenDimensionStrategy(strategy)
Legt die Strategie für ausgeblendete Zeilen und Spalten fest. Die Standardeinstellung ist IGNORE_ROWS.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setHiddenDimensionStrategy( Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS, ) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
strategy | Chart | Die Strategie, die für ausgeblendete Zeilen und Spalten verwendet werden soll. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
setInitialSortingAscending(column)
Legt den Index der Spalte fest, nach der die Tabelle anfänglich sortiert werden soll (aufsteigend).
Die Spalte ist in aufsteigender Reihenfolge sortiert und mit einem kleinen Pfeil gekennzeichnet.
// Creates a table chart builder and sorts it by the second column (ascending). const builder = Charts.newTableChart(); builder.setInitialSortingAscending(2);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
column | Integer | Die Nummer der Spalte, nach der die Tabelle anfänglich sortiert werden soll. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
setInitialSortingDescending(column)
Legt den Index der Spalte fest, nach der die Tabelle anfänglich sortiert werden soll (absteigend).
Die Spalte ist in absteigender Reihenfolge sortiert und mit einem kleinen Pfeil gekennzeichnet.
// Creates a table chart builder and sorts it by the second column (descending). const builder = Charts.newTableChart(); builder.setInitialSortingDescending(2);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
column | Integer | Die Nummer der Spalte, nach der die Tabelle anfänglich sortiert werden soll. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
setMergeStrategy(mergeStrategy)
Legt die Zusammenführungsstrategie fest, die verwendet werden soll, wenn mehrere Bereiche vorhanden sind. Bei MERGE_ROWS werden Zeilen zusammengeführt, bei MERGE_COLUMNS Spalten. Die Standardeinstellung ist MERGE_COLUMNS.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B10'); const range2 = sheet.getRange('C:C10'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .addRange(range2) .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
merge | Chart | Die zu verwendende Zusammenführungsstrategie. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
setNumHeaders(headers)
Legt die Anzahl der Zeilen oder Spalten des Bereichs fest, die als Überschriften behandelt werden sollen.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setNumHeaders(1) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
headers | Integer | Die Anzahl der Zeilen oder Spalten, die als Header behandelt werden sollen. Bei negativen Werten werden Header automatisch erkannt. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
setOption(option, value)
Legt erweiterte Optionen für dieses Diagramm fest. Eine Liste der verfügbaren Optionen finden Sie unter Konfigurationsoptionen für Diagramme.
Bei dieser Methode wird nicht geprüft, ob die angegebene Option für diesen Diagrammtyp gültig ist oder ob der Wert das richtige Format bzw. die richtige Struktur hat.
In diesem Beispiel wird gezeigt, wie Sie den Titel ändern und eine Legende festlegen.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); const sheet = spreadsheet.getSheets()[0]; const chart = sheet.newChart() .setOption('title', 'Earnings projections') .setOption('legend', { position: 'top', textStyle: { color: 'blue', fontSize: 16 }, }).build();
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
option | String | Der Name der Option. |
value | Object | Der Wert der Option. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Legt die Position fest und ändert so, wo das Diagramm auf dem Tabellenblatt angezeigt wird. anchorRowPos und anchorColPos sind 1-basiert.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
anchor | Integer | Die Oberseite des Diagramms wird in dieser Zeile verankert. |
anchor | Integer | Die linke Seite des Diagramms ist in dieser Spalte verankert. |
offsetX | Integer | Die rechte obere Ecke des Diagramms wird um diese Anzahl von Pixeln versetzt. |
offsetY | Integer | Die linke untere Ecke des Diagramms wird um diese Anzahl von Pixeln versetzt. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
setTransposeRowsAndColumns(transpose)
Legt fest, ob die Zeilen und Spalten des Diagramms transponiert werden. Wenn diese Option auf true gesetzt ist, werden die Zeilen und Spalten vertauscht. Die Standardeinstellung ist false.
const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0]; const range = sheet.getRange('A1:B5'); const chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setTransposeRowsAndColumns(true) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
transpose | Boolean | Bei true werden die Zeilen und Spalten, die zum Erstellen des Diagramms verwendet werden, transponiert. |
Rückflug
EmbeddedChartBuilder – Dieser Builder zur Verkettung.
showRowNumberColumn(showRowNumber)
Legt fest, ob die Zeilennummer als erste Spalte der Tabelle angezeigt werden soll.
Standardmäßig werden keine Zeilennummern angezeigt.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
show | Boolean | true, wenn in der ersten Spalte der Tabelle die Zeilennummer angezeigt werden soll, andernfalls false. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.
useAlternatingRowStyle(alternate)
Legt fest, ob ungeraden und geraden Zeilen eines Tabellendiagramms ein abwechselnder Farbstil zugewiesen wird.
Standardmäßig haben die Zeilen einen abwechselnden Farbstil.
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
alternate | Boolean | true, wenn sich die Farbstile abwechseln sollen, andernfalls false. |
Rückflug
EmbeddedTableChartBuilder – Dieser Builder, nützlich für die Verkettung.