用於編輯 EmbeddedChart
的建構工具。您必須先在重建的圖表上呼叫 Sheet.updateChart(chart)
,系統才會儲存對圖表所做的變更。
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);
方法
內容詳盡的說明文件
addRange(range)
將範圍新增至這個建構工具修改的圖表。如果範圍已新增至圖表,則請勿新增該範圍。
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);
參數
名稱 | 類型 | 說明 |
---|---|---|
range | Range | 要新增的範圍。 |
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結
asAreaChart()
asBarChart()
asColumnChart()
asComboChart()
asHistogramChart()
asLineChart()
asPieChart()
asScatterChart()
asTableChart()
build()
建立圖表,以反映所有變更。
這個方法並不會自動在試算表頂端繪製圖表。新圖表必須透過 sheet.insertChart(chart)
插入,且現有圖表必須透過 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);
回攻員
EmbeddedChart
:您建立的圖表,但仍須在試算表中加入
clearRanges()
從這個建構工具修改的圖表中移除所有範圍。
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);
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結
getChartType()
getContainer()
傳回圖表 ContainerInfo
,其中包含圖表上顯示的圖表。
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());
回攻員
ContainerInfo
:包含圖表容器位置的物件
getRanges()
傳回目前提供這張圖表資料的範圍清單副本。請使用 addRange(range)
和 removeRange(range)
修改這個清單。
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()); }
回攻員
Range[]
:範圍陣列,做為建立資料來源的圖表
removeRange(range)
從這個建構工具修改的圖表中移除指定範圍。如果範圍不在這個圖表中,則不會擲回錯誤。
移除的範圍必須與透過 addRange(range)
新增的範圍相符,否則圖表不會有任何變化。您無法使用此方法從範圍部分移除值。
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);
參數
名稱 | 類型 | 說明 |
---|---|---|
range | Range | 要移除的範圍。 |
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結
setChartType(type)
變更圖表類型。目前不支援部分內嵌圖表類型。請見 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);
參數
名稱 | 類型 | 說明 |
---|---|---|
type | ChartType | 圖表要變更的類型。 |
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結
setHiddenDimensionStrategy(strategy)
設定隱藏列和欄採用的策略。這個變數預設為 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);
參數
名稱 | 類型 | 說明 |
---|---|---|
strategy | ChartHiddenDimensionStrategy | 隱藏列和欄採用的策略。 |
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結
setMergeStrategy(mergeStrategy)
設定在存在多個範圍時使用合併策略。如為 MERGE_ROWS
,系統就會合併資料列;如果是 MERGE_COLUMNS
,則會合併資料欄。這個變數預設為 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);
參數
名稱 | 類型 | 說明 |
---|---|---|
mergeStrategy | ChartMergeStrategy | 要使用的合併策略。 |
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結
setNumHeaders(headers)
設定應視為標頭的列數或欄數。
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);
參數
名稱 | 類型 | 說明 |
---|---|---|
headers | Integer | 要視為標題的列數或欄數。負值會使系統自動偵測標頭。 |
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結
setOption(option, value)
設定這張圖表的進階選項。如要查看可用選項的清單,請參閱圖表設定選項。
這個方法不會驗證您指定的選項適用於這個圖表類型,也不會驗證值的格式/結構是否正確無誤。
這個範例說明如何更改標題並設定圖例。
builder.setOption('title', 'Earnings projections'); builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});
參數
名稱 | 類型 | 說明 |
---|---|---|
option | String | 選項的名稱。 |
value | Object | 選項的值。 |
回攻員
EmbeddedChartBuilder
— 這個建構工具用於鏈結。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
設定位置,變更圖表在工作表中的位置。anchorRowPos
和 anchorColPos
已建立索引。
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);
參數
名稱 | 類型 | 說明 |
---|---|---|
anchorRowPos | Integer | 圖表的頂端會固定在這個資料列中。 |
anchorColPos | Integer | 圖表的左側錨定在這一欄。 |
offsetX | Integer | 圖表右上角對齊的像素值。 |
offsetY | Integer | 圖表的左下角會偏移這麼許多像素。 |
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結
setTransposeRowsAndColumns(transpose)
設定圖表的列和欄是否要轉換。如果設為 true
,則會切換資料列和資料欄。這個變數預設為 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);
參數
名稱 | 類型 | 說明 |
---|---|---|
transpose | Boolean | 如果為 true ,則用於建構圖表的資料列與資料欄會轉譯。 |
回攻員
EmbeddedChartBuilder
:這個建構工具用於鏈結