Class EmbeddedTableChartBuilder

EmbeddedTableChartBuilder

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

方法

方法	返回类型	简介
addRange(range)	EmbeddedChartBuilder	向此构建器所修改的图表添加一个范围。
asAreaChart()	EmbeddedAreaChartBuilder	将图表类型设置为区域图表并返回 EmbeddedAreaChartBuilder。
asBarChart()	EmbeddedBarChartBuilder	将图表类型设置为条形图，并返回 EmbeddedBarChartBuilder。
asColumnChart()	EmbeddedColumnChartBuilder	将图表类型设置为 ColumnChart 并返回 EmbeddedColumnChartBuilder。
asComboChart()	EmbeddedComboChartBuilder	将图表类型设置为 ComboChart 并返回 EmbeddedComboChartBuilder。
asHistogramChart()	EmbeddedHistogramChartBuilder	将图表类型设置为直方图并返回 EmbeddedHistogramChartBuilder。
asLineChart()	EmbeddedLineChartBuilder	将图表类型设置为“折线图”并返回 EmbeddedLineChartBuilder。
asPieChart()	EmbeddedPieChartBuilder	将图表类型设置为 PieChart 并返回 EmbeddedPieChartBuilder。
asScatterChart()	EmbeddedScatterChartBuilder	将图表类型设置为散点图并返回 EmbeddedScatterChartBuilder。
asTableChart()	EmbeddedTableChartBuilder	将图表类型设置为 TableChart 并返回 EmbeddedTableChartBuilder。
build()	EmbeddedChart	构建图表，以反映对其所做的所有更改。
clearRanges()	EmbeddedChartBuilder	从此构建器修改的图表中移除所有范围。
enablePaging(enablePaging)	EmbeddedTableChartBuilder	设置是否启用数据分页。
enablePaging(pageSize)	EmbeddedTableChartBuilder	启用分页并设置每页的行数。
enablePaging(pageSize, startPage)	EmbeddedTableChartBuilder	启用分页，设置每个页面的行数和要显示的第一个表格页面（第 页 数字从零开始）。
enableRtlTable(rtlEnabled)	EmbeddedTableChartBuilder	添加对从右到左书写的语言（例如，阿拉伯语或希伯来语）的基本支持，方法是 将 0 列放在最右边，最后一列是 最左边的列。
enableSorting(enableSorting)	EmbeddedTableChartBuilder	设置是否在用户点击列标题时对列进行排序。
getChartType()	ChartType	返回当前图表类型。
getContainer()	ContainerInfo	返回图表 ContainerInfo，其中包含图表在 工作表。
getRanges()	Range[]	返回当前为此图表提供数据的范围列表的副本。
removeRange(range)	EmbeddedChartBuilder	从此构建器修改的图表中移除指定范围。
setChartType(type)	EmbeddedChartBuilder	更改图表类型。
setFirstRowNumber(number)	EmbeddedTableChartBuilder	设置数据表中第一行的行号。
setHiddenDimensionStrategy(strategy)	EmbeddedChartBuilder	设置用于隐藏行和列的策略。
setInitialSortingAscending(column)	EmbeddedTableChartBuilder	设置最初对表进行排序时所依据的列索引 （升序）。
setInitialSortingDescending(column)	EmbeddedTableChartBuilder	设置最初对表进行排序时所依据的列索引 （降序）。
setMergeStrategy(mergeStrategy)	EmbeddedChartBuilder	设置当存在多个范围时使用的合并策略。
setNumHeaders(headers)	EmbeddedChartBuilder	设置应视为标题的范围的行数或列数。
setOption(option, value)	EmbeddedChartBuilder	设置此图表的高级选项。
setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)	EmbeddedChartBuilder	设置位置，以更改图表在工作表中的显示位置。
setTransposeRowsAndColumns(transpose)	EmbeddedChartBuilder	设置是否转置图表的行和列。
showRowNumberColumn(showRowNumber)	EmbeddedTableChartBuilder	设置是否将行号显示为表的第一列。
useAlternatingRowStyle(alternate)	EmbeddedTableChartBuilder	设置是否为表格图表的奇数行和偶数行分配交替颜色样式。

详细文档

addRange(range)

向此构建器所修改的图表添加一个范围。如果此范围已被添加，则不添加该范围 已添加到图表中

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var 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()

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

返回

EmbeddedAreaChartBuilder - 面积图的构建器

---

asBarChart()

将图表类型设置为条形图，并返回 EmbeddedBarChartBuilder。

返回

EmbeddedBarChartBuilder - 用于条形图的构建器

---

asColumnChart()

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

返回

EmbeddedColumnChartBuilder - 柱形图的构建器

---

asComboChart()

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

返回

EmbeddedComboChartBuilder - 组合图表的构建器

---

asHistogramChart()

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

返回

EmbeddedHistogramChartBuilder - 用于直方图的构建器

---

asLineChart()

将图表类型设置为“折线图”并返回 EmbeddedLineChartBuilder。

返回

EmbeddedLineChartBuilder - 折线图构建器

---

asPieChart()

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

返回

EmbeddedPieChartBuilder - 饼图构建器

---

asScatterChart()

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

返回

EmbeddedScatterChartBuilder - 散点图构建器

---

asTableChart()

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

返回

EmbeddedTableChartBuilder - 表格图表构建器

---

build()

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

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

返回

EmbeddedChart - 已创建的图表（仍必须添加到电子表格中）

---

clearRanges()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

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

返回

EmbeddedChartBuilder - 此构建器，用于链接

---

enablePaging(enablePaging)

设置是否启用数据分页。

默认行为是停用分页。如果启用了分页功能，则默认页面大小为 10。

参数

名称	类型	说明
enablePaging	Boolean	如果应启用分页，则为 true，否则为 false。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

enablePaging(pageSize)

启用分页并设置每页的行数。

默认页面大小为 10。

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

参数

名称	类型	说明
pageSize	Integer	表格的每页中的行数。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

enablePaging(pageSize, startPage)

启用分页，设置每个页面的行数和要显示的第一个表格页面（第 页 数字从零开始）。

默认页面大小为 10，默认初始页为 0。

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

参数

名称	类型	说明
pageSize	Integer	表格的每页中的行数。
startPage	Integer	要显示的第一个表格页面（页码从 0 开始）。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

enableRtlTable(rtlEnabled)

添加对从右到左书写的语言（例如，阿拉伯语或希伯来语）的基本支持，方法是 将 0 列放在最右边，最后一列是 最左边的列。

这不会影响底层数据中的列索引，只会影响显示顺序。 表格可视化也不支持完全双向 (BiDi) 语言显示，即使 。如果您启用分页（使用页面选项），或者如果 表格中之所以会显示滚动条，是因为您指定的高度和宽度选项小于 所需的表大小。默认行为是停用 RTL 支持。

参数

名称	类型	说明
rtlEnabled	Boolean	true（如果应启用从右到左支持），false 否则。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

enableSorting(enableSorting)

设置是否在用户点击列标题时对列进行排序。

如果启用了排序功能，那么当用户点击列标题时，系统会自动显示相应的行 已排序。默认行为是启用排序。

参数

名称	类型	说明
enableSorting	Boolean	true 表示点击列标题可排序，否则 false。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

getChartType()

返回当前图表类型。

返回

ChartType - 图表类型

---

getContainer()

返回图表 ContainerInfo，其中包含图表在 工作表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var 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()
var containerInfo = chartBuilder.getContainer();

// Logs the values we 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) 修改此列表。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var chartBuilder = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(sheet.getRange("A1:B8"))
    .setPosition(5, 5, 0, 0);

var ranges = chartBuilder.getRanges();

// There's only one range as a data source for this chart,
// so this logs "A1:B8"
for (var i in ranges) {
  var range = ranges[i];
  Logger.log(range.getA1Notation());
}

返回

Range[] - 一系列范围，用作要构建的图表的数据源

---

removeRange(range)

从此构建器修改的图表中移除指定范围。如果存在以下情况，则不会抛出错误： 范围不在此图表中。

移除的范围必须与通过 addRange(range) 添加的范围一致； 否则，图表不会发生任何更改。此方法不能用于仅移除部分值 范围。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var firstRange = sheet.getRange("A1:B5");
var secondRange = sheet.getRange("A6:B8");

var chartBuilder = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(firstRange)
    // This range will render 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
// will not be removed, and will not throw an exception
chartBuilder.removeRange(firstRange);
chartBuilder.removeRange(sheet.getRange("A6:B8"));

var chart = chartBuilder.build();

sheet.insertChart(chart);

参数

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

返回

EmbeddedChartBuilder - 此构建器，用于链接

---

setChartType(type)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

参数

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

返回

EmbeddedChartBuilder - 此构建器，用于链接

---

setFirstRowNumber(number)

设置数据表中第一行的行号。

第一行的默认行号为 1。

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

参数

名称	类型	说明
number	Integer	数据表中第一行的行号。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

setHiddenDimensionStrategy(strategy)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var 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 - 此构建器，用于链接

---

setInitialSortingAscending(column)

设置最初对表进行排序时所依据的列索引 （升序）。

“os”列已按升序排序，并标有小箭头表示。

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

参数

名称	类型	说明
column	Integer	最初对表格进行排序所依据的列的编号。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

setInitialSortingDescending(column)

设置最初对表进行排序时所依据的列索引 （降序）。

“os”列已按降序排序，并标有一个小箭头表示。

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

参数

名称	类型	说明
column	Integer	最初对表格进行排序所依据的列的编号。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

setMergeStrategy(mergeStrategy)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B10");
var range2 = sheet.getRange("C:C10");
var 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)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var 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)

设置此图表的高级选项。要查看可用选项的列表，请参阅图表 配置选项。

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

以下示例展示了如何更改标题和设置图例。

builder.setOption('title', 'Earnings projections');
builder.setOption('legend', {position: 'top', textStyle: {color: 'blue', fontSize: 16}});

参数

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

返回

EmbeddedChartBuilder - 此构建器，用于链接。

---

setPosition(anchorRowPos, anchorColPos, offsetX, offsetY)

设置位置，以更改图表在工作表中的显示位置。anchorRowPos和 anchorColPos 从 1 开始计数。

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var 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 - 此构建器，用于链接

---

setTransposeRowsAndColumns(transpose)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:B5");
var chart = sheet.newChart()
    .setChartType(Charts.ChartType.BAR)
    .addRange(range)
    .setTransposeRowsAndColumns(true)
    .setPosition(5, 5, 0, 0)
    .build();

sheet.insertChart(chart);

参数

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

返回

EmbeddedChartBuilder - 此构建器，用于链接

---

showRowNumberColumn(showRowNumber)

设置是否将行号显示为表的第一列。

默认行为是不显示行号。

参数

名称	类型	说明
showRowNumber	Boolean	如果表的第一列应显示行号，则为 true； 否则为 false。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。

---

useAlternatingRowStyle(alternate)

设置是否为表格图表的奇数行和偶数行分配交替颜色样式。

默认行为是行具有交替颜色样式。

参数

名称	类型	说明
alternate	Boolean	如果颜色样式应该是交替的，则为 true，否则为 false。

返回

EmbeddedTableChartBuilder - 此构建器，用于链接。