Ein Builder, der zum Bearbeiten eines EmbeddedChart
verwendet wird. Änderungen am Diagramm werden erst gespeichert, wenn Sheet.updateChart(chart)
auf dem neu erstellten Diagramm aufgerufen wird.
var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("A1:B8"); var chart = sheet.getCharts()[0]; chart = chart.modify() .addRange(range) .setOption('title', 'Updated!') .setOption('animation.duration', 500) .setPosition(2,2,0,0) .build(); sheet.updateChart(chart);
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addRange(range) | EmbeddedChartBuilder | Fügt dem Diagramm, das dieser Builder ändert, einen Bereich hinzu. |
asAreaChart() | EmbeddedAreaChartBuilder | Legt den Diagrammtyp auf AreaChart fest und gibt ein EmbeddedAreaChartBuilder zurück. |
asBarChart() | EmbeddedBarChartBuilder | Legt den Diagrammtyp auf „Balkendiagramm“ fest und gibt ein EmbeddedBarChartBuilder zurück. |
asColumnChart() | EmbeddedColumnChartBuilder | Legt den Diagrammtyp auf ColumnChart fest und gibt ein EmbeddedColumnChartBuilder zurück. |
asComboChart() | EmbeddedComboChartBuilder | Legt den Diagrammtyp auf ComboChart fest und gibt ein EmbeddedComboChartBuilder zurück. |
asHistogramChart() | EmbeddedHistogramChartBuilder | Legt den Diagrammtyp auf HistogramChart fest und gibt ein EmbeddedHistogramChartBuilder zurück. |
asLineChart() | EmbeddedLineChartBuilder | Legt den Diagrammtyp auf LineChart fest und gibt ein EmbeddedLineChartBuilder zurück. |
asPieChart() | EmbeddedPieChartBuilder | Legt den Diagrammtyp auf „Kreisdiagramm“ fest und gibt ein EmbeddedPieChartBuilder zurück. |
asScatterChart() | EmbeddedScatterChartBuilder | Legt den Diagrammtyp auf ScatterChart fest und gibt ein EmbeddedScatterChartBuilder zurück. |
asTableChart() | EmbeddedTableChartBuilder | Legt den Diagrammtyp auf TableChart fest und gibt ein EmbeddedTableChartBuilder zurück. |
build() | EmbeddedChart | Erstellt das Diagramm, um alle daran vorgenommenen Änderungen widerzuspiegeln. |
clearRanges() | EmbeddedChartBuilder | Entfernt alle Bereiche aus dem Diagramm, das dieser Builder ändert. |
getChartType() | ChartType | Gibt den aktuellen Diagrammtyp zurück. |
getContainer() | ContainerInfo | Geben Sie das Diagramm ContainerInfo zurück, das angibt, wo das Diagramm auf dem Tabellenblatt angezeigt wird. |
getRanges() | Range[] | Gibt eine Kopie der Liste der Bereiche zurück, die derzeit Daten für dieses Diagramm liefern. |
removeRange(range) | EmbeddedChartBuilder | Entfernt den angegebenen Bereich aus dem Diagramm, das dieser Builder ändert. |
setChartType(type) | EmbeddedChartBuilder | Ändert den Diagrammtyp. |
setHiddenDimensionStrategy(strategy) | EmbeddedChartBuilder | Legt die Strategie für ausgeblendete Zeilen und Spalten fest. |
setMergeStrategy(mergeStrategy) | EmbeddedChartBuilder | Legt die Zusammenführungsstrategie fest, die verwendet werden soll, wenn mehrere Bereiche vorhanden sind. |
setNumHeaders(headers) | EmbeddedChartBuilder | Legt die Anzahl der Zeilen oder Spalten des Bereichs fest, die als Kopfzeilen behandelt werden sollen. |
setOption(option, value) | EmbeddedChartBuilder | Legt erweiterte Optionen für dieses Diagramm fest. |
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY) | EmbeddedChartBuilder | Legt die Position fest, wobei die Position des Diagramms auf dem Tabellenblatt geändert wird. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Legt fest, ob die Zeilen und Spalten des Diagramms transponiert werden sollen. |
Detaillierte Dokumentation
addRange(range)
Fügt dem Diagramm, das dieser Builder ändert, einen Bereich hinzu. Der Bereich wird nicht hinzugefügt, wenn er bereits in das Diagramm eingefügt wurde.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var 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 | Bereich, der hinzugefügt werden soll. |
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten
asAreaChart()
Legt den Diagrammtyp auf AreaChart fest und gibt ein EmbeddedAreaChartBuilder
zurück.
Return
EmbeddedAreaChartBuilder
: Ein Builder für ein Flächendiagramm
asBarChart()
Legt den Diagrammtyp auf „Balkendiagramm“ fest und gibt ein EmbeddedBarChartBuilder
zurück.
Return
EmbeddedBarChartBuilder
: Ein Builder für ein Balkendiagramm
asColumnChart()
Legt den Diagrammtyp auf ColumnChart fest und gibt ein EmbeddedColumnChartBuilder
zurück.
Return
EmbeddedColumnChartBuilder
– ein Builder für ein Säulendiagramm
asComboChart()
Legt den Diagrammtyp auf ComboChart fest und gibt ein EmbeddedComboChartBuilder
zurück.
Return
EmbeddedComboChartBuilder
: Ein Builder für ein Kombinationsdiagramm
asHistogramChart()
Legt den Diagrammtyp auf HistogramChart fest und gibt ein EmbeddedHistogramChartBuilder
zurück.
Return
EmbeddedHistogramChartBuilder
: Ein Builder für ein Histogrammdiagramm
asLineChart()
Legt den Diagrammtyp auf LineChart fest und gibt ein EmbeddedLineChartBuilder
zurück.
Return
EmbeddedLineChartBuilder
: ein Builder für ein Liniendiagramm
asPieChart()
Legt den Diagrammtyp auf „Kreisdiagramm“ fest und gibt ein EmbeddedPieChartBuilder
zurück.
Return
EmbeddedPieChartBuilder
: Ein Generator für ein Kreisdiagramm
asScatterChart()
Legt den Diagrammtyp auf ScatterChart fest und gibt ein EmbeddedScatterChartBuilder
zurück.
Return
EmbeddedScatterChartBuilder
: Ein Builder für ein Streudiagramm
asTableChart()
Legt den Diagrammtyp auf TableChart fest und gibt ein EmbeddedTableChartBuilder
zurück.
Return
EmbeddedTableChartBuilder
– ein Builder für ein Tabellendiagramm
build()
Erstellt das Diagramm, um alle daran vorgenommenen Änderungen widerzuspiegeln.
Bei dieser Methode wird das Diagramm nicht automatisch über die Tabellenkalkulation gezeichnet. Ein neues Diagramm muss über sheet.insertChart(chart)
eingefügt und ein vorhandenes Diagramm sollte über sheet.updateChart(chart)
aktualisiert werden.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Return
EmbeddedChart
: das erstellte Diagramm, das der Tabelle noch hinzugefügt werden muss
clearRanges()
Entfernt alle Bereiche aus dem Diagramm, das dieser Builder ändert.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This code updates the chart to use only the new ranges while preserving the existing // formatting of the chart. var chart = sheet.getCharts()[0]; var newChart = chart .modify() .clearRanges() .addRange(sheet.getRange("A1:A5")) .addRange(sheet.getRange("B1:B5")) .build(); sheet.updateChart(newChart);
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten
getChartType()
getContainer()
Geben Sie das Diagramm ContainerInfo
zurück, das angibt, wo das Diagramm auf dem Tabellenblatt angezeigt wird.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var 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() var containerInfo = chartBuilder.getContainer(); // Logs the values we 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());
Return
ContainerInfo
: ein Objekt, das die Position des Diagrammcontainers enthält
getRanges()
Gibt eine Kopie der Liste der Bereiche zurück, die derzeit Daten für dieses Diagramm liefern. Verwende addRange(range)
und removeRange(range)
, um diese Liste zu ändern.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(sheet.getRange("A1:B8")) .setPosition(5, 5, 0, 0); var ranges = chartBuilder.getRanges(); // There's only one range as a data source for this chart, // so this logs "A1:B8" for (var i in ranges) { var range = ranges[i]; Logger.log(range.getA1Notation()); }
Return
Range[]
: ein Array von Bereichen, die als Datenquelle für das Diagramm dienen
removeRange(range)
Entfernt den angegebenen Bereich aus dem Diagramm, das dieser Builder ändert. 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. Diese Methode kann nicht verwendet werden, um Werte teilweise aus einem Bereich zu entfernen.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var firstRange = sheet.getRange("A1:B5"); var secondRange = sheet.getRange("A6:B8"); var chartBuilder = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(firstRange) // This range will render 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 // will not be removed, and will not throw an exception chartBuilder.removeRange(firstRange); chartBuilder.removeRange(sheet.getRange("A6:B8")); var chart = chartBuilder.build(); sheet.insertChart(chart);
Parameter
Name | Typ | Beschreibung |
---|---|---|
range | Range | Bereich, der entfernt werden soll |
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten
setChartType(type)
Ändert den Diagrammtyp. Derzeit werden nicht alle eingebetteten Diagrammtypen unterstützt. ChartType
ansehen.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
Name | Typ | Beschreibung |
---|---|---|
type | ChartType | Der Typ, in den dieses Diagramm geändert werden soll. |
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten
setHiddenDimensionStrategy(strategy)
Legt die Strategie für ausgeblendete Zeilen und Spalten fest. Die Standardeinstellung ist IGNORE_ROWS
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var 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 | ChartHiddenDimensionStrategy | Die für ausgeblendete Zeilen und Spalten zu verwendende Strategie. |
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten
setMergeStrategy(mergeStrategy)
Legt die Zusammenführungsstrategie fest, die verwendet werden soll, wenn mehrere Bereiche vorhanden sind. Wenn MERGE_ROWS
, werden Zeilen zusammengeführt, bei MERGE_COLUMNS
werden Spalten zusammengeführt. Die Standardeinstellung ist MERGE_COLUMNS
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B10"); var range2 = sheet.getRange("C:C10"); var 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 |
---|---|---|
mergeStrategy | ChartMergeStrategy | Die zu verwendende Zusammenführungsstrategie. |
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten
setNumHeaders(headers)
Legt die Anzahl der Zeilen oder Spalten des Bereichs fest, die als Kopfzeilen behandelt werden sollen.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var 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 Kopfzeilen behandelt werden sollen. Negative Werte führen dazu, dass Header automatisch erkannt werden. |
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten
setOption(option, value)
Legt erweiterte Optionen für dieses Diagramm fest. Eine Liste der verfügbaren Optionen finden Sie unter Diagrammkonfigurationsoptionen.
Diese Methode prüft nicht, ob die von Ihnen 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.
builder.setOption('title', 'Earnings projections'); builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});
Parameter
Name | Typ | Beschreibung |
---|---|---|
option | String | Der Name der Option. |
value | Object | Der Wert der Option. |
Return
EmbeddedChartBuilder
: Dieser Builder für Verkettungen.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Legt die Position fest, wobei die Position des Diagramms auf dem Tabellenblatt geändert wird. anchorRowPos
und anchorColPos
sind 1-indexiert.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var chart = sheet.newChart() .setChartType(Charts.ChartType.BAR) .addRange(range) .setPosition(5, 5, 0, 0) .build(); sheet.insertChart(chart);
Parameter
Name | Typ | Beschreibung |
---|---|---|
anchorRowPos | Integer | Die obere Seite des Diagramms ist in dieser Zeile verankert. |
anchorColPos | Integer | Die linke Seite des Diagramms ist in dieser Spalte verankert. |
offsetX | Integer | Die obere rechte Ecke des Diagramms ist um diese Anzahl Pixel verschoben. |
offsetY | Integer | Die linke untere Ecke des Diagramms ist um diese Anzahl Pixel verschoben. |
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten
setTransposeRowsAndColumns(transpose)
Legt fest, ob die Zeilen und Spalten des Diagramms transponiert werden sollen. Wenn true
festgelegt ist, werden die Zeilen und Spalten vertauscht. Die Standardeinstellung ist false
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B5"); var 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 zum Erstellen des Diagramms verwendeten Zeilen und Spalten transponiert. |
Return
EmbeddedChartBuilder
– dieser Builder zum Verketten