Class EmbeddedChart

DiagramTersemat

Menampilkan diagram yang telah disematkan ke dalam spreadsheet.

Contoh ini menunjukkan cara mengubah diagram yang ada:

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

Contoh ini menunjukkan cara membuat diagram baru:

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
asDataSourceChart()DataSourceChartMentransmisikan ke instance diagram sumber data jika diagram adalah diagram sumber data, atau null jika tidak.
getAs(contentType)BlobMenampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan.
getBlob()BlobMenampilkan data di dalam objek ini sebagai blob.
getChartId()IntegerMenampilkan ID stabil untuk diagram yang unik di seluruh spreadsheet yang berisi diagram atau null jika diagram tidak ada dalam spreadsheet.
getContainerInfo()ContainerInfoMenampilkan informasi tentang posisi diagram dalam sheet.
getHiddenDimensionStrategy()ChartHiddenDimensionStrategyMenampilkan strategi yang akan digunakan untuk menangani baris dan kolom tersembunyi.
getMergeStrategy()ChartMergeStrategyMenampilkan strategi penggabungan yang digunakan jika ada lebih dari satu rentang.
getNumHeaders()IntegerMenampilkan jumlah baris atau kolom rentang yang diperlakukan sebagai header.
getOptions()ChartOptionsMenampilkan opsi untuk diagram ini, seperti tinggi, warna, dan sumbu.
getRanges()Range[]Menampilkan rentang yang digunakan diagram ini sebagai sumber data.
getTransposeRowsAndColumns()BooleanJika true, baris dan kolom yang digunakan untuk mengisi diagram akan ditukar.
modify()EmbeddedChartBuilderMenampilkan EmbeddedChartBuilder yang dapat digunakan untuk mengubah diagram ini.

Dokumentasi mendetail

asDataSourceChart()

Mentransmisikan ke instance diagram sumber data jika diagram adalah diagram sumber data, atau null jika tidak.

Pulang pergi

DataSourceChart — Diagram sumber data.


getAs(contentType)

Menampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan. Metode ini menambahkan ekstensi yang sesuai ke nama file—misalnya, "myfile.pdf". Namun, hal ini menganggap bahwa bagian nama file yang mengikuti titik terakhir (jika ada) adalah ekstensi yang ada dan harus diganti. Akibatnya, "ShoppingList.12.25.2014" menjadi "ShoppingList.12.25.pdf".

Untuk melihat kuota harian konversi, lihat Kuota untuk Layanan Google. Domain Google Workspace yang baru dibuat mungkin akan dikenai kuota yang lebih ketat untuk sementara.

Parameter

NamaJenisDeskripsi
contentTypeStringJenis MIME yang akan dikonversi. Untuk sebagian besar blob, 'application/pdf' adalah satu-satunya opsi yang valid. Untuk gambar dalam format BMP, GIF, JPEG, atau PNG, 'image/bmp', 'image/gif', 'image/jpeg', atau 'image/png' juga valid. Untuk dokumen Google Dokumen, 'text/markdown' juga valid.

Pulang pergi

Blob — Data sebagai blob.


getBlob()

Menampilkan data di dalam objek ini sebagai blob.

Pulang pergi

Blob — Data sebagai blob.


getChartId()

Menampilkan ID stabil untuk diagram yang unik di seluruh spreadsheet yang berisi diagram atau null jika diagram tidak ada dalam spreadsheet.

Pulang pergi

Integer — ID diagram yang stabil.


getContainerInfo()

Menampilkan informasi tentang posisi diagram dalam sheet.

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

Pulang pergi

ContainerInfo — objek yang berisi posisi penampung diagram


getHiddenDimensionStrategy()

Menampilkan strategi yang akan digunakan untuk menangani baris dan kolom tersembunyi. Default-nya adalah 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());

Pulang pergi

ChartHiddenDimensionStrategy — Strategi yang akan digunakan untuk baris dan kolom tersembunyi.


getMergeStrategy()

Menampilkan strategi penggabungan yang digunakan jika ada lebih dari satu rentang. Jika MERGE_ROWS, baris akan digabungkan; jika MERGE_COLUMNS, kolom akan digabungkan. Default-nya adalah 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());

Pulang pergi

ChartMergeStrategyMERGE_ROWS jika baris digabungkan di beberapa rentang; MERGE_COLUMNS jika kolom digabungkan di beberapa rentang


getNumHeaders()

Menampilkan jumlah baris atau kolom rentang yang diperlakukan sebagai header.

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

Pulang pergi

Integer — Jumlah baris atau kolom yang diperlakukan sebagai header. Nilai negatif menunjukkan header terdeteksi secara otomatis.


getOptions()

Menampilkan opsi untuk diagram ini, seperti tinggi, warna, dan sumbu.

Opsi yang ditampilkan tidak dapat diubah.

Pulang pergi

ChartOptions — Opsi untuk diagram ini, seperti tinggi, warna, dan sumbu.


getRanges()

Menampilkan rentang yang digunakan diagram ini sebagai sumber data.

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

Pulang pergi

Range[] — array rentang yang berfungsi sebagai sumber data diagram ini


getTransposeRowsAndColumns()

Jika true, baris dan kolom yang digunakan untuk mengisi diagram akan ditukar. Default-nya adalah 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());

Pulang pergi

Booleantrue jika baris dan kolom yang digunakan untuk membuat diagram ditransposisi.


modify()

Menampilkan EmbeddedChartBuilder yang dapat digunakan untuk mengubah diagram ini. Panggil sheet.updateChart(chart) untuk menyimpan perubahan.

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

Pulang pergi

EmbeddedChartBuilder — builder untuk membuat diagram tersemat