直方圖的建構工具。詳情請參閱 Gviz 說明文件。
方法
內容詳盡的說明文件
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()
將圖表類型設為「HistogramChart」,並傳回 EmbeddedHistogramChartBuilder
。
回攻員
EmbeddedHistogramChartBuilder
:直方圖的建構工具
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
:這個建構工具用於鏈結
reverseCategories()
反轉網域軸上的序列繪圖。如果是垂直範圍的圖表 (例如折線、 區域或柱狀圖),這表示水平軸是從右到左繪製。適用對象 水平範圍圖表 (例如長條圖),這表示垂直軸是從頂端到 底部。如果是圓餅圖,這表示系統會逆時針繪製切片。
// Creates a pie chart builder and sets drawing of the slices in a counter-clockwise manner. var builder = Charts.newPieChart(); builder.reverseCategories();
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setBackgroundColor(cssValue)
設定圖表的背景顏色。
// Creates a line chart builder and sets the background color to gray var builder = Charts.newLineChart(); builder.setBackgroundColor("gray");
參數
名稱 | 類型 | 說明 |
---|---|---|
cssValue | String | 顏色的 CSS 值 (例如 "blue" 或 "#00f" )。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
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
:這個建構工具用於鏈結
setColors(cssValues)
設定圖表線條的顏色。
// Creates a line chart builder and sets the first two lines to be drawn in green and red, // respectively. var builder = Charts.newLineChart(); builder.setColors(["green", "red"]);
參數
名稱 | 類型 | 說明 |
---|---|---|
cssValues | String[] | 顏色 CSS 值的陣列,例如 ["red", "#acf"] 。第 n 個元素
在陣列中,代表圖表中第 n 條的顏色。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
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
:這個建構工具用於鏈結
setLegendPosition(position)
設定與圖表相關的圖例位置。根據預設,系統沒有圖例。
// Creates a line chart builder and sets the legend position to right. var builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);
參數
名稱 | 類型 | 說明 |
---|---|---|
position | Position | 圖例的位置。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setLegendTextStyle(textStyle)
設定圖表圖例的文字樣式。
// Creates a line chart builder and sets it up for a blue, 26-point legend. var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); var style = textStyleBuilder.build(); var builder = Charts.newLineChart(); builder.setLegendTextStyle(style);
參數
名稱 | 類型 | 說明 |
---|---|---|
textStyle | TextStyle | 用於圖表圖例的文字樣式。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
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
:這個建構工具用於鏈結
setRange(start, end)
設定圖表的範圍。
如有任何資料點超出範圍,系統會擴大範圍以納入這些資料 點。
參數
名稱 | 類型 | 說明 |
---|---|---|
start | Number | 範圍軸最低網格線的值。 |
end | Number | 範圍軸最高格線線的值。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setStacked()
setTitle(chartTitle)
設定圖表的標題。標題會顯示在圖表上方。
// Creates a line chart builder and title to 'My Line Chart'. var builder = Charts.newLineChart(); builder.setTitle('My Line Chart')
參數
名稱 | 類型 | 說明 |
---|---|---|
chartTitle | String | 圖表標題 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setTitleTextStyle(textStyle)
設定圖表標題的文字樣式。
// Creates a line chart builder and sets it up for a blue, 26-point title. var textStyleBuilder = Charts.newTextStyle().setColor('#0000FF').setFontSize(26); var style = textStyleBuilder.build(); var builder = Charts.newLineChart(); builder.setTitleTextStyle(style);
參數
名稱 | 類型 | 說明 |
---|---|---|
textStyle | TextStyle | 用於圖表標題的文字樣式。您可以呼叫 Charts.newTextStyle() 來建立 TextStyleBuilder 物件。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
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
:這個建構工具用於鏈結
setXAxisTextStyle(textStyle)
設定橫軸的文字樣式。
// Creates a line chart builder and sets the X-axis text style to blue, 18-point font. var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); var builder = Charts.newLineChart(); builder.setXAxisTextStyle(textStyle);
參數
名稱 | 類型 | 說明 |
---|---|---|
textStyle | TextStyle | 用於橫軸標題的文字樣式。您可以呼叫 Charts.newTextStyle() 來建立 TextStyleBuilder 物件。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setXAxisTitle(title)
為橫軸加上標題。標題會置中,並顯示在軸值下方 標籤
// Creates a line chart builder and sets the X-axis title. var builder = Charts.newLineChart(); builder.setTitle('X-axis Title')
參數
名稱 | 類型 | 說明 |
---|---|---|
title | String | X 軸的標題。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setXAxisTitleTextStyle(textStyle)
設定橫軸標題文字樣式。
// Creates a line chart builder and sets the X-axis title text style to blue, 18-point font. var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); var builder = Charts.newLineChart(); builder.setXAxisTitleTextStyle(textStyle);
參數
名稱 | 類型 | 說明 |
---|---|---|
textStyle | TextStyle | 用於橫軸標題的文字樣式。您可以呼叫 Charts.newTextStyle() 來建立 TextStyleBuilder 物件。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setYAxisTextStyle(textStyle)
設定縱軸的文字樣式。
// Creates a line chart builder and sets the Y-axis text style to blue, 18-point font. var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); var builder = Charts.newLineChart(); builder.setYAxisTextStyle(textStyle);
參數
名稱 | 類型 | 說明 |
---|---|---|
textStyle | TextStyle | 用於橫軸標題的文字樣式。您可以呼叫 Charts.newTextStyle() 來建立 TextStyleBuilder 物件。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setYAxisTitle(title)
為縱軸加入標題。標題會置中,並顯示在值的左側 標籤
// Creates a line chart builder and sets the Y-axis title. var builder = Charts.newLineChart(); builder.setYAxisTitle('Y-axis Title')
參數
名稱 | 類型 | 說明 |
---|---|---|
title | String | Y 軸的標題。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
setYAxisTitleTextStyle(textStyle)
設定縱軸標題文字樣式。
// Creates a line chart builder and sets the Y-axis title text style to blue, 18-point font. var textStyle = Charts.newTextStyle().setColor('blue').setFontSize(18).build(); var builder = Charts.newLineChart(); builder.setYAxisTitleTextStyle(textStyle);
參數
名稱 | 類型 | 說明 |
---|---|---|
textStyle | TextStyle | 用於橫軸標題的文字樣式。您可以呼叫 Charts.newTextStyle() 來建立 TextStyleBuilder 物件。 |
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。
useLogScale()
將範圍軸設為對數尺度 (所有值都必須為正數)。範圍 軸是垂直圖表 (例如折線、面積或柱) 的垂直軸, 水平圖表 (例如長條圖) 上的水平軸。
回攻員
EmbeddedHistogramChartBuilder
:這項建構工具適用於鏈結。