Class EmbeddedChartBuilder
Page Summary
EmbeddedChartBuilder is used to modify an existing EmbeddedChart in a spreadsheet.
Changes made using EmbeddedChartBuilder are not saved until Sheet.updateChart(chart) is called.
The builder provides methods to add/remove data ranges, change chart type, set position, and configure advanced options.
Methods like
asAreaChart(),asBarChart(), etc., set the chart type and return a more specific builder for that type.The
build()method finalizes the changes made to the chart builder, returning an updated EmbeddedChart object.
Builder used to edit anEmbedded. Changes made to the chart are not saved untilSheet.updateChart(chart) is called on the rebuilt chart.
constsheet=SpreadsheetApp.getActiveSheet();constrange=sheet.getRange('A1:B8');letchart=sheet.getCharts()[0];chart=chart.modify().addRange(range).setOption('title','Updated!').setOption('animation.duration',500).setPosition(2,2,0,0).build();sheet.updateChart(chart);
Methods
| Method | Return type | Brief description |
|---|---|---|
add | Embedded | Adds a range to the chart this builder modifies. |
as | Embedded | Sets the chart type to AreaChart and returns anEmbedded. |
as | Embedded | Sets the chart type to BarChart and returns anEmbedded. |
as | Embedded | Sets the chart type to ColumnChart and returns anEmbedded. |
as | Embedded | Sets the chart type to ComboChart and returns anEmbedded. |
as | Embedded | Sets the chart type to HistogramChart and returns anEmbedded. |
as | Embedded | Sets the chart type to LineChart and returns anEmbedded. |
as | Embedded | Sets the chart type to PieChart and returns anEmbedded. |
as | Embedded | Sets the chart type to ScatterChart and returns anEmbedded. |
as | Embedded | Sets the chart type to TableChart and returns anEmbedded. |
build() | Embedded | Builds the chart to reflect all changes made to it. |
clear | Embedded | Removes all ranges from the chart this builder modifies. |
get | Chart | Returns the current chart type. |
get | Container | Return the chartContainer, which encapsulates where the chart appears on thesheet. |
get | Range[] | Returns a copy of the list of ranges currently providing data for this chart. |
remove | Embedded | Removes the specified range from the chart this builder modifies. |
set | Embedded | Changes the type of chart. |
set | Embedded | Sets the strategy to use for hidden rows and columns. |
set | Embedded | Sets the merge strategy to use when more than one range exists. |
set | Embedded | Sets the number of rows or columns of the range that should be treated as headers. |
set | Embedded | Sets advanced options for this chart. |
set | Embedded | Sets the position, changing where the chart appears on the sheet. |
set | Embedded | Sets whether the chart's rows and columns are transposed. |
Detailed documentation
addRange(range)
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
| Name | Type | Description |
|---|---|---|
range | Range | The range to add. |
Return
Embedded — This builder, for chaining.
asAreaChart()
Sets the chart type to AreaChart and returns anEmbedded.
Return
Embedded — A builder for an area chart.
asBarChart()
Sets the chart type to BarChart and returns anEmbedded.
Return
Embedded — A builder for a bar chart.
asColumnChart()
Sets the chart type to ColumnChart and returns anEmbedded.
Return
Embedded — A builder for a column chart.
asComboChart()
Sets the chart type to ComboChart and returns anEmbedded.
Return
Embedded — A builder for a combo chart.
asHistogramChart()
Sets the chart type to HistogramChart and returns anEmbedded.
Return
Embedded — A builder for a histogram chart.
asLineChart()
Sets the chart type to LineChart and returns anEmbedded.
Return
Embedded — A builder for a line chart.
asPieChart()
Sets the chart type to PieChart and returns anEmbedded.
Return
Embedded — A builder for a pie chart.
asScatterChart()
Sets the chart type to ScatterChart and returns anEmbedded.
Return
Embedded — A builder for a scatter chart.
asTableChart()
Sets the chart type to TableChart and returns anEmbedded.
Return
Embedded — A builder for a table chart.
build()
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
Embedded — The created chart, which must still be added to the spreadsheet.
clearRanges()
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
Embedded — This builder, for chaining.
getChartType()
getContainer()
Return the chartContainer, 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
Container — An object containing the chart container's position.
getRanges()
Returns a copy of the list of ranges currently providing data for this chart. Useadd andremove 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.
removeRange(range)
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 viaadd;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
| Name | Type | Description |
|---|---|---|
range | Range | The range to remove. |
Return
Embedded — This builder, for chaining.
setChartType(type)
Changes the type of chart. Not all embedded chart types are currently supported. SeeChart.
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
| Name | Type | Description |
|---|---|---|
type | Chart | The type to change this chart into. |
Return
Embedded — This builder, for chaining.
setHiddenDimensionStrategy(strategy)
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
| Name | Type | Description |
|---|---|---|
strategy | Chart | The strategy to use for hidden rows and columns. |
Return
Embedded — This builder, for chaining.
setMergeStrategy(mergeStrategy)
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
| Name | Type | Description |
|---|---|---|
merge | Chart | The merge strategy to use. |
Return
Embedded — This builder, for chaining.
setNumHeaders(headers)
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
| Name | Type | Description |
|---|---|---|
headers | Integer | The number of rows or columns to treat as headers. Negative values cause headers to be auto-detected. |
Return
Embedded — This builder, for chaining.
setOption(option, value)
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
| Name | Type | Description |
|---|---|---|
option | String | The name of the option. |
value | Object | The value of the option. |
Return
Embedded — This builder, for chaining.
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)
Sets the position, changing where the chart appears on the sheet.anchor andanchor 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
| Name | Type | Description |
|---|---|---|
anchor | Integer | The chart's top side is anchored in this row. |
anchor | Integer | The chart's left side is anchored in this column. |
offsetX | Integer | The chart's upper right-hand corner is offset by this many pixels. |
offsetY | Integer | The chart's lower left-hand corner is offset by this many pixels. |
Return
Embedded — This builder, for chaining.
setTransposeRowsAndColumns(transpose)
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
| Name | Type | Description |
|---|---|---|
transpose | Boolean | Iftrue, the rows and columns used to construct the chart are transposed. |
Return
Embedded — This builder, for chaining.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-12-11 UTC.