Class EmbeddedChart

EingebettetesDiagramm

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

In diesem Beispiel wird gezeigt, wie ein vorhandenes Diagramm geändert wird:

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 Sie ein neues Diagramm erstellen:

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()DataSourceChartWird in eine Datenquellendiagramm-Instanz umgewandelt, wenn es sich um ein Datenquellendiagramm handelt, andernfalls in null.
getAs(contentType)BlobGibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde.
getBlob()BlobGibt die Daten in diesem Objekt als Blob zurück.
getChartId()IntegerGibt eine eindeutige Kennung für das Diagramm zurück, die in der gesamten Tabelle, in der sich das Diagramm befindet, eindeutig ist. Wenn das Diagramm nicht in einer Tabelle enthalten ist, wird null zurückgegeben.
getContainerInfo()ContainerInfoGibt Informationen dazu zurück, wo sich das Diagramm in einem Tabellenblatt befindet.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyGibt die Strategie zurück, die für die Verarbeitung ausgeblendeter Zeilen und Spalten verwendet werden soll.
getMergeStrategy()ChartMergeStrategyGibt die Zusammenführungsstrategie zurück, die verwendet wird, wenn mehrere Bereiche vorhanden sind.
getNumHeaders()IntegerGibt die Anzahl der Zeilen oder Spalten im Bereich 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 Ausfüllen des Diagramms verwendet werden, vertauscht.
modify()EmbeddedChartBuilderGibt eine EmbeddedChartBuilder zurück, mit der dieses Diagramm geändert werden kann.

Detaillierte Dokumentation

asDataSourceChart()

Wird in eine Datenquellendiagramm-Instanz umgewandelt, wenn es sich um ein Datenquellendiagramm handelt, andernfalls in null.

Rückflug

DataSourceChart: Das Datenquellendiagramm.


getAs(contentType)

Gibt die Daten in diesem Objekt als Blob zurück, der in den angegebenen Inhaltstyp konvertiert wurde. Bei dieser Methode wird dem Dateinamen die entsprechende Erweiterung hinzugefügt, z. B. „meinedatei.pdf“. Es wird jedoch davon ausgegangen, dass der Teil des Dateinamens, der auf den letzten Punkt (falls vorhanden) folgt, eine vorhandene Erweiterung ist, die ersetzt werden soll. Daraus wird „Einkaufsliste.25.12.2014“ zu „Einkaufsliste.25.12.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. Bei Bildern im BMP-, GIF-, JPEG- oder PNG-Format sind auch 'image/bmp', 'image/gif', 'image/jpeg' oder 'image/png' zulässig. Für ein Google Docs-Dokument ist auch 'text/markdown' zulässig.

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 eindeutige Kennung für das Diagramm zurück, die in der gesamten Tabelle, in der sich das Diagramm befindet, eindeutig ist. Wenn das Diagramm nicht in einer Tabelle enthalten ist, wird null zurückgegeben.

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 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 mit der Position des Diagrammcontainers


getHiddenDimensionStrategy()

Gibt die Strategie zurück, die für die Verarbeitung ausgeblendeter 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 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('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 im Bereich 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 Überschriften 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 können nicht geändert werden.

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 dieses Diagramms dienen


getTransposeRowsAndColumns()

Wenn true, werden die Zeilen und Spalten, die zum Ausfüllen 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

Booleantrue, wenn die Zeilen und Spalten, die zum Erstellen des Diagramms verwendet wurden, transponiert sind.


modify()

Gibt eine EmbeddedChartBuilder zurück, mit der 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