Class EmbeddedChartBuilder

BuilderChartTersemat

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

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

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
addRange(range)	EmbeddedChartBuilder	Menambahkan rentang ke diagram yang diubah oleh builder ini.
asAreaChart()	EmbeddedAreaChartBuilder	Menetapkan jenis diagram ke AreaChart dan menampilkan EmbeddedAreaChartBuilder.
asBarChart()	EmbeddedBarChartBuilder	Menetapkan jenis diagram ke BarChart dan menampilkan EmbeddedBarChartBuilder.
asColumnChart()	EmbeddedColumnChartBuilder	Menetapkan jenis diagram ke ColumnChart dan menampilkan EmbeddedColumnChartBuilder.
asComboChart()	EmbeddedComboChartBuilder	Menetapkan jenis diagram ke ComboChart dan menampilkan EmbeddedComboChartBuilder.
asHistogramChart()	EmbeddedHistogramChartBuilder	Menetapkan jenis diagram ke HistogramChart dan menampilkan EmbeddedHistogramChartBuilder.
asLineChart()	EmbeddedLineChartBuilder	Menetapkan jenis diagram ke LineChart dan menampilkan EmbeddedLineChartBuilder.
asPieChart()	EmbeddedPieChartBuilder	Menetapkan jenis diagram ke PieChart dan menampilkan EmbeddedPieChartBuilder.
asScatterChart()	EmbeddedScatterChartBuilder	Menetapkan jenis diagram ke ScatterChart dan menampilkan EmbeddedScatterChartBuilder.
asTableChart()	EmbeddedTableChartBuilder	Menetapkan jenis diagram ke TableChart dan menampilkan EmbeddedTableChartBuilder.
build()	EmbeddedChart	Membuat diagram untuk mencerminkan semua perubahan yang dilakukan pada diagram tersebut.
clearRanges()	EmbeddedChartBuilder	Menghapus semua rentang dari diagram yang diubah oleh builder ini.
getChartType()	ChartType	Menampilkan jenis diagram saat ini.
getContainer()	ContainerInfo	Menampilkan ContainerInfo diagram, yang mengenkapsulasi tempat diagram muncul di sheet.
getRanges()	Range[]	Menampilkan salinan daftar rentang yang saat ini menyediakan data untuk diagram ini.
removeRange(range)	EmbeddedChartBuilder	Menghapus rentang yang ditentukan dari diagram yang diubah oleh builder ini.
setChartType(type)	EmbeddedChartBuilder	Mengubah jenis diagram.
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	Menetapkan strategi yang akan digunakan untuk baris dan kolom tersembunyi.
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	Menetapkan strategi penggabungan yang akan digunakan jika ada lebih dari satu rentang.
setNumHeaders(headers)	EmbeddedChartBuilder	Menetapkan jumlah baris atau kolom rentang yang harus diperlakukan sebagai header.
setOption(option, value)	EmbeddedChartBuilder	Menetapkan opsi lanjutan untuk diagram ini.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	Menetapkan posisi, mengubah tempat diagram muncul di sheet.
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	Menetapkan apakah baris dan kolom diagram ditransposisi.

Dokumentasi mendetail

addRange(range)

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

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

sheet.insertChart(chart);

Parameter

Nama	Jenis	Deskripsi
range	Range	Rentang yang akan ditambahkan.

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai

---

asAreaChart()

Menetapkan jenis diagram ke AreaChart dan menampilkan EmbeddedAreaChartBuilder.

Pulang pergi

EmbeddedAreaChartBuilder — builder untuk diagram area

---

asBarChart()

Menetapkan jenis diagram ke BarChart dan menampilkan EmbeddedBarChartBuilder.

Pulang pergi

EmbeddedBarChartBuilder — builder untuk diagram batang

---

asColumnChart()

Menetapkan jenis diagram ke ColumnChart dan menampilkan EmbeddedColumnChartBuilder.

Pulang pergi

EmbeddedColumnChartBuilder — builder untuk diagram kolom

---

asComboChart()

Menetapkan jenis diagram ke ComboChart dan menampilkan EmbeddedComboChartBuilder.

Pulang pergi

EmbeddedComboChartBuilder — builder untuk diagram kombinasi

---

asHistogramChart()

Menetapkan jenis diagram ke HistogramChart dan menampilkan EmbeddedHistogramChartBuilder.

Pulang pergi

EmbeddedHistogramChartBuilder — builder untuk diagram histogram

---

asLineChart()

Menetapkan jenis diagram ke LineChart dan menampilkan EmbeddedLineChartBuilder.

Pulang pergi

EmbeddedLineChartBuilder — builder untuk diagram garis

---

asPieChart()

Menetapkan jenis diagram ke PieChart dan menampilkan EmbeddedPieChartBuilder.

Pulang pergi

EmbeddedPieChartBuilder — builder untuk diagram lingkaran

---

asScatterChart()

Menetapkan jenis diagram ke ScatterChart dan menampilkan EmbeddedScatterChartBuilder.

Pulang pergi

EmbeddedScatterChartBuilder — builder untuk diagram sebar

---

asTableChart()

Menetapkan jenis diagram ke TableChart dan menampilkan EmbeddedTableChartBuilder.

Pulang pergi

EmbeddedTableChartBuilder — builder untuk diagram tabel

---

build()

Membuat diagram untuk mencerminkan semua perubahan yang dilakukan pada diagram tersebut.

Metode ini tidak otomatis menggambar diagram di atas spreadsheet. Diagram baru harus disisipkan melalui sheet.insertChart(chart), dan diagram yang ada harus diperbarui melalui sheet.updateChart(chart).

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Pulang pergi

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

---

clearRanges()

Menghapus semua rentang dari diagram yang diubah oleh builder ini.

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

// This code updates the chart to use only the new ranges while preserving the
// existing formatting of the chart.
const chart = sheet.getCharts()[0];
const newChart = chart.modify()
                     .clearRanges()
                     .addRange(sheet.getRange('A1:A5'))
                     .addRange(sheet.getRange('B1:B5'))
                     .build();
sheet.updateChart(newChart);

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai

---

getChartType()

Menampilkan jenis diagram saat ini.

Pulang pergi

ChartType — jenis diagram

---

getContainer()

Menampilkan ContainerInfo diagram, yang mengenkapsulasi tempat diagram muncul di sheet.

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

const 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()
const containerInfo = chartBuilder.getContainer();

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

Pulang pergi

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.

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

const chartBuilder = sheet.newChart()
                         .setChartType(Charts.ChartType.BAR)
                         .addRange(sheet.getRange('A1:B8'))
                         .setPosition(5, 5, 0, 0);

const ranges = chartBuilder.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 yang akan dibuat

---

removeRange(range)

Menghapus rentang yang ditentukan dari diagram yang diubah oleh builder ini. Tidak menampilkan error 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.

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

const firstRange = sheet.getRange('A1:B5');
const secondRange = sheet.getRange('A6:B8');

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

const chart = chartBuilder.build();

sheet.insertChart(chart);

Parameter

Nama	Jenis	Deskripsi
range	Range	Rentang yang akan dihapus.

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai

---

setChartType(type)

Mengubah jenis diagram. Tidak semua jenis diagram tersemat saat ini didukung. Lihat ChartType.

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Parameter

Nama	Jenis	Deskripsi
type	ChartType	Jenis yang akan digunakan untuk mengubah diagram ini.

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai

---

setHiddenDimensionStrategy(strategy)

Menetapkan strategi yang akan digunakan untuk 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();

sheet.insertChart(chart);

Parameter

Nama	Jenis	Deskripsi
strategy	ChartHiddenDimensionStrategy	Strategi yang akan digunakan untuk baris dan kolom tersembunyi.

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai

---

setMergeStrategy(mergeStrategy)

Menetapkan strategi penggabungan yang akan 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('C:C10');
const 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

Nama	Jenis	Deskripsi
mergeStrategy	ChartMergeStrategy	Strategi penggabungan yang akan digunakan.

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai

---

setNumHeaders(headers)

Menetapkan jumlah baris atau kolom rentang yang harus 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();

sheet.insertChart(chart);

Parameter

Nama	Jenis	Deskripsi
headers	Integer	Jumlah baris atau kolom yang akan diperlakukan sebagai header. Nilai negatif menyebabkan header terdeteksi secara otomatis.

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai

---

setOption(option, value)

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

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

Contoh ini menunjukkan cara mengubah judul dan menetapkan legenda.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const sheet = spreadsheet.getSheets()[0];
const chart = sheet.newChart()
 .setOption('title', 'Earnings projections')
 .setOption('legend', {
   position: 'top',
   textStyle: { color: 'blue', fontSize: 16 },
 }).build();

Parameter

Nama	Jenis	Deskripsi
option	String	Nama opsi.
value	Object	Nilai opsi.

Pulang pergi

EmbeddedChartBuilder — Builder ini, untuk pembuatan rantai.

---

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

Menetapkan posisi, mengubah tempat diagram muncul di sheet. anchorRowPos dan anchorColPos diindeks 1.

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)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Parameter

Nama	Jenis	Deskripsi
anchorRowPos	Integer	Sisi atas diagram diatarkan di baris ini.
anchorColPos	Integer	Sisi kiri diagram ditambatkan di kolom ini.
offsetX	Integer	Sudut kanan atas diagram diimbangi dengan jumlah piksel ini.
offsetY	Integer	Sudut kiri bawah diagram diimbangi dengan jumlah piksel ini.

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai

---

setTransposeRowsAndColumns(transpose)

Menetapkan apakah baris dan kolom diagram ditransposisi. Jika ditetapkan ke true, baris dan kolom akan ditukar. Nilai defaultnya adalah false.

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)
                  .setTransposeRowsAndColumns(true)
                  .setPosition(5, 5, 0, 0)
                  .build();

sheet.insertChart(chart);

Parameter

Nama	Jenis	Deskripsi
transpose	Boolean	Jika true, baris dan kolom yang digunakan untuk membuat diagram akan ditransposisi.

Pulang pergi

EmbeddedChartBuilder — builder ini, untuk pembuatan rantai