Class EmbeddedChartBuilder

EmbeddedChartBuilder

Builder yang digunakan untuk mengedit EmbeddedChart. Perubahan yang dibuat pada diagram tidak disimpan hingga Sheet.updateChart(chart) dipanggil pada diagram yang dibuat ulang.

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addRange(range)EmbeddedChartBuilderMenambahkan rentang ke diagram yang diubah oleh builder ini.
asAreaChart()EmbeddedAreaChartBuilderMenetapkan jenis diagram ke AreaChart dan menampilkan EmbeddedAreaChartBuilder.
asBarChart()EmbeddedBarChartBuilderMenetapkan jenis diagram ke BarChart dan menampilkan EmbeddedBarChartBuilder.
asColumnChart()EmbeddedColumnChartBuilderMenetapkan jenis diagram ke ColumnChart dan menampilkan EmbeddedColumnChartBuilder.
asComboChart()EmbeddedComboChartBuilderMenetapkan jenis diagram ke KomboChart dan menampilkan EmbeddedComboChartBuilder.
asHistogramChart()EmbeddedHistogramChartBuilderMenetapkan jenis diagram ke HistogramChart dan menampilkan EmbeddedHistogramChartBuilder.
asLineChart()EmbeddedLineChartBuilderMenetapkan jenis diagram ke LineChart dan menampilkan EmbeddedLineChartBuilder.
asPieChart()EmbeddedPieChartBuilderMenetapkan jenis diagram ke PieChart dan menampilkan EmbeddedPieChartBuilder.
asScatterChart()EmbeddedScatterChartBuilderMenetapkan jenis diagram ke ScatterChart dan menampilkan EmbeddedScatterChartBuilder.
asTableChart()EmbeddedTableChartBuilderMenetapkan jenis diagram ke TableChart dan menampilkan EmbeddedTableChartBuilder.
build()EmbeddedChartMembuat diagram untuk mencerminkan semua perubahan yang dibuat pada diagram.
clearRanges()EmbeddedChartBuilderMenghapus semua rentang dari diagram yang diubah oleh builder ini.
getChartType()ChartTypeMenampilkan jenis diagram saat ini.
getContainer()ContainerInfoTampilkan diagram ContainerInfo, yang mengenkapsulasi tempat diagram muncul pada sheet.
getRanges()Range[]Menampilkan salinan daftar rentang yang saat ini menyediakan data untuk diagram ini.
removeRange(range)EmbeddedChartBuilderMenghapus rentang yang ditentukan dari diagram yang dimodifikasi oleh builder ini.
setChartType(type)EmbeddedChartBuilderMengubah jenis diagram.
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilderMenetapkan strategi yang akan digunakan untuk baris dan kolom tersembunyi.
setMergeStrategy(mergeStrategy)EmbeddedChartBuilderMenetapkan strategi penggabungan yang akan digunakan saat terdapat lebih dari satu rentang.
setNumHeaders(headers)EmbeddedChartBuilderMenetapkan jumlah baris atau kolom rentang yang harus diperlakukan sebagai header.
setOption(option, value)EmbeddedChartBuilderMenetapkan opsi lanjutan untuk diagram ini.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilderMenetapkan posisi, mengubah lokasi kemunculan diagram pada sheet.
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilderMenetapkan apakah baris dan kolom diagram ditransposisikan.

Dokumentasi mendetail

addRange(range)

Menambahkan rentang ke diagram yang diubah oleh builder ini. Tidak menambahkan rentang jika sudah ditambahkan ke diagram.

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

NamaJenisDeskripsi
rangeRangeRentang yang akan ditambahkan.

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai


asAreaChart()

Menetapkan jenis diagram ke AreaChart dan menampilkan EmbeddedAreaChartBuilder.

Return

EmbeddedAreaChartBuilder — builder untuk diagram area


asBarChart()

Menetapkan jenis diagram ke BarChart dan menampilkan EmbeddedBarChartBuilder.

Return

EmbeddedBarChartBuilder — builder untuk diagram batang


asColumnChart()

Menetapkan jenis diagram ke ColumnChart dan menampilkan EmbeddedColumnChartBuilder.

Return

EmbeddedColumnChartBuilder — builder untuk diagram kolom


asComboChart()

Menetapkan jenis diagram ke KomboChart dan menampilkan EmbeddedComboChartBuilder.

Return

EmbeddedComboChartBuilder — builder untuk diagram kombinasi


asHistogramChart()

Menetapkan jenis diagram ke HistogramChart dan menampilkan EmbeddedHistogramChartBuilder.

Return

EmbeddedHistogramChartBuilder — builder untuk diagram histogram


asLineChart()

Menetapkan jenis diagram ke LineChart dan menampilkan EmbeddedLineChartBuilder.

Return

EmbeddedLineChartBuilder — builder untuk diagram garis


asPieChart()

Menetapkan jenis diagram ke PieChart dan menampilkan EmbeddedPieChartBuilder.

Return

EmbeddedPieChartBuilder — builder untuk diagram lingkaran


asScatterChart()

Menetapkan jenis diagram ke ScatterChart dan menampilkan EmbeddedScatterChartBuilder.

Return

EmbeddedScatterChartBuilder — builder untuk diagram sebar


asTableChart()

Menetapkan jenis diagram ke TableChart dan menampilkan EmbeddedTableChartBuilder.

Return

EmbeddedTableChartBuilder — builder untuk diagram tabel


build()

Membuat diagram untuk mencerminkan semua perubahan yang dibuat pada diagram.

Metode ini tidak secara otomatis menggambar bagan di atas {i>spreadsheet<i}. Diagram baru harus disisipkan melalui sheet.insertChart(chart), dan diagram yang ada harus diperbarui melalui sheet.updateChart(chart).

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

Return

EmbeddedChart — diagram yang dibuat, yang tetap harus ditambahkan ke spreadsheet


clearRanges()

Menghapus semua rentang dari diagram yang diubah oleh builder ini.

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

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai


getChartType()

Menampilkan jenis diagram saat ini.

Return

ChartType — jenis diagram


getContainer()

Tampilkan diagram ContainerInfo, yang mengenkapsulasi tempat diagram muncul pada sheet.

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

Return

ContainerInfo — objek yang berisi posisi penampung diagram


getRanges()

Menampilkan salinan daftar rentang yang saat ini menyediakan data untuk diagram ini. Gunakan addRange(range) dan removeRange(range) untuk mengubah daftar ini.

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

Return

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


removeRange(range)

Menghapus rentang yang ditentukan dari diagram yang dimodifikasi oleh builder ini. Tidak menampilkan {i>error<i} jika rentang tidak ada dalam diagram ini.

Rentang yang dihapus harus cocok dengan rentang yang ditambahkan melalui addRange(range); jika tidak, tidak ada perubahan yang dilakukan pada diagram. Metode ini tidak dapat digunakan untuk menghapus sebagian nilai dari rentang.

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

NamaJenisDeskripsi
rangeRangeRentang yang akan dihapus.

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai


setChartType(type)

Mengubah jenis diagram. Tidak semua jenis diagram tersemat saat ini didukung. Lihat 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

NamaJenisDeskripsi
typeChartTypeJenis untuk mengubah diagram ini.

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai


setHiddenDimensionStrategy(strategy)

Menetapkan strategi yang akan digunakan untuk baris dan kolom tersembunyi. Default-nya adalah 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

NamaJenisDeskripsi
strategyChartHiddenDimensionStrategyStrategi yang akan digunakan untuk baris dan kolom tersembunyi.

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai


setMergeStrategy(mergeStrategy)

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

NamaJenisDeskripsi
mergeStrategyChartMergeStrategyStrategi penggabungan yang akan digunakan.

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai


setNumHeaders(headers)

Menetapkan jumlah baris atau kolom rentang yang harus diperlakukan sebagai header.

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

NamaJenisDeskripsi
headersIntegerJumlah baris atau kolom yang akan diperlakukan sebagai {i>header<i}. Nilai negatif menyebabkan header terdeteksi secara otomatis.

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai


setOption(option, value)

Menetapkan opsi lanjutan untuk diagram ini. Untuk melihat daftar opsi yang tersedia, lihat Opsi konfigurasi diagram.

Metode ini tidak memvalidasi bahwa opsi yang Anda tentukan valid untuk jenis diagram ini atau jika nilainya memiliki format/struktur yang benar.

Contoh ini menunjukkan cara mengubah judul dan menetapkan legenda.

builder.setOption('title', 'Earnings projections');
builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});

Parameter

NamaJenisDeskripsi
optionStringNama opsi.
valueObjectNilai opsi.

Return

EmbeddedChartBuilder — Builder ini untuk membuat rantai.


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Menetapkan posisi, mengubah lokasi kemunculan diagram pada sheet. anchorRowPos dan anchorColPos diindeks 1.

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

NamaJenisDeskripsi
anchorRowPosIntegerSisi atas diagram ditambatkan di baris ini.
anchorColPosIntegerSisi kiri diagram ditambatkan pada kolom ini.
offsetXIntegerSudut kanan atas diagram di-offset sebanyak jumlah piksel ini.
offsetYIntegerSudut kiri bawah diagram di-offset sebanyak jumlah piksel ini.

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai


setTransposeRowsAndColumns(transpose)

Menetapkan apakah baris dan kolom diagram ditransposisikan. Jika ditetapkan ke true, baris dan kolom akan diganti. Nilai defaultnya adalah 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

NamaJenisDeskripsi
transposeBooleanJika true, baris dan kolom yang digunakan untuk membuat diagram akan ditransposisikan.

Return

EmbeddedChartBuilder — builder ini, untuk membuat rantai