Class EmbeddedChartBuilder

Eingebettetes Diagramm

Builder zum Bearbeiten eines EmbeddedChart. Änderungen am Diagramm werden erst gespeichert, wenn Sheet.updateChart(chart) im 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

MethodeRückgabetypKurzbeschreibung
addRange(range)EmbeddedChartBuilderFügt dem Diagramm, das dieser Builder ändert, einen Bereich hinzu.
asAreaChart()EmbeddedAreaChartBuilderLegt den Diagrammtyp auf AreaChart fest und gibt einen EmbeddedAreaChartBuilder zurück.
asBarChart()EmbeddedBarChartBuilderLegt den Diagrammtyp auf „BarChart“ fest und gibt einen EmbeddedBarChartBuilder zurück.
asColumnChart()EmbeddedColumnChartBuilderLegt den Diagrammtyp auf „ColumnChart“ fest und gibt EmbeddedColumnChartBuilder zurück.
asComboChart()EmbeddedComboChartBuilderLegt den Diagrammtyp auf „ComboChart“ fest und gibt einen EmbeddedComboChartBuilder zurück.
asHistogramChart()EmbeddedHistogramChartBuilderLegt den Diagrammtyp auf „HistogramChart“ fest und gibt EmbeddedHistogramChartBuilder zurück.
asLineChart()EmbeddedLineChartBuilderLegt den Diagrammtyp auf „LineChart“ fest und gibt einen EmbeddedLineChartBuilder zurück.
asPieChart()EmbeddedPieChartBuilderLegt den Diagrammtyp auf „PieChart“ fest und gibt einen EmbeddedPieChartBuilder zurück.
asScatterChart()EmbeddedScatterChartBuilderLegt den Diagrammtyp auf ScatterChart fest und gibt einen EmbeddedScatterChartBuilder zurück.
asTableChart()EmbeddedTableChartBuilderLegt den Diagrammtyp auf „TableChart“ fest und gibt EmbeddedTableChartBuilder zurück.
build()EmbeddedChartErstellt das Diagramm, um alle daran vorgenommenen Änderungen widerzuspiegeln.
clearRanges()EmbeddedChartBuilderEntfernt alle Bereiche aus dem Diagramm, das von diesem Builder geändert wird.
getChartType()ChartTypeGibt den aktuellen Diagrammtyp zurück.
getContainer()ContainerInfoGibt das Diagramm ContainerInfo zurück, das die Position des Diagramms im Tabellenblatt enthält.
getRanges()Range[]Gibt eine Kopie der Liste der Bereiche zurück, die derzeit Daten für dieses Diagramm enthalten.
removeRange(range)EmbeddedChartBuilderEntfernt den angegebenen Bereich aus dem Diagramm, das von diesem Builder geändert wird.
setChartType(type)EmbeddedChartBuilderÄndert den Diagrammtyp.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderLegt die Strategie fest, die für ausgeblendete Zeilen und Spalten verwendet werden soll.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderLegt die Zusammenführungsstrategie fest, die verwendet wird, wenn mehr als ein Bereich vorhanden ist.
setNumHeaders(headers)EmbeddedChartBuilderLegt die Anzahl der Zeilen oder Spalten des Bereichs fest, die als Header behandelt werden sollen.
setOption(option, value)EmbeddedChartBuilderLegt erweiterte Optionen für dieses Diagramm fest.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderLegt die Position fest und ändert dabei, wo das Diagramm im Tabellenblatt angezeigt wird.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderLegt fest, ob die Zeilen und Spalten des Diagramms transponiert werden.

Detaillierte Dokumentation

addRange(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.

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

NameTypBeschreibung
rangeRangeDer Bereich, der hinzugefügt werden soll.

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten


asAreaChart()

Legt den Diagrammtyp auf AreaChart fest und gibt einen EmbeddedAreaChartBuilder zurück.

Zurücksenden

EmbeddedAreaChartBuilder: ein Builder für ein Flächendiagramm


asBarChart()

Legt den Diagrammtyp auf „BarChart“ fest und gibt einen EmbeddedBarChartBuilder zurück.

Zurücksenden

EmbeddedBarChartBuilder – ein Builder für ein Balkendiagramm


asColumnChart()

Legt den Diagrammtyp auf „ColumnChart“ fest und gibt EmbeddedColumnChartBuilder zurück.

Zurücksenden

EmbeddedColumnChartBuilder: Ein Builder für ein Säulendiagramm


asComboChart()

Legt den Diagrammtyp auf „ComboChart“ fest und gibt einen EmbeddedComboChartBuilder zurück.

Zurücksenden

EmbeddedComboChartBuilder – ein Builder für ein Kombinationsdiagramm


asHistogramChart()

Legt den Diagrammtyp auf „HistogramChart“ fest und gibt EmbeddedHistogramChartBuilder zurück.

Zurücksenden

EmbeddedHistogramChartBuilder: Ein Builder für ein Histogrammdiagramm


asLineChart()

Legt den Diagrammtyp auf „LineChart“ fest und gibt einen EmbeddedLineChartBuilder zurück.

Zurücksenden

EmbeddedLineChartBuilder – ein Builder für ein Liniendiagramm


asPieChart()

Legt den Diagrammtyp auf „PieChart“ fest und gibt einen EmbeddedPieChartBuilder zurück.

Zurücksenden

EmbeddedPieChartBuilder – ein Tool zum Erstellen eines Kreisdiagramms


asScatterChart()

Legt den Diagrammtyp auf ScatterChart fest und gibt einen EmbeddedScatterChartBuilder zurück.

Zurücksenden

EmbeddedScatterChartBuilder – ein Builder für ein Streudiagramm


asTableChart()

Legt den Diagrammtyp auf „TableChart“ fest und gibt EmbeddedTableChartBuilder zurück.

Zurücksenden

EmbeddedTableChartBuilder: Ein Builder für ein Tabellendiagramm


build()

Erstellt das Diagramm, um alle daran vorgenommenen Änderungen widerzuspiegeln.

Mit 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 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);

Zurücksenden

EmbeddedChart: Das erstellte Diagramm, das der Tabelle noch hinzugefügt werden muss


clearRanges()

Entfernt alle Bereiche aus dem Diagramm, das von diesem Builder geändert wird.

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);

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten


getChartType()

Gibt den aktuellen Diagrammtyp zurück.

Zurücksenden

ChartType: Diagrammtyp


getContainer()

Gibt das Diagramm ContainerInfo zurück, das die Position des Diagramms im Tabellenblatt enthält.

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());

Zurücksenden

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 enthalten. Du kannst diese Liste mit addRange(range) und removeRange(range) ä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());
}

Zurücksenden

Range[]: ein Array von Bereichen, die als Diagramm für die Datenquelle dienen, die erstellt werden soll


removeRange(range)

Entfernt den angegebenen Bereich aus dem Diagramm, das von diesem Builder geändert wird. Gibt keinen Fehler aus, 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 keine Werte teilweise aus einem Bereich entfernt werden.

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

NameTypBeschreibung
rangeRangeDer zu entfernende Bereich.

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten


setChartType(type)

Ändert den Diagrammtyp. Derzeit werden nicht alle eingebetteten Diagrammtypen unterstützt. Weitere Informationen finden Sie in den ChartType.

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

NameTypBeschreibung
typeChartTypeDer Typ, in den das Diagramm geändert werden soll.

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten


setHiddenDimensionStrategy(strategy)

Legt die Strategie fest, die für ausgeblendete Zeilen und Spalten verwendet werden soll. 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

NameTypBeschreibung
strategyChartHiddenDimensionStrategyDie für ausgeblendete Zeilen und Spalten zu verwendende Strategie.

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten


setMergeStrategy(mergeStrategy)

Legt die Zusammenführungsstrategie fest, die verwendet wird, 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

NameTypBeschreibung
mergeStrategyChartMergeStrategyDie zu verwendende Zusammenführungsstrategie.

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten


setNumHeaders(headers)

Legt die Anzahl der Zeilen oder Spalten des Bereichs fest, die als Header 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

NameTypBeschreibung
headersIntegerDie Anzahl der Zeilen oder Spalten, die als Header behandelt werden sollen. Negative Werte führen zur automatischen Erkennung von Headern.

Zurücksenden

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 Optionen für die Diagrammkonfiguration.

Mit dieser Methode wird nicht überprüft, ob die angegebene Option für diesen Diagrammtyp gilt und der Wert nicht 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

NameTypBeschreibung
optionStringDer Name der Option.
valueObjectDer Wert der Option.

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Legt die Position fest und ändert dabei, wo das Diagramm im Tabellenblatt angezeigt wird. anchorRowPos und anchorColPos sind mit einem Index versehen.

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

NameTypBeschreibung
anchorRowPosIntegerDie obere Seite des Diagramms ist in dieser Zeile verankert.
anchorColPosIntegerDie linke Seite des Diagramms ist in dieser Spalte verankert.
offsetXIntegerDie obere rechte Ecke des Diagramms wird um diese Anzahl von Pixeln ausgeglichen.
offsetYIntegerDie linke untere Ecke des Diagramms wird um diese Anzahl von Pixeln ausgeglichen.

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten


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

NameTypBeschreibung
transposeBooleanBei true werden die zum Erstellen des Diagramms verwendeten Zeilen und Spalten transponiert.

Zurücksenden

EmbeddedChartBuilder: Dieser Builder zum Verketten