Charts Service

图表

此服务允许用户使用 Google 图表工具创建图表并在服务器端呈现这些图表。如果您想在网络浏览器中呈现图表,请改用 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一个 Chart 对象,可转换为静态图片。
ChartHiddenDimensionStrategy一个枚举,用于说明来源中隐藏的维度如何在图表中表示。
ChartMergeStrategy枚举如何在图表中表示来源中的多个范围。
ChartOptions公开当前为 Chart 配置的选项,例如高度、颜色等。
ChartTypeCharts 服务支持的图表类型。
Charts在脚本中创建图表的入口点。
ColumnChartBuilder柱形图的构建器。
ColumnType枚举 DataTable 中列的有效数据类型。
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枚举如何在图表中表示来源中的多个范围。
ChartTypeChartTypeCharts 服务支持的图表类型的枚举。
ColumnTypeColumnType枚举 DataTable 中列的有效数据类型。
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所选值会显示在值选择器 widget 旁边的单个文本行中。
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设置文本样式的字体大小。