Class Charts

Charts

Entry point for creating Charts in scripts.

This example creates a basic data table, populates an area chart with the data, and adds it into a web page as an image:

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

Properties

Property	Type	Description
`ChartHiddenDimensionStrategy`	`ChartHiddenDimensionStrategy`	An enumeration of how hidden dimensions in a source are expressed in a chart.
`ChartMergeStrategy`	`ChartMergeStrategy`	An enumeration of how multiple ranges in the source are expressed in a chart.
`ChartType`	`ChartType`	An enumeration of chart types supported by the Charts service.
`ColumnType`	`ColumnType`	An enumeration of the valid data types for columns in a `DataTable` .
`CurveStyle`	`CurveStyle`	An enumeration of the styles for curves in a chart.
`PointStyle`	`PointStyle`	An enumeration of the styles of points in a line.
`Position`	`Position`	An enumeration of legend positions within a chart.

Methods

Method	Return type	Brief description
`newAreaChart()`	`AreaChartBuilder`	Starts building an area chart, as described in the Google Chart Tools documentation.
`newBarChart()`	`BarChartBuilder`	Starts building a bar chart, as described in the Google Chart Tools documentation.
`newColumnChart()`	`ColumnChartBuilder`	Starts building a column chart, as described in the Google Chart Tools documentation.
`newDataTable()`	`DataTableBuilder`	Creates an empty data table, which can have its values set manually.
`newDataViewDefinition()`	`DataViewDefinitionBuilder`	Creates a new data view definition.
`newLineChart()`	`LineChartBuilder`	Starts building a line chart, as described in the Google Chart Tools documentation.
`newPieChart()`	`PieChartBuilder`	Starts building a pie chart, as described in the Google Chart Tools documentation.
`newScatterChart()`	`ScatterChartBuilder`	Starts building a scatter chart, as described in the Google Chart Tools documentation.
`newTableChart()`	`TableChartBuilder`	Starts building a table chart, as described in the Google Chart Tools documentation.
`newTextStyle()`	`TextStyleBuilder`	Creates a new text style builder.

Detailed documentation

`newAreaChart()`

Starts building an area chart, as described in the Google Chart Tools documentation.

Return

AreaChartBuilder — An AreaChartBuilder, which can be used to build an area chart.

`newBarChart()`

Starts building a bar chart, as described in the Google Chart Tools documentation.

Return

BarChartBuilder — A BarChartBuilder, which can be used to build a bar chart.

`newColumnChart()`

Starts building a column chart, as described in the Google Chart Tools documentation.

Return

ColumnChartBuilder — A ColumnChartBuilder, which can be used to build a column chart.

`newDataTable()`

Creates an empty data table, which can have its values set manually.

Data tables hold the data for all chart types.

Return

DataTableBuilder — A DataTableBuilder, which can hold data for charts.

`newDataViewDefinition()`

Creates a new data view definition.

Use setters to define the different properties of the data view.

Return

DataViewDefinitionBuilder — A DataViewDefinitionBuilder, which can be used to build a data view definition.

`newLineChart()`

Starts building a line chart, as described in the Google Chart Tools documentation.

Return

LineChartBuilder — A LineChartBuilder, which can be used to build a line chart.

`newPieChart()`

Starts building a pie chart, as described in the Google Chart Tools documentation.

Return

PieChartBuilder — A PieChartBuilder, which can be used to build a pie chart.

`newScatterChart()`

Starts building a scatter chart, as described in the Google Chart Tools documentation.

Return

ScatterChartBuilder — A ScatterChartBuilder, which can be used to build a scatter chart.

`newTableChart()`

Starts building a table chart, as described in the Google Chart Tools documentation.

Return

TableChartBuilder — A TableChartBuilder, which can be used to build a table chart.

`newTextStyle()`

Creates a new text style builder.

To change the default values, use the setter functions.

Return

TextStyleBuilder — A TextStyleBuilder, which can be used to build a text style configuration object.