Charts Service

图表

此服务允许用户使用 Google 图表工具 创建图表,并在服务器端呈现这些图表。如果您想在 Web 浏览器中呈现图表,请改用 Google Charts API

此示例会创建一个基本数据表,使用该数据填充面积图,并将其作为图片添加到网页中:

function doGet() {
  var data = Charts.newDataTable()
      .addColumn(Charts.ColumnType.STRING, 'Month')
      .addColumn(Charts.ColumnType.NUMBER, 'In Store')
      .addColumn(Charts.ColumnType.NUMBER, 'Online')
      .addRow(['January', 10, 1])
      .addRow(['February', 12, 1])
      .addRow(['March', 20, 2])
      .addRow(['April', 25, 3])
      .addRow(['May', 30, 4])
      .build();

  var chart = Charts.newAreaChart()
      .setDataTable(data)
      .setStacked()
      .setRange(0, 40)
      .setTitle('Sales per Month')
      .build();

  var htmlOutput = HtmlService.createHtmlOutput().setTitle('My Chart');
  var imageData = Utilities.base64Encode(chart.getAs('image/png').getBytes());
  var imageUrl = "data:image/png;base64," + encodeURI(imageData);
  htmlOutput.append("Render chart server side: <br/>");
  htmlOutput.append("<img border=\"1\" src=\"" + imageUrl + "\">");
  return htmlOutput;

}

名称简介
AreaChartBuilder面积图的构建器。
BarChartBuilder条形图的构建器。
Chart可转换为静态图片的图表对象。
ChartHiddenDimensionStrategy一种枚举,用于表示来源中的隐藏维度在图表中的显示方式。
ChartMergeStrategy一种枚举,用于表示来源中的多个范围在图表中的显示方式。
ChartOptions公开了当前为 Chart 配置的选项,例如高度、颜色等。
ChartType图表服务支持的图表类型。
Charts用于在脚本中创建图表的入口点。
ColumnChartBuilder柱状图的构建器。
ColumnTypeDataTable 中列的有效数据类型的枚举。
CurveStyle图表中曲线样式的枚举。
DataTable要在图表中使用的数据表。
DataTableBuilderDataTable 对象的构建器。
DataTableSource可将其数据表示为 DataTable 的对象的接口。
DataViewDefinition用于直观呈现图表数据的数据视图定义。
DataViewDefinitionBuilderDataViewDefinition 对象的构建器。
LineChartBuilder折线图的构建器。
MatchType一个枚举,用于指定应如何匹配字符串值。
NumberRangeFilterBuilder用于数字范围过滤条件控件的构建器。
Orientation对象的方向枚举。
PickerValuesLayout一种枚举,用于指定如何在选择器 widget 中显示所选值。
PieChartBuilder饼图的构建器。
PointStyle线条中点的样式的枚举。
Position图表中图例位置的枚举。
ScatterChartBuilder散点图的构建器。
StringFilterBuilder字符串过滤条件控件的构建器。
TableChartBuilder表格图表的构建器。
TextStyle文本样式配置对象。
TextStyleBuilder用于创建 TextStyle 对象的构建器。

AreaChartBuilder

方法

方法返回类型简介
build()Chart构建图表。
reverseCategories()AreaChartBuilder反转网域轴中序列的绘制顺序。
setBackgroundColor(cssValue)AreaChartBuilder设置图表的背景颜色。
setColors(cssValues)AreaChartBuilder设置图表中线条的颜色。
setDataSourceUrl(url)AreaChartBuilder设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。
setDataTable(tableBuilder)AreaChartBuilder使用 DataTableBuilder 设置图表要使用的数据表。
setDataTable(table)AreaChartBuilder设置包含图表线条以及 X 轴标签的数据表。
setDataViewDefinition(dataViewDefinition)AreaChartBuilder设置要用于图表的数据视图定义。
setDimensions(width, height)AreaChartBuilder设置图表的尺寸。
setLegendPosition(position)AreaChartBuilder设置图例相对于图表的位置。
setLegendTextStyle(textStyle)AreaChartBuilder设置图表图例的文字样式。
setOption(option, value)AreaChartBuilder为此图表设置高级选项。
setPointStyle(style)AreaChartBuilder设置折线中各点的样式。
setRange(start, end)AreaChartBuilder设置图表的范围。
setStacked()AreaChartBuilder使用堆叠折线,这意味着折线和条形值是堆叠(累积)的。
setTitle(chartTitle)AreaChartBuilder设置图表的标题。
setTitleTextStyle(textStyle)AreaChartBuilder设置图表标题的文字样式。
setXAxisTextStyle(textStyle)AreaChartBuilder设置横轴文本样式。
setXAxisTitle(title)AreaChartBuilder为横轴添加标题。
setXAxisTitleTextStyle(textStyle)AreaChartBuilder设置横轴标题文本样式。
setYAxisTextStyle(textStyle)AreaChartBuilder设置纵轴文本样式。
setYAxisTitle(title)AreaChartBuilder为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)AreaChartBuilder设置纵轴标题文本样式。
useLogScale()AreaChartBuilder将范围轴设置为对数刻度(要求所有值均为正数)。

BarChartBuilder

方法

方法返回类型简介
build()Chart构建图表。
reverseCategories()BarChartBuilder反转网域轴中序列的绘制顺序。
reverseDirection()BarChartBuilder反转沿水平轴条形的增长方向。
setBackgroundColor(cssValue)BarChartBuilder设置图表的背景颜色。
setColors(cssValues)BarChartBuilder设置图表中线条的颜色。
setDataSourceUrl(url)BarChartBuilder设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。
setDataTable(tableBuilder)BarChartBuilder使用 DataTableBuilder 设置图表要使用的数据表。
setDataTable(table)BarChartBuilder设置包含图表线条以及 X 轴标签的数据表。
setDataViewDefinition(dataViewDefinition)BarChartBuilder设置要用于图表的数据视图定义。
setDimensions(width, height)BarChartBuilder设置图表的尺寸。
setLegendPosition(position)BarChartBuilder设置图例相对于图表的位置。
setLegendTextStyle(textStyle)BarChartBuilder设置图表图例的文字样式。
setOption(option, value)BarChartBuilder为此图表设置高级选项。
setRange(start, end)BarChartBuilder设置图表的范围。
setStacked()BarChartBuilder使用堆叠折线,这意味着折线和条形值是堆叠(累积)的。
setTitle(chartTitle)BarChartBuilder设置图表的标题。
setTitleTextStyle(textStyle)BarChartBuilder设置图表标题的文字样式。
setXAxisTextStyle(textStyle)BarChartBuilder设置横轴文本样式。
setXAxisTitle(title)BarChartBuilder为横轴添加标题。
setXAxisTitleTextStyle(textStyle)BarChartBuilder设置横轴标题文本样式。
setYAxisTextStyle(textStyle)BarChartBuilder设置纵轴文本样式。
setYAxisTitle(title)BarChartBuilder为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)BarChartBuilder设置纵轴标题文本样式。
useLogScale()BarChartBuilder将范围轴设置为对数刻度(要求所有值均为正数)。

Chart

方法

方法返回类型简介
getAs(contentType)Blob以转换为指定内容类型的 blob 形式返回此对象内的数据。
getBlob()Blob以 blob 形式返回此对象内的数据。
getOptions()ChartOptions返回相应图表的选项,例如高度、颜色和轴。

ChartHiddenDimensionStrategy

属性

属性类型说明
IGNORE_BOTHEnum默认值;图表会跳过所有隐藏的列和行。
IGNORE_ROWSEnum图表仅跳过隐藏的行。
IGNORE_COLUMNSEnum图表仅跳过隐藏的列。
SHOW_BOTHEnum图表不会跳过隐藏的列或行。

ChartMergeStrategy

属性

属性类型说明
MERGE_COLUMNSEnum默认。
MERGE_ROWSEnum图表会合并多个范围的行。

ChartOptions

方法

方法返回类型简介
get(option)Object返回相应图表的已配置选项。
getOrDefault(option)Object返回相应图表的已配置选项。

ChartType

属性

属性类型说明
TIMELINEEnum时间表图。
AREAEnum面积图
BAREnum条形图
BUBBLEEnum气泡图。
CANDLESTICKEnumK 线图。
COLUMNEnum柱形图
COMBOEnum组合图表
GAUGEEnum刻度盘图。
GEOEnum地理图表。
HISTOGRAMEnum直方图
RADAREnum雷达图。
LINEEnum折线图
ORGEnum组织结构图。
PIEEnum饼图
SCATTEREnum散点图
SPARKLINEEnum火花谱线图。
STEPPED_AREAEnum阶梯面积图。
TABLEEnum表格图表
TREEMAPEnum树状图。
WATERFALLEnum瀑布图。

Charts

属性

属性类型说明
ChartHiddenDimensionStrategyChartHiddenDimensionStrategy一种枚举,用于表示来源中的隐藏维度在图表中的显示方式。
ChartMergeStrategyChartMergeStrategy一种枚举,用于表示来源中的多个范围在图表中的显示方式。
ChartTypeChartType图表服务支持的图表类型的枚举。
ColumnTypeColumnTypeDataTable 中列的有效数据类型的枚举。
CurveStyleCurveStyle图表中曲线样式的枚举。
PointStylePointStyle线条中点的样式的枚举。
PositionPosition图表中图例位置的枚举。

方法

方法返回类型简介
newAreaChart()AreaChartBuilder开始构建面积图,如 Google 图表工具文档中所述。
newBarChart()BarChartBuilder开始构建条形图,如 Google 图表工具文档中所述。
newColumnChart()ColumnChartBuilder开始构建柱形图,如 Google 图表工具文档中所述。
newDataTable()DataTableBuilder创建一个空数据表,其值可以手动设置。
newDataViewDefinition()DataViewDefinitionBuilder创建新的数据视图定义。
newLineChart()LineChartBuilder开始构建折线图,如 Google 图表工具文档中所述。
newPieChart()PieChartBuilder开始构建饼图,如 Google 图表工具文档中所述。
newScatterChart()ScatterChartBuilder开始构建散点图,如 Google 图表工具文档中所述。
newTableChart()TableChartBuilder开始构建表格图表,如 Google 图表工具文档中所述。
newTextStyle()TextStyleBuilder创建新的文本样式构建器。

ColumnChartBuilder

方法

方法返回类型简介
build()Chart构建图表。
reverseCategories()ColumnChartBuilder反转网域轴中序列的绘制顺序。
setBackgroundColor(cssValue)ColumnChartBuilder设置图表的背景颜色。
setColors(cssValues)ColumnChartBuilder设置图表中线条的颜色。
setDataSourceUrl(url)ColumnChartBuilder设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。
setDataTable(tableBuilder)ColumnChartBuilder使用 DataTableBuilder 设置图表要使用的数据表。
setDataTable(table)ColumnChartBuilder设置包含图表线条以及 X 轴标签的数据表。
setDataViewDefinition(dataViewDefinition)ColumnChartBuilder设置要用于图表的数据视图定义。
setDimensions(width, height)ColumnChartBuilder设置图表的尺寸。
setLegendPosition(position)ColumnChartBuilder设置图例相对于图表的位置。
setLegendTextStyle(textStyle)ColumnChartBuilder设置图表图例的文字样式。
setOption(option, value)ColumnChartBuilder为此图表设置高级选项。
setRange(start, end)ColumnChartBuilder设置图表的范围。
setStacked()ColumnChartBuilder使用堆叠折线,这意味着折线和条形值是堆叠(累积)的。
setTitle(chartTitle)ColumnChartBuilder设置图表的标题。
setTitleTextStyle(textStyle)ColumnChartBuilder设置图表标题的文字样式。
setXAxisTextStyle(textStyle)ColumnChartBuilder设置横轴文本样式。
setXAxisTitle(title)ColumnChartBuilder为横轴添加标题。
setXAxisTitleTextStyle(textStyle)ColumnChartBuilder设置横轴标题文本样式。
setYAxisTextStyle(textStyle)ColumnChartBuilder设置纵轴文本样式。
setYAxisTitle(title)ColumnChartBuilder为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)ColumnChartBuilder设置纵轴标题文本样式。
useLogScale()ColumnChartBuilder将范围轴设置为对数刻度(要求所有值均为正数)。

ColumnType

属性

属性类型说明
DATEEnum对应于日期值。
NUMBEREnum对应于数值。
STRINGEnum对应于字符串值。

CurveStyle

属性

属性类型说明
NORMALEnum没有曲线的直线。
SMOOTHEnum线条的角度经过平滑处理。

DataTable

DataTableBuilder

方法

方法返回类型简介
addColumn(type, label)DataTableBuilder向数据表添加列。
addRow(values)DataTableBuilder向数据表中添加一行。
build()DataTable构建并返回数据表。
setValue(row, column, value)DataTableBuilder在表格中设置特定值。

DataTableSource

方法

方法返回类型简介
getDataTable()DataTable以 DataTable 形式返回此对象内的数据。

DataViewDefinition

DataViewDefinitionBuilder

方法

方法返回类型简介
build()DataViewDefinition构建并返回使用此构建器构建的数据视图定义对象。
setColumns(columns)DataViewDefinitionBuilder设置要包含在数据视图中的列的索引,并指定角色列信息。

LineChartBuilder

方法

方法返回类型简介
build()Chart构建图表。
reverseCategories()LineChartBuilder反转网域轴中序列的绘制顺序。
setBackgroundColor(cssValue)LineChartBuilder设置图表的背景颜色。
setColors(cssValues)LineChartBuilder设置图表中线条的颜色。
setCurveStyle(style)LineChartBuilder设置要在图表中使用的曲线样式。
setDataSourceUrl(url)LineChartBuilder设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。
setDataTable(tableBuilder)LineChartBuilder使用 DataTableBuilder 设置图表要使用的数据表。
setDataTable(table)LineChartBuilder设置包含图表线条以及 X 轴标签的数据表。
setDataViewDefinition(dataViewDefinition)LineChartBuilder设置要用于图表的数据视图定义。
setDimensions(width, height)LineChartBuilder设置图表的尺寸。
setLegendPosition(position)LineChartBuilder设置图例相对于图表的位置。
setLegendTextStyle(textStyle)LineChartBuilder设置图表图例的文字样式。
setOption(option, value)LineChartBuilder为此图表设置高级选项。
setPointStyle(style)LineChartBuilder设置折线中各点的样式。
setRange(start, end)LineChartBuilder设置图表的范围。
setTitle(chartTitle)LineChartBuilder设置图表的标题。
setTitleTextStyle(textStyle)LineChartBuilder设置图表标题的文字样式。
setXAxisTextStyle(textStyle)LineChartBuilder设置横轴文本样式。
setXAxisTitle(title)LineChartBuilder为横轴添加标题。
setXAxisTitleTextStyle(textStyle)LineChartBuilder设置横轴标题文本样式。
setYAxisTextStyle(textStyle)LineChartBuilder设置纵轴文本样式。
setYAxisTitle(title)LineChartBuilder为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)LineChartBuilder设置纵轴标题文本样式。
useLogScale()LineChartBuilder将范围轴设置为对数刻度(要求所有值均为正数)。

MatchType

属性

属性类型说明
EXACTEnum仅匹配确切值
PREFIXEnum从值的开头开始匹配前缀
ANYEnum匹配任意子字符串

方法

方法返回类型简介
getName()String返回要在选项 JSON 中使用的匹配类型的名称。

NumberRangeFilterBuilder

方法

方法返回类型简介
setMaxValue(maxValue)NumberRangeFilterBuilder设置范围下限允许的最大值。
setMinValue(minValue)NumberRangeFilterBuilder设置范围下限的允许最小值。
setOrientation(orientation)NumberRangeFilterBuilder设置滑块方向。
setShowRangeValues(showRangeValues)NumberRangeFilterBuilder设置是否在滑块旁边显示标签,以显示所选范围的程度。
setTicks(ticks)NumberRangeFilterBuilder设置数字范围过滤滑块拇指可落入的刻度数(范围栏中的固定位置)。

Orientation

属性

属性类型说明
HORIZONTALEnum横向屏幕方向。
VERTICALEnum竖屏方向。

PickerValuesLayout

属性

属性类型说明
ASIDEEnum所选值显示在值选择器微件旁边的单行文本中。
BELOWEnum所选值显示在微件下方的单行文本中。
BELOW_WRAPPINGEnum与下方类似,但无法容纳在选择器中的条目会换行显示。
BELOW_STACKEDEnum所选值会显示在微件下方的列中。

PieChartBuilder

方法

方法返回类型简介
build()Chart构建图表。
reverseCategories()PieChartBuilder反转网域轴中序列的绘制顺序。
set3D()PieChartBuilder将图表设置为三维。
setBackgroundColor(cssValue)PieChartBuilder设置图表的背景颜色。
setColors(cssValues)PieChartBuilder设置图表中线条的颜色。
setDataSourceUrl(url)PieChartBuilder设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。
setDataTable(tableBuilder)PieChartBuilder使用 DataTableBuilder 设置图表要使用的数据表。
setDataTable(table)PieChartBuilder设置包含图表线条以及 X 轴标签的数据表。
setDataViewDefinition(dataViewDefinition)PieChartBuilder设置要用于图表的数据视图定义。
setDimensions(width, height)PieChartBuilder设置图表的尺寸。
setLegendPosition(position)PieChartBuilder设置图例相对于图表的位置。
setLegendTextStyle(textStyle)PieChartBuilder设置图表图例的文字样式。
setOption(option, value)PieChartBuilder为此图表设置高级选项。
setTitle(chartTitle)PieChartBuilder设置图表的标题。
setTitleTextStyle(textStyle)PieChartBuilder设置图表标题的文字样式。

PointStyle

属性

属性类型说明
NONEEnum不显示折线点。
TINYEnum使用细线点。
MEDIUMEnum使用中等大小的线点。
LARGEEnum使用大号线点。
HUGEEnum使用最大的线条点。

Position

属性

属性类型说明
TOPEnum图表上方。
RIGHTEnum位于图表右侧。
BOTTOMEnum图表下方。
NONEEnum系统不会显示图例。

ScatterChartBuilder

方法

方法返回类型简介
build()Chart构建图表。
setBackgroundColor(cssValue)ScatterChartBuilder设置图表的背景颜色。
setColors(cssValues)ScatterChartBuilder设置图表中线条的颜色。
setDataSourceUrl(url)ScatterChartBuilder设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。
setDataTable(tableBuilder)ScatterChartBuilder使用 DataTableBuilder 设置图表要使用的数据表。
setDataTable(table)ScatterChartBuilder设置包含图表线条以及 X 轴标签的数据表。
setDataViewDefinition(dataViewDefinition)ScatterChartBuilder设置要用于图表的数据视图定义。
setDimensions(width, height)ScatterChartBuilder设置图表的尺寸。
setLegendPosition(position)ScatterChartBuilder设置图例相对于图表的位置。
setLegendTextStyle(textStyle)ScatterChartBuilder设置图表图例的文字样式。
setOption(option, value)ScatterChartBuilder为此图表设置高级选项。
setPointStyle(style)ScatterChartBuilder设置折线中各点的样式。
setTitle(chartTitle)ScatterChartBuilder设置图表的标题。
setTitleTextStyle(textStyle)ScatterChartBuilder设置图表标题的文字样式。
setXAxisLogScale()ScatterChartBuilder将横轴转换为对数刻度(要求所有值均为正数)。
setXAxisRange(start, end)ScatterChartBuilder设置图表横轴的范围。
setXAxisTextStyle(textStyle)ScatterChartBuilder设置横轴文本样式。
setXAxisTitle(title)ScatterChartBuilder为横轴添加标题。
setXAxisTitleTextStyle(textStyle)ScatterChartBuilder设置横轴标题文本样式。
setYAxisLogScale()ScatterChartBuilder将纵轴设为对数刻度(要求所有值均为正数)。
setYAxisRange(start, end)ScatterChartBuilder设置图表纵轴的范围。
setYAxisTextStyle(textStyle)ScatterChartBuilder设置纵轴文本样式。
setYAxisTitle(title)ScatterChartBuilder为纵轴添加标题。
setYAxisTitleTextStyle(textStyle)ScatterChartBuilder设置纵轴标题文本样式。

StringFilterBuilder

方法

方法返回类型简介
setCaseSensitive(caseSensitive)StringFilterBuilder设置匹配是否应区分大小写。
setMatchType(matchType)StringFilterBuilder设置控件是仅匹配确切值 (MatchType.EXACT)、从值开头开始的前缀 (MatchType.PREFIX),还是任何子字符串 (MatchType.ANY)。
setRealtimeTrigger(realtimeTrigger)StringFilterBuilder设置控件是否应在每次按下键时进行匹配,还是仅在输入字段“更改”(失去焦点或按下 Enter 键)时进行匹配。

TableChartBuilder

方法

方法返回类型简介
build()Chart构建图表。
enablePaging(enablePaging)TableChartBuilder设置是否启用数据分页。
enablePaging(pageSize)TableChartBuilder启用分页并设置每页的行数。
enablePaging(pageSize, startPage)TableChartBuilder启用分页,设置每页的行数和要显示的第一页表格(页码从零开始)。
enableRtlTable(rtlEnabled)TableChartBuilder通过反转表格的列顺序,为从右到左书写的语言(例如阿拉伯语或希伯来语)添加基本支持,使第 0 列成为最右侧的列,最后一列成为最左侧的列。
enableSorting(enableSorting)TableChartBuilder设置是否在用户点击列标题时对列进行排序。
setDataSourceUrl(url)TableChartBuilder设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。
setDataTable(tableBuilder)TableChartBuilder使用 DataTableBuilder 设置图表要使用的数据表。
setDataTable(table)TableChartBuilder设置包含图表线条以及 X 轴标签的数据表。
setDataViewDefinition(dataViewDefinition)TableChartBuilder设置要用于图表的数据视图定义。
setDimensions(width, height)TableChartBuilder设置图表的尺寸。
setFirstRowNumber(number)TableChartBuilder设置数据表格中第一行的行号。
setInitialSortingAscending(column)TableChartBuilder设置应根据哪个列(升序)对表格进行初始排序。
setInitialSortingDescending(column)TableChartBuilder设置应根据哪个列(降序)对表格进行初始排序。
setOption(option, value)TableChartBuilder为此图表设置高级选项。
showRowNumberColumn(showRowNumber)TableChartBuilder设置是否将行号显示为表格的第一列。
useAlternatingRowStyle(alternate)TableChartBuilder设置是否为表格图表的奇数行和偶数行分配交替颜色样式。

TextStyle

方法

方法返回类型简介
getColor()String获取文本样式的颜色。
getFontName()String获取文字样式的字体名称。
getFontSize()Number获取文字样式的字号。

TextStyleBuilder

方法

方法返回类型简介
build()TextStyle构建并返回使用此构建器构建的文本样式配置对象。
setColor(cssValue)TextStyleBuilder设置文字样式的颜色。
setFontName(fontName)TextStyleBuilder设置文本样式的字体名称。
setFontSize(fontSize)TextStyleBuilder设置文本样式的字体大小。