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将图表类型设置为折线图并返回 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要添加的范围。

返回

EmbeddedChartBuilder - 此构建器,用于链接


asAreaChart()

将图表类型设置为 AreaChart 并返回 EmbeddedAreaChartBuilder

返回

EmbeddedAreaChartBuilder - 面积图的构建器


asBarChart()

将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder

返回

EmbeddedBarChartBuilder - 条形图的构建器


asColumnChart()

将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder

返回

EmbeddedColumnChartBuilder - 柱形图的构建器


asComboChart()

将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder

返回

EmbeddedComboChartBuilder - 组合图表的构建器


asHistogramChart()

将图表类型设置为 HistogramChart 并返回 EmbeddedHistogramChartBuilder

返回

EmbeddedHistogramChartBuilder - 直方图图表的构建器


asLineChart()

将图表类型设置为折线图并返回 EmbeddedLineChartBuilder

返回

EmbeddedLineChartBuilder - 折线图的构建器


asPieChart()

将图表类型设置为 PieChart 并返回 EmbeddedPieChartBuilder

返回

EmbeddedPieChartBuilder - 饼图的构建器


asScatterChart()

将图表类型设置为 ScatterChart 并返回 EmbeddedScatterChartBuilder

返回

EmbeddedScatterChartBuilder - 散点图的构建器


asTableChart()

将图表类型设置为 TableChart 并返回 EmbeddedTableChartBuilder

返回

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

返回

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

返回当前图表类型。

返回

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

返回

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

参数

名称类型说明
rangeRange要移除的范围。

返回

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")。

返回

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要更改此图表的类型。

返回

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"]。数组中的第 n 个元素表示图表中第 n 行的颜色。

返回

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用于隐藏行和列的策略。

返回

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图例的位置。

返回

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用于图表图例的文本样式。

返回

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要使用的合并策略。

返回

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要被视为标题的行数或列数。若使用负值,则可自动检测标头。

返回

EmbeddedChartBuilder - 此构建器,用于链接


setOption(option, value)

设置此图表的高级选项。如需查看可用选项的列表,请参阅图表配置选项

此方法既不会验证您指定的选项是否适用于此图表类型,也不会验证值的格式是否正确/结构。

以下示例展示了如何更改标题和设置图例。

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

参数

名称类型说明
optionString选项的名称。
valueObject选项的值。

返回

EmbeddedChartBuilder - 此构建器,用于链接。


setPointStyle(style)

设置直线中点的样式。默认情况下,点没有特定的样式,只有线条可见。

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

参数

名称类型说明
stylePointStyle直线中点使用的样式。

返回

EmbeddedScatterChartBuilder - 此构建器对于链接非常有用。

另请参阅


setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

设置位置,更改图表在工作表中的显示位置。anchorRowPosanchorColPos 按 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);

参数

名称类型说明
anchorRowPosInteger图表的顶部锚定在这一行中。
anchorColPosInteger图表的左侧锚定在该列。
offsetXInteger图表的右上角会偏移这么多像素。
offsetYInteger图表的左下角偏移了这么多像素。

返回

EmbeddedChartBuilder - 此构建器,用于链接


setTitle(chartTitle)

设置图表标题。标题会在图表上方居中显示。

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

参数

名称类型说明
chartTitleString图表标题。

返回

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 对象。

返回

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,则会转置用于构建图表的行和列。

返回

EmbeddedChartBuilder - 此构建器,用于链接


setXAxisLogScale()

将横轴设为对数刻度(要求所有值均为正数)。

返回

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横轴的最高网格线的值。

返回

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 对象。

返回

EmbeddedScatterChartBuilder - 此构建器对于链接非常有用。


setXAxisTitle(title)

为横轴添加标题。标题居中显示,显示在轴值标签的下方。

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

参数

名称类型说明
titleStringX 轴的标题。

返回

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 对象。

返回

EmbeddedScatterChartBuilder - 此构建器对于链接非常有用。


setYAxisLogScale()

将纵轴设为对数刻度(要求所有值均为正数)。

返回

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纵轴的最高网格线的值。

返回

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 对象。

返回

EmbeddedScatterChartBuilder - 此构建器对于链接非常有用。


setYAxisTitle(title)

为纵轴添加标题。标题居中显示,并显示在值标签的左侧。

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

参数

名称类型说明
titleStringY 轴的标题。

返回

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 对象。

返回

EmbeddedScatterChartBuilder - 此构建器对于链接非常有用。