Builder zum Bearbeiten einer Embedded
. Änderungen am Diagramm werden erst gespeichert, wenn Sheet.updateChart(chart)
für das neu erstellte Diagramm aufgerufen wird.
const sheet = SpreadsheetApp.getActiveSheet(); const range = sheet.getRange('A1:B8'); let 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 |
---|---|---|
add | Embedded | Fügt dem Diagramm, das dieser Builder ändert, einen Bereich hinzu. |
as | Embedded | Legt den Diagrammtyp auf „Flächendiagramm“ fest und gibt eine Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „BarChart“ fest und gibt eine Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „ColumnChart“ fest und gibt eine Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „Kombinationsdiagramm“ fest und gibt eine Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „Histogrammdiagramm“ fest und gibt eine Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „LineChart“ fest und gibt eine Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „PieChart“ fest und gibt eine Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „ScatterChart“ fest und gibt eine Embedded zurück. |
as | Embedded | Legt den Diagrammtyp auf „Tabellendiagramm“ fest und gibt eine Embedded zurück. |
build() | Embedded | Das Diagramm wird so erstellt, dass alle an ihm vorgenommenen Änderungen berücksichtigt werden. |
clear | Embedded | Entfernt alle Bereiche aus dem Diagramm, das mit diesem Tool geändert wird. |
get | Chart | Gibt den aktuellen Diagrammtyp zurück. |
get | Container | Gibt das Diagramm Container zurück, das angibt, wo das Diagramm auf dem Tabellenblatt angezeigt wird. |
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 mit diesem Builder geändert wird. |
set | Embedded | Ändert den Diagrammtyp. |
set | Embedded | Legt die Strategie fest, die für ausgeblendete Zeilen und Spalten verwendet werden soll. |
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 | Hier legen Sie erweiterte Optionen für dieses Diagramm fest. |
set | Embedded | Hiermit wird die Position festgelegt, an der das Diagramm auf dem Tabellenblatt angezeigt wird. |
set | Embedded | Hiermit wird festgelegt, ob die Zeilen und Spalten des Diagramms transponiert werden. |
Detaillierte Dokumentation
add Range(range)
Fügt dem Diagramm, das dieser Builder ändert, 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 Bereich, der hinzugefügt werden soll. |
Rückflug
Embedded
– dieser Builder, zur Verkettung
as Area Chart()
Legt den Diagrammtyp auf „Flächendiagramm“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Flächendiagramm
as Bar Chart()
Legt den Diagrammtyp auf „BarChart“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Balkendiagramm
as Column Chart()
Legt den Diagrammtyp auf „ColumnChart“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Säulendiagramm
as Combo Chart()
Legt den Diagrammtyp auf „Kombinationsdiagramm“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Kombinationsdiagramm
as Histogram Chart()
Legt den Diagrammtyp auf „Histogrammdiagramm“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Histogrammdiagramm
as Line Chart()
Legt den Diagrammtyp auf „LineChart“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Liniendiagramm
as Pie Chart()
Legt den Diagrammtyp auf „PieChart“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Kreisdiagramm
as Scatter Chart()
Legt den Diagrammtyp auf „ScatterChart“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Streudiagramm
as Table Chart()
Legt den Diagrammtyp auf „Tabellendiagramm“ fest und gibt eine Embedded
zurück.
Rückflug
Embedded
– ein Builder für ein Tabellendiagramm
build()
Das Diagramm wird so erstellt, dass alle an ihm vorgenommenen Änderungen berücksichtigt werden.
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
Embedded
– das erstellte Diagramm, das der Tabelle noch hinzugefügt werden muss
clear Ranges()
Entfernt alle Bereiche aus dem Diagramm, das mit diesem Tool 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
Embedded
– dieser Builder, zur Verkettung
get Chart Type()
get Container()
Gibt das Diagramm Container
zurück, das angibt, wo das Diagramm auf dem Tabellenblatt angezeigt wird.
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
Container
: ein Objekt mit der Position des Diagrammcontainers
get Ranges()
Gibt eine Kopie der Liste der Bereiche zurück, die derzeit Daten für dieses Diagramm liefern. Verwenden Sie add
und remove
, 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
remove Range(range)
Entfernt den angegebenen Bereich aus dem Diagramm, das mit 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 add
hinzugefügt wurde. Andernfalls wird das Diagramm nicht geändert. Mit dieser Methode können keine Werte 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 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')); const chart = chartBuilder.build(); sheet.insertChart(chart);
Parameter
Name | Typ | Beschreibung |
---|---|---|
range | Range | Der Bereich, der entfernt werden soll. |
Rückflug
Embedded
– dieser Builder, zur Verkettung
set Chart Type(type)
Ändert den Diagrammtyp. Derzeit werden nicht alle eingebetteten Diagrammtypen unterstützt. Chart
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 umgewandelt werden soll. |
Rückflug
Embedded
– dieser Builder, zur Verkettung
set Hidden Dimension Strategy(strategy)
Legt die Strategie fest, die für ausgeblendete Zeilen und Spalten verwendet werden soll. 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
Embedded
– dieser Builder, zur Verkettung
set Merge Strategy(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
Embedded
– dieser Builder, zur Verkettung
set Num Headers(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 Überschriften behandelt werden sollen. Bei negativen Werten werden Überschriften automatisch erkannt. |
Rückflug
Embedded
– dieser Builder, zur Verkettung
set Option(option, value)
Hier legen Sie erweiterte Optionen für dieses Diagramm fest. Eine Liste der verfügbaren Optionen finden Sie unter Diagrammkonfigurationsoptionen.
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
Embedded
– Dieser Builder zur Verkettung.
set Position(anchorRowPos, anchorColPos, offsetX, offsetY)
Hiermit wird die Position festgelegt, an der das Diagramm auf dem Tabellenblatt angezeigt wird. anchor
und anchor
beginnen mit 1.
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 ist 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 verschoben. |
offsetY | Integer | Die linke untere Ecke des Diagramms wird um diese Anzahl von Pixeln verschoben. |
Rückflug
Embedded
– dieser Builder, zur Verkettung
set Transpose Rows And Columns(transpose)
Hiermit wird festgelegt, ob die Zeilen und Spalten des Diagramms transponiert werden. Wenn true
festgelegt 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
Embedded
– dieser Builder, zur Verkettung