此页面由 Cloud Translation API 翻译。

Class EmbeddedPieChartBuilder

饼图的构建器。如需了解详情，请参阅 Gviz 文档。

方法

方法	返回类型	简介
`addRange(range)`	`EmbeddedChartBuilder`	向此构建器修改的图表中添加范围。
`asAreaChart()`	`EmbeddedAreaChartBuilder`	将图表类型设置为 AreaChart 并返回 `EmbeddedAreaChartBuilder`。
`asBarChart()`	`EmbeddedBarChartBuilder`	将图表类型设置为 BarChart 并返回 `EmbeddedBarChartBuilder`。
`asColumnChart()`	`EmbeddedColumnChartBuilder`	将图表类型设置为 ColumnChart 并返回 `EmbeddedColumnChartBuilder`。
`asComboChart()`	`EmbeddedComboChartBuilder`	将图表类型设置为 ComboChart 并返回 `EmbeddedComboChartBuilder`。
`asHistogramChart()`	`EmbeddedHistogramChartBuilder`	将图表类型设置为 HistogramChart 并返回 `EmbeddedHistogramChartBuilder`。
`asLineChart()`	`EmbeddedLineChartBuilder`	将图表类型设置为 LineChart 并返回 `EmbeddedLineChartBuilder`。
`asPieChart()`	`EmbeddedPieChartBuilder`	将图表类型设置为 PieChart 并返回 `EmbeddedPieChartBuilder`。
`asScatterChart()`	`EmbeddedScatterChartBuilder`	将图表类型设置为 ScatterChart 并返回 `EmbeddedScatterChartBuilder`。
`asTableChart()`	`EmbeddedTableChartBuilder`	将图表类型设置为 TableChart 并返回 `EmbeddedTableChartBuilder`。
`build()`	`EmbeddedChart`	构建图表以反映对其所做的所有更改。
`clearRanges()`	`EmbeddedChartBuilder`	从此构建器修改的图表中移除所有范围。
`getChartType()`	`ChartType`	返回当前图表类型。
`getContainer()`	`ContainerInfo`	返回图表 `ContainerInfo`，其中封装了图表在工作表中的显示位置。
`getRanges()`	`Range[]`	返回当前为此图表提供数据的范围列表的副本。
`removeRange(range)`	`EmbeddedChartBuilder`	从相应构建器修改的图表中移除指定范围。
`reverseCategories()`	`EmbeddedPieChartBuilder`	反转网域轴中序列的绘制顺序。
`set3D()`	`EmbeddedPieChartBuilder`	将图表设置为三维。
`setBackgroundColor(cssValue)`	`EmbeddedPieChartBuilder`	设置图表的背景颜色。
`setChartType(type)`	`EmbeddedChartBuilder`	更改图表类型。
`setColors(cssValues)`	`EmbeddedPieChartBuilder`	设置图表中线条的颜色。
`setHiddenDimensionStrategy(strategy)`	`EmbeddedChartBuilder`	设置用于隐藏行和列的策略。
`setLegendPosition(position)`	`EmbeddedPieChartBuilder`	设置图例相对于图表的位置。
`setLegendTextStyle(textStyle)`	`EmbeddedPieChartBuilder`	设置图表图例的文字样式。
`setMergeStrategy(mergeStrategy)`	`EmbeddedChartBuilder`	设置存在多个范围时要使用的合并策略。
`setNumHeaders(headers)`	`EmbeddedChartBuilder`	设置应被视为标题的范围的行数或列数。
`setOption(option, value)`	`EmbeddedChartBuilder`	设置相应图表的高级选项。
`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`	`EmbeddedChartBuilder`	设置位置，更改图表在工作表中的显示位置。
`setTitle(chartTitle)`	`EmbeddedPieChartBuilder`	设置图表的标题。
`setTitleTextStyle(textStyle)`	`EmbeddedPieChartBuilder`	设置图表标题的文字样式。
`setTransposeRowsAndColumns(transpose)`	`EmbeddedChartBuilder`	设置图表的行和列是否转置。

详细文档

`addRange(range)`

向此构建器修改的图表中添加范围。如果范围已添加到图表中，则不会再添加。

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

参数

名称	类型	说明
`range`	`Range`	要添加的范围。

EmbeddedChartBuilder - 此构建器，用于链式调用。

`asAreaChart()`

将图表类型设置为 AreaChart 并返回 EmbeddedAreaChartBuilder。

EmbeddedAreaChartBuilder - 面积图的构建器。

`asBarChart()`

将图表类型设置为 BarChart 并返回 EmbeddedBarChartBuilder。

EmbeddedBarChartBuilder - 条形图的构建器。

`asColumnChart()`

将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder。

EmbeddedColumnChartBuilder - 柱形图的构建器。

`asComboChart()`

将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder。

EmbeddedComboChartBuilder - 组合图表的构建器。

`asHistogramChart()`

将图表类型设置为 HistogramChart 并返回 EmbeddedHistogramChartBuilder。

EmbeddedHistogramChartBuilder - 直方图的构建器。

`asLineChart()`

将图表类型设置为 LineChart 并返回 EmbeddedLineChartBuilder。

EmbeddedLineChartBuilder - 折线图的构建器。

`asPieChart()`

将图表类型设置为 PieChart 并返回 EmbeddedPieChartBuilder。

EmbeddedPieChartBuilder - 饼图的构建器。

`asScatterChart()`

将图表类型设置为 ScatterChart 并返回 EmbeddedScatterChartBuilder。

EmbeddedScatterChartBuilder - 散点图的构建器。

`asTableChart()`

将图表类型设置为 TableChart 并返回 EmbeddedTableChartBuilder。

EmbeddedTableChartBuilder - 表格图表的构建器。

`build()`

构建图表以反映对其所做的所有更改。

此方法不会自动在电子表格顶部绘制图表。必须通过 sheet.insertChart(chart) 插入新图表，并通过 sheet.updateChart(chart) 更新现有图表。

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

EmbeddedChart - 已创建的图表，但仍需添加到电子表格中。

`clearRanges()`

从此构建器修改的图表中移除所有范围。

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

EmbeddedChartBuilder - 此构建器，用于链式调用。

`getChartType()`

返回当前图表类型。

ChartType - 图表类型。

`getContainer()`

返回图表 ContainerInfo，其中封装了图表在工作表中的显示位置。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const chartBuilder = 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() const containerInfo = 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(), );

ContainerInfo - 包含图表容器位置的对象。

`getRanges()`

返回当前为此图表提供数据的范围列表的副本。使用 addRange(range) 和 removeRange(range) 修改此列表。

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

Range[] - 用作要构建的图表的数据源的范围数组。

`removeRange(range)`

从相应图表中移除此构建器修改的指定范围。如果范围不在相应图表中，则不会抛出错误。

移除的范围必须与通过 addRange(range) 添加的范围相匹配；否则，图表不会发生任何变化。此方法不能用于从范围中部分移除值。

const ss = SpreadsheetApp.getActiveSpreadsheet(); const sheet = ss.getSheets()[0];  const firstRange = sheet.getRange('A1:B5'); const secondRange = sheet.getRange('A6:B8');  const chartBuilder = 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 exception chartBuilder.removeRange(firstRange); chartBuilder.removeRange(sheet.getRange('A6:B8'));  const chart = chartBuilder.build();  sheet.insertChart(chart);

参数

名称	类型	说明
`range`	`Range`	要移除的范围。

EmbeddedChartBuilder - 此构建器，用于链式调用。

`reverseCategories()`

反转网域轴中序列的绘制顺序。对于垂直范围图表（例如折线图、面积图或柱状图），这意味着水平轴是从右向左绘制的。对于横向范围图表（例如条形图），这意味着垂直轴是从上到下绘制的。对于饼图，这意味着扇形是按逆时针方向绘制的。

// Creates a pie chart builder and sets drawing of the slices in a // counter-clockwise manner. const builder = Charts.newPieChart(); builder.reverseCategories();

EmbeddedPieChartBuilder - 此构建器，适用于链式调用。

`set3D()`

将图表设置为三维。

EmbeddedPieChartBuilder - 此构建器，适用于链式调用。

`setBackgroundColor(cssValue)`

设置图表的背景颜色。

// Creates a line chart builder and sets the background color to gray const builder = Charts.newLineChart(); builder.setBackgroundColor('gray');

参数

名称	类型	说明
`cssValue`	`String`	颜色的 CSS 值（例如 `"blue"` 或 `"#00f"`）。

EmbeddedPieChartBuilder - 此构建器，适用于链式调用。

`setChartType(type)`

更改图表类型。目前并非所有嵌入式图表类型都受支持。请参阅 ChartType。

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

参数

名称	类型	说明
`type`	`ChartType`	要将此图表更改为的类型。

EmbeddedChartBuilder - 此构建器，用于链式调用。

`setColors(cssValues)`

设置图表中线条的颜色。

// Creates a line chart builder and sets the first two lines to be drawn in // green and red, respectively. const builder = Charts.newLineChart(); builder.setColors(['green', 'red']);

参数

名称	类型	说明
`cssValues`	`String[]`	颜色 CSS 值数组，例如 `["red", "#acf"]`。数组中的第 n 个元素表示图表中第 n 条线的颜色。

EmbeddedPieChartBuilder - 此构建器，适用于链式调用。

`setHiddenDimensionStrategy(strategy)`

设置用于隐藏行和列的策略。默认值为 IGNORE_ROWS。

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

参数

名称	类型	说明
`strategy`	`ChartHiddenDimensionStrategy`	用于隐藏行和列的策略。

EmbeddedChartBuilder - 此构建器，用于链式调用。

`setLegendPosition(position)`

设置图例相对于图表的位置。默认情况下，没有图例。

// Creates a line chart builder and sets the legend position to right. const builder = Charts.newLineChart(); builder.setLegendPosition(Charts.Position.RIGHT);

参数

名称	类型	说明
`position`	`Position`	图例的位置。

EmbeddedPieChartBuilder - 此构建器，适用于链式调用。

`setLegendTextStyle(textStyle)`

设置图表图例的文本样式。

// Creates a line chart builder and sets it up for a  blue, 26-point legend. const textStyleBuilder =     Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setLegendTextStyle(style);

参数

名称	类型	说明
`textStyle`	`TextStyle`	图表图例所用的文字样式。

EmbeddedPieChartBuilder - 此构建器，适用于链式调用。

`setMergeStrategy(mergeStrategy)`

设置存在多个范围时要使用的合并策略。如果值为 MERGE_ROWS，则合并行；如果值为 MERGE_COLUMNS，则合并列。默认值为 MERGE_COLUMNS。

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

参数

名称	类型	说明
`mergeStrategy`	`ChartMergeStrategy`	要使用的合并策略。

EmbeddedChartBuilder - 此构建器，用于链式调用。

`setNumHeaders(headers)`

设置应被视为标题的范围的行数或列数。

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

参数

名称	类型	说明
`headers`	`Integer`	要视为标题的行数或列数。负值会导致系统自动检测标头。

EmbeddedChartBuilder - 此构建器，用于链式调用。

`setOption(option, value)`

设置相应图表的高级选项。如需查看可用选项的列表，请参阅图表配置选项。

此方法不会验证您指定的选项是否对此图表类型有效，也不会验证值是否采用正确的格式/结构。

此示例展示了如何更改图表标题和设置图例。

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

参数

名称	类型	说明
`option`	`String`	选项的名称。
`value`	`Object`	选项的值。

EmbeddedChartBuilder - 此构建器，用于链式调用。

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

设置位置，更改图表在工作表中的显示位置。anchorRowPos 和 anchorColPos 是从 1 开始的索引。

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

参数

名称	类型	说明
`anchorRowPos`	`Integer`	图表的顶部固定在此行中。
`anchorColPos`	`Integer`	图表的左侧固定在此列中。
`offsetX`	`Integer`	图表的右上角偏移的像素数。
`offsetY`	`Integer`	图表的左下角偏移的像素数。

EmbeddedChartBuilder - 此构建器，用于链式调用。

`setTitle(chartTitle)`

设置图表的标题。标题显示在图表上方的中心位置。

// Creates a line chart builder and title to 'My Line Chart'. const builder = Charts.newLineChart(); builder.setTitle('My Line Chart');

参数

名称	类型	说明
`chartTitle`	`String`	图表标题。

EmbeddedPieChartBuilder - 此构建器，适用于链式调用。

`setTitleTextStyle(textStyle)`

设置图表标题的文字样式。

// Creates a line chart builder and sets it up for a  blue, 26-point title. const textStyleBuilder =     Charts.newTextStyle().setColor('#0000FF').setFontSize(26); const style = textStyleBuilder.build(); const builder = Charts.newLineChart(); builder.setTitleTextStyle(style);

参数

名称	类型	说明
`textStyle`	`TextStyle`	图表标题所用的文字样式。您可以通过调用 `Charts.newTextStyle()` 来创建 `TextStyleBuilder` 对象。

EmbeddedPieChartBuilder - 此构建器，适用于链式调用。

`setTransposeRowsAndColumns(transpose)`

设置图表的行和列是否转置。如果设置为 true，则会切换行和列。默认值为 false。

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

参数

名称	类型	说明
`transpose`	`Boolean`	如果值为 `true`，则用于构建图表的行和列会进行转置。

EmbeddedChartBuilder - 此构建器，用于链式调用。

Class EmbeddedPieChartBuilder 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

方法

详细文档

addRange(range)

参数

返回

asAreaChart()

返回

asBarChart()

返回

asColumnChart()

返回

asComboChart()

返回

asHistogramChart()

返回

asLineChart()

返回

asPieChart()

返回

asScatterChart()

返回

asTableChart()

返回

build()

返回

clearRanges()

返回

getChartType()

返回

getContainer()

返回

getRanges()

返回

removeRange(range)

参数

返回

reverseCategories()

返回

set3D()

返回

setBackgroundColor(cssValue)

参数

返回

setChartType(type)

参数

返回

setColors(cssValues)

参数

返回

setHiddenDimensionStrategy(strategy)

参数

返回

setLegendPosition(position)

参数

返回

setLegendTextStyle(textStyle)

参数

返回

setMergeStrategy(mergeStrategy)

参数

返回

setNumHeaders(headers)

参数

返回

setOption(option, value)

参数

返回

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

参数

返回

setTitle(chartTitle)

参数

返回

setTitleTextStyle(textStyle)

参数

返回

setTransposeRowsAndColumns(transpose)

参数

返回

Class EmbeddedPieChartBuilder

`addRange(range)`

`asAreaChart()`

`asBarChart()`

`asColumnChart()`

`asComboChart()`

`asHistogramChart()`

`asLineChart()`

`asPieChart()`

`asScatterChart()`

`asTableChart()`

`build()`

`clearRanges()`

`getChartType()`

`getContainer()`

`getRanges()`

`removeRange(range)`

`reverseCategories()`

`set3D()`

`setBackgroundColor(cssValue)`

`setChartType(type)`

`setColors(cssValues)`

`setHiddenDimensionStrategy(strategy)`

`setLegendPosition(position)`

`setLegendTextStyle(textStyle)`

`setMergeStrategy(mergeStrategy)`

`setNumHeaders(headers)`

`setOption(option, value)`

`setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)`

`setTitle(chartTitle)`

`setTitleTextStyle(textStyle)`

`setTransposeRowsAndColumns(transpose)`