Adds a range to the chart this builder modifies. Does not add the range if it has already beenadded to the chart.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(sheet.getRange('A1:B8')).setPosition(5,5,0,0).build();sheet.insertChart(chart);

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets the chart type to AreaChart and returns anEmbeddedAreaChartBuilder.

Return

EmbeddedAreaChartBuilder — A builder for an area chart.

Sets the chart type to BarChart and returns anEmbeddedBarChartBuilder.

Return

EmbeddedBarChartBuilder — A builder for a bar chart.

Sets the chart type to ColumnChart and returns anEmbeddedColumnChartBuilder.

Return

EmbeddedColumnChartBuilder — A builder for a column chart.

Sets the chart type to ComboChart and returns anEmbeddedComboChartBuilder.

Return

EmbeddedComboChartBuilder — A builder for a combo chart.

Sets the chart type to HistogramChart and returns anEmbeddedHistogramChartBuilder.

Return

EmbeddedHistogramChartBuilder — A builder for a histogram chart.

Sets the chart type to LineChart and returns anEmbeddedLineChartBuilder.

Return

EmbeddedLineChartBuilder — A builder for a line chart.

Sets the chart type to PieChart and returns anEmbeddedPieChartBuilder.

Return

EmbeddedPieChartBuilder — A builder for a pie chart.

Sets the chart type to ScatterChart and returns anEmbeddedScatterChartBuilder.

Return

EmbeddedScatterChartBuilder — A builder for a scatter chart.

Sets the chart type to TableChart and returns anEmbeddedTableChartBuilder.

Return

EmbeddedTableChartBuilder — A builder for a table chart.

Builds the chart to reflect all changes made to it.

This method does not automatically draw the chart on top of the spreadsheet. A new chartmust be inserted viasheet.insertChart(chart), and an existing chart should be updatedviasheet.updateChart(chart).

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constrange=sheet.getRange('A1:B5');constchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(range).setPosition(5,5,0,0).build();sheet.insertChart(chart);

Return

EmbeddedChart — The created chart, which must still be added to the spreadsheet.

Removes all ranges from the chart this builder modifies.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];// This code updates the chart to use only the new ranges while preserving the// existing formatting of the chart.constchart=sheet.getCharts()[0];constnewChart=chart.modify().clearRanges().addRange(sheet.getRange('A1:A5')).addRange(sheet.getRange('B1:B5')).build();sheet.updateChart(newChart);

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets whether to enable paging through the data.

The default behavior is paging disabled. If paging is enabled the default page size is 10.

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Enables paging and sets the number of rows in each page.

The default page size is 10.

// Creates a table chart builder and enables paging with page size of 5.constbuilder=Charts.newTableChart();builder.enablePaging(5);

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Enables paging, sets the number of rows in each page and the first table page to display (pagenumbers are zero based).

The default page size is 10, and the default start page is 0.

// Creates a table chart builder and enables paging with page size of 5 and// displays page 2 first.constbuilder=Charts.newTableChart();builder.enablePaging(5,2);

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Adds basic support for right-to-left languages (such as Arabic or Hebrew) by reversing thecolumn order of the table, so that column zero is the right-most column, and the last column isthe left-most column.

This does not affect the column index in the underlying data, only the order of display.Full bi-directional (BiDi) language display is not supported by the table visualization evenwith this option. This option is ignored if you enable paging (using the page option), or ifthe table has scroll bars because you have specified height and width options smaller than therequired table size. The default behavior is RTL support disabled.

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Sets whether to sort columns when the user clicks a column heading.

If sorting is enabled, when users click on the column header the rows are automaticallysorted. The default behavior is sorting enabled.

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Returns the current chart type.

Return

ChartType — The chart type.

Return the chartContainerInfo, which encapsulates where the chart appears on thesheet.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constchartBuilder=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()constcontainerInfo=chartBuilder.getContainer();// Logs the values 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 — An object containing the chart container's position.

Returns a copy of the list of ranges currently providing data for this chart. UseaddRange(range) andremoveRange(range) to modify this list.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constchartBuilder=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(sheet.getRange('A1:B8')).setPosition(5,5,0,0);constranges=chartBuilder.getRanges();// There's only one range as a data source for this chart,// so this logs "A1:B8"for(constiinranges){constrange=ranges[i];Logger.log(range.getA1Notation());}

Return

Range[] — An array of ranges that serve as the chart to be built's data source.

Removes the specified range from the chart this builder modifies. Does not throw an error ifthe range is not in this chart.

The range removed must match up with a range added viaaddRange(range);otherwise no change is made to the chart. This method cannot be used to partially remove valuesfrom a range.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constfirstRange=sheet.getRange('A1:B5');constsecondRange=sheet.getRange('A6:B8');constchartBuilder=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(firstRange)// This range renders 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// is not removed, and does not throw an exceptionchartBuilder.removeRange(firstRange);chartBuilder.removeRange(sheet.getRange('A6:B8'));constchart=chartBuilder.build();sheet.insertChart(chart);

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Changes the type of chart. Not all embedded chart types are currently supported. SeeChartType.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constrange=sheet.getRange('A1:B5');constchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(range).setPosition(5,5,0,0).build();sheet.insertChart(chart);

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets the row number for the first row in the data table.

The default row number of the first row is 1.

// Creates a table chart builder and sets the first row to be 2.constbuilder=Charts.newTableChart();builder.setFirstRowNumber(2);

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Sets the strategy to use for hidden rows and columns. Defaults toIGNORE_ROWS.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constrange=sheet.getRange('A1:B5');constchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(range).setHiddenDimensionStrategy(Charts.ChartHiddenDimensionStrategy.IGNORE_COLUMNS,).setPosition(5,5,0,0).build();sheet.insertChart(chart);

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets the index of the column according to which the table should be initially sorted(ascending).

The column os sorted in ascending order and is marked with a small arrow indicating that.

// Creates a table chart builder and sorts it by the second column (ascending).constbuilder=Charts.newTableChart();builder.setInitialSortingAscending(2);

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Sets the index of the column according to which the table should be initially sorted(descending).

The column os sorted in descending order and is marked with a a small arrow indicating that.

// Creates a table chart builder and sorts it by the second column (descending).constbuilder=Charts.newTableChart();builder.setInitialSortingDescending(2);

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Sets the merge strategy to use when more than one range exists. IfMERGE_ROWS, rows are merged; ifMERGE_COLUMNS, columns are merged. Defaults toMERGE_COLUMNS.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constrange=sheet.getRange('A1:B10');constrange2=sheet.getRange('C:C10');constchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(range).addRange(range2).setMergeStrategy(Charts.ChartMergeStrategy.MERGE_ROWS).setPosition(5,5,0,0).build();sheet.insertChart(chart);

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets the number of rows or columns of the range that should be treated as headers.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constrange=sheet.getRange('A1:B5');constchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(range).setNumHeaders(1).setPosition(5,5,0,0).build();sheet.insertChart(chart);

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets advanced options for this chart. To view a list of the available options, seeChartconfiguration options.

This method doesn't validate the option you specify is valid for this chart type nor if thevalue is of the correct format/structure.

This example shows how to change the title and set a legend.

constspreadsheet=SpreadsheetApp.getActiveSpreadsheet();constsheet=spreadsheet.getSheets()[0];constchart=sheet.newChart().setOption('title','Earnings projections').setOption('legend',{position:'top',textStyle:{color:'blue',fontSize:16},}).build();

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets the position, changing where the chart appears on the sheet.anchorRowPos andanchorColPos are 1-indexed.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constrange=sheet.getRange('A1:B5');constchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(range).setPosition(5,5,0,0).build();sheet.insertChart(chart);

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets whether the chart's rows and columns are transposed. If set totrue, the rows andcolumns are switched. Defaults tofalse.

constss=SpreadsheetApp.getActiveSpreadsheet();constsheet=ss.getSheets()[0];constrange=sheet.getRange('A1:B5');constchart=sheet.newChart().setChartType(Charts.ChartType.BAR).addRange(range).setTransposeRowsAndColumns(true).setPosition(5,5,0,0).build();sheet.insertChart(chart);

Parameters

Return

EmbeddedChartBuilder — This builder, for chaining.

Sets whether to show the row number as the first column of the table.

The default behavior is not showing row numbers.

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.

Sets whether alternating color style is assigned to odd and even rows of a table chart.

The default behavior is the rows having alternating color style.

Parameters

Return

EmbeddedTableChartBuilder — This builder, useful for chaining.