Builder, der zum Bearbeiten eines EmbeddedChart
verwendet wurde. Am Diagramm vorgenommene Änderungen werden erst gespeichert,
Sheet.updateChart(chart)
wird im neu erstellten Diagramm aufgerufen.
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 einen Bereich hinzu, den dieser Builder ändert. |
asAreaChart() | EmbeddedAreaChartBuilder | Legt den Diagrammtyp auf „Flächendiagramm“ 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 so, dass alle daran vorgenommenen Änderungen widergespiegelt werden |
clearRanges() | EmbeddedChartBuilder | Entfernt alle Bereiche aus dem Diagramm, das dieser Builder ändert. |
getChartType() | ChartType | Gibt den aktuellen Diagrammtyp zurück. |
getContainer() | ContainerInfo | Gibt das Diagramm ContainerInfo zurück. Es enthält die Stelle, an der das Diagramm im
Tabellenblatt. |
getRanges() | Range[] | Gibt eine Kopie der Liste der Bereiche zurück, die derzeit Daten für dieses Diagramm bereitstellen. |
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 mehr als ein Bereich vorhanden ist. |
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 des Diagramms auf dem Tabellenblatt fest. |
setTransposeRowsAndColumns(transpose) | EmbeddedChartBuilder | Legt fest, ob die Zeilen und Spalten des Diagramms transponiert werden. |
Detaillierte Dokumentation
addRange(range)
Fügt dem Diagramm einen Bereich hinzu, den dieser Builder ändert. Der Bereich wird nicht hinzugefügt, wenn er bereits wurden dem Diagramm hinzugefügt.
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 | Der Bereich, der hinzugefügt werden soll. |
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen
asAreaChart()
Legt den Diagrammtyp auf „Flächendiagramm“ fest und gibt ein EmbeddedAreaChartBuilder
zurück.
Rückflug
EmbeddedAreaChartBuilder
: Ein Builder für ein Flächendiagramm
asBarChart()
Legt den Diagrammtyp auf Balkendiagramm 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 Histogrammdiagramm
asLineChart()
Legt den Diagrammtyp auf „LineChart“ fest und gibt ein EmbeddedLineChartBuilder
zurück.
Rückflug
EmbeddedLineChartBuilder
: Builder für ein Liniendiagramm
asPieChart()
Legt den Diagrammtyp auf „Kreisdiagramm“ 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 so, dass alle daran vorgenommenen Änderungen widergespiegelt werden
Bei dieser Methode wird das Diagramm nicht automatisch über der Tabelle gezeichnet. Neues Diagramm
muss über sheet.insertChart(chart)
eingefügt werden und ein vorhandenes Diagramm sollte aktualisiert werden
über sheet.updateChart(chart)
.
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);
Rückflug
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);
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen
getChartType()
getContainer()
Gibt das Diagramm ContainerInfo
zurück. Es enthält die Stelle, an der das Diagramm im
Tabellenblatt.
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());
Rückflug
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 bereitstellen. 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()); }
Rückflug
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. Gibt keinen Fehler aus, wenn der Bereich nicht im 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 zu entfernen
aus einem Bereich.
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 | Der Bereich, der entfernt werden soll. |
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen
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. |
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen
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 Strategie, die für ausgeblendete Zeilen und Spalten verwendet werden soll. |
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen
setMergeStrategy(mergeStrategy)
Legt die Zusammenführungsstrategie fest, die verwendet werden soll, wenn mehr als ein Bereich vorhanden ist. Bei 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. |
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen
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 zu Überschriften automatisch erkannt werden. |
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen
setOption(option, value)
Legt erweiterte Optionen für dieses Diagramm fest. Eine Liste der verfügbaren Optionen finden Sie unter Diagramm Konfigurationsoptionen.
Mit dieser Methode wird nicht bestätigt, dass die von Ihnen angegebene Option für diesen Diagrammtyp gültig ist hat das richtige Format bzw. die richtige Struktur.
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. |
Rückflug
EmbeddedChartBuilder
: Dieser Builder für Verkettungen.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Legt die Position des Diagramms auf dem Tabellenblatt fest. 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 | In dieser Zeile ist der obere Bereich des Diagramms verankert. |
anchorColPos | Integer | In dieser Spalte ist der linke Bereich des Diagramms verankert. |
offsetX | Integer | Die obere rechte Ecke des Diagramms ist um diese Anzahl von Pixeln verschoben. |
offsetY | Integer | Die linke untere Ecke des Diagramms ist um diese Anzahl von Pixeln verschoben. |
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen
setTransposeRowsAndColumns(transpose)
Legt fest, ob die Zeilen und Spalten des Diagramms transponiert werden. 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 | Wenn true , werden die zum Erstellen des Diagramms verwendeten Zeilen und Spalten wie folgt berechnet:
transponiert wurden. |
Rückflug
EmbeddedChartBuilder
– dieser Builder für Verkettungen