Class EmbeddedScatterChartBuilder

透過集合功能整理內容 你可以依據偏好儲存及分類內容。
EmbeddedScatterChartBuilder

散佈圖的建構工具。詳情請參閱 Gviz 說明文件

方法

方法傳回類型簡短說明
addRange(range)EmbeddedChartBuilder新增這個建構工具修改的圖表範圍。
asAreaChart()EmbeddedAreaChartBuilder將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder
asBarChart()EmbeddedBarChartBuilder將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder
asColumnChart()EmbeddedColumnChartBuilder將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder
asComboChart()EmbeddedComboChartBuilder將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder
asHistogramChart()EmbeddedHistogramChartBuilder將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder
asLineChart()EmbeddedLineChartBuilder將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder
asPieChart()EmbeddedPieChartBuilder將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder
asScatterChart()EmbeddedScatterChartBuilder將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder
asTableChart()EmbeddedTableChartBuilder將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder
build()EmbeddedChart建立圖表以反映該圖表的所有變更。
clearRanges()EmbeddedChartBuilder移除這個建構工具修改的圖表中所有範圍。
getChartType()ChartType傳回目前的圖表類型。
getContainer()ContainerInfo傳回圖表 ContainerInfo,用於封裝圖表在工作表中的位置。
getRanges()Range[]傳回目前提供此圖表資料範圍的清單副本。
removeRange(range)EmbeddedChartBuilder從建構工具修改的圖表中移除指定範圍。
setBackgroundColor(cssValue)EmbeddedScatterChartBuilder設定圖表的背景顏色。
setChartType(type)EmbeddedChartBuilder變更圖表類型。
setColors(cssValues)EmbeddedScatterChartBuilder設定圖表中線條的顏色。
setHiddenDimensionStrategy(strategy)EmbeddedChartBuilder設定用於隱藏列和欄的策略。
setLegendPosition(position)EmbeddedScatterChartBuilder設定圖例相對於圖表的位置。
setLegendTextStyle(textStyle)EmbeddedScatterChartBuilder設定圖表圖例的文字樣式。
setMergeStrategy(mergeStrategy)EmbeddedChartBuilder設定包含多個範圍的合併策略。
setNumHeaders(headers)EmbeddedChartBuilder設定應視為範圍的列數或欄數。
setOption(option, value)EmbeddedChartBuilder設定這張圖表的進階選項。
setPointStyle(style)EmbeddedScatterChartBuilder設定行中的點樣式。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)EmbeddedChartBuilder設定位置,以變更圖表在工作表中的顯示位置。
setTitle(chartTitle)EmbeddedScatterChartBuilder設定圖表的標題。
setTitleTextStyle(textStyle)EmbeddedScatterChartBuilder設定圖表標題的文字樣式。
setTransposeRowsAndColumns(transpose)EmbeddedChartBuilder設定是否傳輸圖表列和欄。
setXAxisLogScale()EmbeddedScatterChartBuilder將水平軸設為對數比例 (要求所有值均為正數)。
setXAxisRange(start, end)EmbeddedScatterChartBuilder設定圖表的水平軸範圍。
setXAxisTextStyle(textStyle)EmbeddedScatterChartBuilder設定水平軸文字樣式。
setXAxisTitle(title)EmbeddedScatterChartBuilder新增水平軸的標題。
setXAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilder設定水平軸標題文字樣式。
setYAxisLogScale()EmbeddedScatterChartBuilder將垂直軸設為對數比例 (要求所有值必須為正數)。
setYAxisRange(start, end)EmbeddedScatterChartBuilder用來設定圖表的垂直軸範圍。
setYAxisTextStyle(textStyle)EmbeddedScatterChartBuilder設定垂直軸文字樣式。
setYAxisTitle(title)EmbeddedScatterChartBuilder在垂直軸中加入標題。
setYAxisTitleTextStyle(textStyle)EmbeddedScatterChartBuilder設定垂直軸標題文字樣式。

內容詳盡的說明文件

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

參數

名稱類型說明
rangeRange要新增的範圍。

Return 鍵

EmbeddedChartBuilder:這個用於鏈結的建構工具


asAreaChart()

將圖表類型設為 AreaChart,並傳回 EmbeddedAreaChartBuilder

Return 鍵

EmbeddedAreaChartBuilder:面積圖的建構工具


asBarChart()

將圖表類型設為 BarChart,並傳回 EmbeddedBarChartBuilder

Return 鍵

EmbeddedBarChartBuilder:長條圖的建構工具


asColumnChart()

將圖表類型設為 ColumnChart,並傳回 EmbeddedColumnChartBuilder

Return 鍵

EmbeddedColumnChartBuilder:柱狀圖的建構工具


asComboChart()

將圖表類型設為 ComboChart,並傳回 EmbeddedComboChartBuilder

Return 鍵

EmbeddedComboChartBuilder:組合圖的建構工具


asHistogramChart()

將圖表類型設為 HistogramChart,並傳回 EmbeddedHistogramChartBuilder

Return 鍵

EmbeddedHistogramChartBuilder:直方圖圖表的建構工具


asLineChart()

將圖表類型設為 LineChart,並傳回 EmbeddedLineChartBuilder

Return 鍵

EmbeddedLineChartBuilder:折線圖的建構工具


asPieChart()

將圖表類型設為 PieChart,並傳回 EmbeddedPieChartBuilder

Return 鍵

EmbeddedPieChartBuilder:圓餅圖建構工具


asScatterChart()

將圖表類型設為 ScatterChart,並傳回 EmbeddedScatterChartBuilder

Return 鍵

EmbeddedScatterChartBuilder:散佈圖的建構工具


asTableChart()

將圖表類型設為 TableChart,並傳回 EmbeddedTableChartBuilder

Return 鍵

EmbeddedTableChartBuilder:表格圖表的建構工具


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

Return 鍵

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

Return 鍵

EmbeddedChartBuilder:這個用於鏈結的建構工具


getChartType()

傳回目前的圖表類型。

Return 鍵

ChartType:圖表類型


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

Return 鍵

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

Return 鍵

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

參數

名稱類型說明
rangeRange要移除的範圍。

Return 鍵

EmbeddedChartBuilder:這個用於鏈結的建構工具


setBackgroundColor(cssValue)

設定圖表的背景顏色。

// Creates a line chart builder and sets the background color to gray
var builder = Charts.newLineChart();
builder.setBackgroundColor("gray");

參數

名稱類型說明
cssValueString顏色的 CSS 值 (例如 "blue""#00f")。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
typeChartType變更這張圖表的類型。

Return 鍵

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

參數

名稱類型說明
cssValuesString[]色彩 CSS 值陣列,例如 ["red", "#acf"]。陣列中的第 0 個元素代表圖表中第 N 行的顏色。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
strategyChartHiddenDimensionStrategy用於隱藏列和欄的策略。

Return 鍵

EmbeddedChartBuilder:這個用於鏈結的建構工具


setLegendPosition(position)

設定圖例相對於圖表的位置。根據預設,沒有圖例。

// Creates a line chart builder and sets the legend position to right.
var builder = Charts.newLineChart();
builder.setLegendPosition(Charts.Position.RIGHT);

參數

名稱類型說明
positionPosition圖例的位置。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
textStyleTextStyle用於圖表圖例的文字樣式。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
mergeStrategyChartMergeStrategy要使用的合併策略。

Return 鍵

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

參數

名稱類型說明
headersInteger要視為標頭的列數或欄數。如果設定負值,即可自動偵測標頭。

Return 鍵

EmbeddedChartBuilder:這個用於鏈結的建構工具


setOption(option, value)

設定這張圖表的進階選項。如要查看可用選項的清單,請參閱圖表設定選項一文。

這個方法不會驗證您指定的選項是否適用於此圖表類型,或者值的格式/格式是否正確。

以下範例說明如何變更標題及設定圖例。

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

參數

名稱類型說明
optionString選項的名稱。
valueObject選項的值。

Return 鍵

EmbeddedChartBuilder — 用於鏈結的建構工具。


setPointStyle(style)

設定行中的點樣式。根據預設,點不含特定樣式,因此只會顯示線條。

// Creates a line chart builder and sets large point style.
var builder = Charts.newLineChart();
builder.setPointStyle(Charts.PointStyle.LARGE);

參數

名稱類型說明
stylePointStyle線條中點數使用的樣式。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。

另請參閱


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

設定位置,以變更圖表在工作表中的顯示位置。anchorRowPosanchorColPos 已建立索引。

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

參數

名稱類型說明
anchorRowPosInteger圖表的上方固定在該列的上方。
anchorColPosInteger圖表的左側會固定在圖表的左側。
offsetXInteger圖表的右上角會覆寫許多像素。
offsetYInteger圖表的左下角與這個像素值偏移。

Return 鍵

EmbeddedChartBuilder:這個用於鏈結的建構工具


setTitle(chartTitle)

設定圖表的標題。標題會顯示在圖表上方的中心。

// Creates a line chart builder and title to 'My Line Chart'.
var builder = Charts.newLineChart();
builder.setTitle('My Line Chart')

參數

名稱類型說明
chartTitleString圖表標題。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
textStyleTextStyle圖表標題的文字樣式。呼叫 Charts.newTextStyle() 即可建立 TextStyleBuilder 物件。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
transposeBoolean如為 true,系統會轉錄用於建構圖表的資料列和資料欄。

Return 鍵

EmbeddedChartBuilder:這個用於鏈結的建構工具


setXAxisLogScale()

將水平軸設為對數比例 (要求所有值均為正數)。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


setXAxisRange(start, end)

設定圖表的水平軸範圍。

如有任何資料點超出範圍,系統就會擴大範圍以納入這些資料點。

// Creates a scatter chart builder and sets the X-axis range to be 0 to 100.
var builder = Charts.newTableChart();
builder.setXAxisRange(0, 100);

參數

名稱類型說明
startNumber水平軸最低格線線值。
endNumber水平軸的最高格線線值。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
textStyleTextStyle水平軸標題的文字樣式。呼叫 Charts.newTextStyle() 即可建立 TextStyleBuilder 物件。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


setXAxisTitle(title)

新增水平軸的標題。標題將置中,並顯示在軸值標籤下方。

// Creates a line chart builder and sets the X-axis title.
var builder = Charts.newLineChart();
builder.setTitle('X-axis Title')

參數

名稱類型說明
titleStringX 軸的標題。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
textStyleTextStyle水平軸標題的文字樣式。呼叫 Charts.newTextStyle() 即可建立 TextStyleBuilder 物件。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


setYAxisLogScale()

將垂直軸設為對數比例 (要求所有值必須為正數)。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


setYAxisRange(start, end)

用來設定圖表的垂直軸範圍。如有任何資料點超出範圍,系統就會擴大範圍以納入這些資料點。

// Creates a scatter chart builder and sets the Y-axis range to be 0 to 100.
var builder = Charts.newTableChart();
builder.setYAxisRange(0, 100);

參數

名稱類型說明
startNumber垂直軸最低格線的值。
endNumber垂直軸最高格線的值。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
textStyleTextStyle水平軸標題的文字樣式。呼叫 Charts.newTextStyle() 即可建立 TextStyleBuilder 物件。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


setYAxisTitle(title)

在垂直軸中加入標題。標題將置中,並且顯示在值標籤的左側。

// Creates a line chart builder and sets the Y-axis title.
var builder = Charts.newLineChart();
builder.setYAxisTitle('Y-axis Title')

參數

名稱類型說明
titleStringY 軸標題。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。


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

參數

名稱類型說明
textStyleTextStyle水平軸標題的文字樣式。呼叫 Charts.newTextStyle() 即可建立 TextStyleBuilder 物件。

Return 鍵

EmbeddedScatterChartBuilder:這個建構工具適用於鏈結。