Class EmbeddedChart

EingebettetesDiagramm

Stellt ein Diagramm dar, das in eine Tabelle eingebettet wurde.

In diesem Beispiel wird gezeigt, wie Sie ein vorhandenes Diagramm ändern: 

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A2: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);

In diesem Beispiel wird gezeigt, wie ein neues Diagramm erstellt wird: 

function newChart(range) {
  const sheet = SpreadsheetApp.getActiveSheet();
  const chartBuilder = sheet.newChart();
  chartBuilder.addRange(range)
      .setChartType(Charts.ChartType.LINE)
      .setOption('title', 'My Line Chart!');
  sheet.insertChart(chartBuilder.build());
}

Methoden

MethodeRückgabetypKurzbeschreibung
asDataSourceChart()DataSourceChartWandelt in eine Datenquellendiagramm-Instanz um, wenn das Diagramm ein Datenquellendiagramm ist, andernfalls null.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getChartId()IntegerGibt eine stabile Kennung für das Diagramm zurück, die in der Tabelle, die das Diagramm enthält, eindeutig ist, oder null, wenn sich das Diagramm nicht in einer Tabelle befindet.
getContainerInfo()ContainerInfoGibt Informationen dazu zurück, wo sich das Diagramm in einem Tabellenblatt befindet.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyGibt die Strategie zurück, die für den Umgang mit ausgeblendeten Zeilen und Spalten verwendet werden soll.
getMergeStrategy()ChartMergeStrategyGibt die Zusammenführungsstrategie zurück, die verwendet wird, wenn mehr als ein Bereich vorhanden ist.
getNumHeaders()IntegerGibt die Anzahl der Zeilen oder Spalten des Bereichs zurück, die als Überschriften behandelt werden.
getOptions()ChartOptionsGibt die Optionen für dieses Diagramm zurück, z. B. Höhe, Farben und Achsen.
getRanges()Range[]Gibt die Bereiche zurück, die in diesem Diagramm als Datenquelle verwendet werden.
getTransposeRowsAndColumns()BooleanWenn true, werden die Zeilen und Spalten, die zum Erstellen des Diagramms verwendet werden, vertauscht.
modify()EmbeddedChartBuilderGibt ein EmbeddedChartBuilder zurück, mit dem dieses Diagramm geändert werden kann.

Detaillierte Dokumentation

asDataSourceChart()

Wandelt in eine Datenquellendiagramm-Instanz um, wenn das Diagramm ein Datenquellendiagramm ist, andernfalls null.

Rückflug

DataSourceChart: Das Datenquellendiagramm.

getAs(contentType)

Gibt die Daten in diesem Objekt als Blob zurück, das in den angegebenen Inhaltstyp konvertiert wurde. Bei dieser Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. „meine_datei.pdf“. Dabei wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt folgt (falls vorhanden), eine vorhandene Erweiterung ist, die ersetzt werden soll. Folglich wird aus „ShoppingList.12.25.2014“ „ShoppingList.12.25.pdf“.

Die täglichen Kontingente für Conversions finden Sie unter Kontingente für Google-Dienste. Für neu erstellte Google Workspace-Domains gelten möglicherweise vorübergehend strengere Kontingente.

Parameter

NameTypBeschreibung
contentTypeStringDer MIME-Typ, in den konvertiert werden soll. Für die meisten Blobs ist 'application/pdf' die einzige gültige Option. Für Bilder im BMP-, GIF-, JPEG- oder PNG-Format sind auch 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' gültig. Für ein Google Docs-Dokument ist auch 'text/markdown' gültig.

Rückflug

Blob: Die Daten als Blob.

getBlob()

Gibt die Daten in diesem Objekt als Blob zurück.

Rückflug

Blob: Die Daten als Blob.

getChartId()

Gibt eine stabile Kennung für das Diagramm zurück, die in der Tabelle, die das Diagramm enthält, eindeutig ist, oder null, wenn sich das Diagramm nicht in einer Tabelle befindet.

Rückflug

Integer: Eine stabile Diagramm-ID.

getContainerInfo()

Gibt Informationen dazu zurück, wo sich das Diagramm in einem Tabellenblatt befindet. 

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

const containerInfo = chart.getContainerInfo();

// 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.

getHiddenDimensionStrategy()

Gibt die Strategie zurück, die für den Umgang mit ausgeblendeten 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();

// Logs the strategy to use for hidden rows and columns which is
// Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS in this case.
Logger.log(chart.getHiddenDimensionStrategy());

Rückflug

ChartHiddenDimensionStrategy: Die Strategie, die für ausgeblendete Zeilen und Spalten verwendet werden soll.

getMergeStrategy()

Gibt die Zusammenführungsstrategie zurück, die verwendet wird, wenn mehr als ein Bereich vorhanden ist. 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('C1:C10');
const chart = sheet.newChart()
                  .setChartType(Charts.ChartType.BAR)
                  .addRange(range)
                  .addRange(range2)
                  .setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS)
                  .setPosition(5, 5, 0, 0)
                  .build();

// Logs whether rows of multiple ranges are merged, which is MERGE_ROWS in this
// case.
Logger.log(chart.getMergeStrategy());

Rückflug

ChartMergeStrategy – MERGE_ROWS, wenn Zeilen über mehrere Bereiche hinweg zusammengeführt werden; MERGE_COLUMNS, wenn Spalten über mehrere Bereiche hinweg zusammengeführt werden.

getNumHeaders()

Gibt die Anzahl der Zeilen oder Spalten des Bereichs zurück, die als Überschriften behandelt 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)
                  .setNumHeaders(1)
                  .setPosition(5, 5, 0, 0)
                  .build();

// Logs the number of rows or columns to use as headers, which is 1 in this
// case.
Logger.log(chart.getHeaders());

Rückflug

Integer: Die Anzahl der Zeilen oder Spalten, die als Header behandelt werden. Negative Werte geben an, dass die Header automatisch erkannt werden.

getOptions()

Gibt die Optionen für dieses Diagramm zurück, z. B. Höhe, Farben und Achsen.

Die zurückgegebenen Optionen sind unveränderlich.

Rückflug

ChartOptions – Die Optionen für dieses Diagramm, z. B. Höhe, Farben und Achsen.

getRanges()

Gibt die Bereiche zurück, die in diesem Diagramm als Datenquelle verwendet werden. 

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

const ranges = chart.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 dieses Diagramm dienen.

getTransposeRowsAndColumns()

Wenn true, werden die Zeilen und Spalten, die zum Erstellen des Diagramms verwendet werden, vertauscht. Die Standardeinstellung ist false. 

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('A1:B5');
const chart = sheet.newChart()
                  .addRange(range)
                  .setChartType(Charts.ChartType.BAR)
                  .setTransposeRowsAndColumns(true)
                  .setPosition(5, 5, 0, 0)
                  .build();

// Logs whether rows and columns should be transposed, which is true in this
// case.
Logger.log(chart.getTransposeRowsAndColumns());

Rückflug

Boolean – True, wenn die zum Erstellen des Diagramms verwendeten Zeilen und Spalten transponiert werden.

modify()

Gibt ein EmbeddedChartBuilder zurück, mit dem dieses Diagramm geändert werden kann. Rufen Sie sheet.updateChart(chart) auf, um die Änderungen zu speichern. 

const sheet = SpreadsheetApp.getActiveSheet();
let chart = sheet.getCharts()[0];
chart = chart.modify()
            .setOption('width', 800)
            .setOption('height', 640)
            .setPosition(5, 5, 0, 0)
            .build();
sheet.updateChart(chart);

Rückflug

EmbeddedChartBuilder: Ein Builder zum Erstellen eingebetteter Diagramme.