Class TableChartBuilder

图表构建器

表格图表的构建器。如需了解详情,请参阅 Google 图表文档

以下示例展示了如何构建表格图。数据是从 Google 电子表格导入的。

// Get sample data from a spreadsheet.
const dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=A1%3AF' +
    '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=4&headers=-1';

const chartBuilder = Charts.newTableChart()
                         .setDimensions(600, 500)
                         .enablePaging(20)
                         .setDataSourceUrl(dataSourceUrl);

const chart = chartBuilder.build();

方法

方法返回类型简介
build()Chart构建图表。
enablePaging(enablePaging)TableChartBuilder设置是否启用数据分页。
enablePaging(pageSize)TableChartBuilder启用分页并设置每页的行数。
enablePaging(pageSize, startPage)TableChartBuilder启用分页,设置每页的行数以及要显示的表格第一页(页码从零开始)。
enableRtlTable(rtlEnabled)TableChartBuilder通过将表格的列顺序反转,为从右到左书写的语言(例如阿拉伯语或希伯来语)添加了基本支持,这样,第 0 列就是最右列,最后一列就是最左列。
enableSorting(enableSorting)TableChartBuilder设置在用户点击列标题时是否对列进行排序。
setDataSourceUrl(url)TableChartBuilder设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。
setDataTable(tableBuilder)TableChartBuilder使用 DataTableBuilder 设置要用于图表的数据表。
setDataTable(table)TableChartBuilder设置包含图表线条和 X 轴标签的数据表。
setDataViewDefinition(dataViewDefinition)TableChartBuilder设置要用于图表的数据视图定义。
setDimensions(width, height)TableChartBuilder设置图表的尺寸。
setFirstRowNumber(number)TableChartBuilder设置数据表格中第一行的行号。
setInitialSortingAscending(column)TableChartBuilder设置应按其对表格进行初始排序(升序)的列的索引。
setInitialSortingDescending(column)TableChartBuilder设置应按其对表格进行初始排序(降序)的列的索引。
setOption(option, value)TableChartBuilder设置此图表的高级选项。
showRowNumberColumn(showRowNumber)TableChartBuilder设置是否将行号显示为表格的第一个列。
useAlternatingRowStyle(alternate)TableChartBuilder设置是否为表格图表的奇数行和偶数行分配交替颜色样式。

详细文档

build()

构建图表。

返回

Chart - 图表对象,可嵌入到文档、界面元素中,或用作静态图片。


enablePaging(enablePaging)

设置是否启用数据分页。

默认行为是停用分页。如果启用了分页,默认页面大小为 10。

参数

名称类型说明
enablePagingBoolean如果应启用分页,则为 true;否则为 false

返回

TableChartBuilder - 此构建器适用于链接。


enablePaging(pageSize)

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

默认页面大小为 10。

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

参数

名称类型说明
pageSizeInteger表的每页行数。

返回

TableChartBuilder - 此构建器适用于链接。


enablePaging(pageSize, startPage)

启用分页,设置每页的行数以及要显示的表格第一页(页码从零开始)。

默认页面大小为 10,默认起始页为 0。

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

参数

名称类型说明
pageSizeInteger表的每页行数。
startPageInteger要显示的表格的第一页(页码从 0 开始)。

返回

TableChartBuilder - 此构建器适用于链接。


enableRtlTable(rtlEnabled)

通过将表格的列顺序反转,为从右到左书写的语言(例如阿拉伯语或希伯来语)添加了基本支持,这样,第 0 列就是最右列,最后一列就是最左列。

这不会影响底层数据中的列编号,只会影响显示顺序。表格可视化图表不支持完整的双向 (BiDi) 语言显示,即使启用此选项也是如此。如果您启用了分页(使用“页面”选项),或者由于您指定的高度和宽度选项小于所需的表格大小而导致表格带有滚动条,则系统会忽略此选项。默认行为是停用 RTL 支持。

参数

名称类型说明
rtlEnabledBoolean如果应启用从右到左的支持,则为 true;否则,为 false

返回

TableChartBuilder - 此构建器适用于链接。


enableSorting(enableSorting)

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

如果启用了排序功能,当用户点击列标题时,系统会自动对行进行排序。默认行为是启用排序。

参数

名称类型说明
enableSortingBooleantrue 表示启用点击列标题进行排序,否则为 false

返回

TableChartBuilder - 此构建器适用于链接。


setDataSourceUrl(url)

设置用于从外部来源(例如 Google 表格)提取数据的数据源网址。如果同时提供了数据源网址和 DataTable,系统会忽略数据源网址。

如需详细了解如何查询数据源,请参阅 Google 图表文档

参数

名称类型说明
urlString数据源网址,包括所有查询参数。

返回

TableChartBuilder - 此构建器适用于链接。


setDataTable(tableBuilder)

使用 DataTableBuilder 设置要用于图表的数据表。这是一个便捷方法,可用于设置数据表,而无需调用 build()

参数

名称类型说明
tableBuilderDataTableBuilder数据表构建器。在此调用过程中,系统会立即创建一个新的数据表格,因此对构建器的任何进一步更新都不会反映在图表中。

返回

TableChartBuilder - 此构建器适用于链接。


setDataTable(table)

设置包含图表线条和 X 轴标签的数据表。第一列应为字符串,并包含水平轴标签。后面可以跟任意数量的列,所有列都必须是数字。每个列都会显示为单独的一行。

参数

名称类型说明
tableDataTableSource要用于图表的数据表。

返回

TableChartBuilder - 此构建器适用于链接。


setDataViewDefinition(dataViewDefinition)

设置要用于图表的数据视图定义。

参数

名称类型说明
dataViewDefinitionDataViewDefinition数据视图定义对象,用于定义应从给定数据源派生以用于图表绘制的视图。

返回

TableChartBuilder - 此构建器适用于链接。


setDimensions(width, height)

设置图表的尺寸。

参数

名称类型说明
widthInteger图表的宽度(以像素为单位)。
heightInteger图表的高度(以像素为单位)。

返回

TableChartBuilder - 此构建器适用于链接。


setFirstRowNumber(number)

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

第一行的默认行号为 1。

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

参数

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

返回

TableChartBuilder - 此构建器适用于链接。


setInitialSortingAscending(column)

设置应按其对表格进行初始排序(升序)的列的索引。

该列已按升序排列,并带有一个小箭头指示这一点。

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

参数

名称类型说明
columnInteger应按其对表格进行初始排序的列的编号。

返回

TableChartBuilder - 此构建器适用于链接。


setInitialSortingDescending(column)

设置应按其对表格进行初始排序(降序)的列的索引。

该列已按降序排列,并带有一个小箭头来指明这一点。

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

参数

名称类型说明
columnInteger应按其对表格进行初始排序的列的编号。

返回

TableChartBuilder - 此构建器适用于链接。


setOption(option, value)

设置此图表的高级选项。请参阅此图表的可用选项。如果指定的选项无效,此方法将不会产生任何影响。

// Build a table chart which renders HTML.
const builder = Charts.newTableChart();
builder.setOption('allowHtml', {@code true});
const chart = builder.build();

参数

名称类型说明
optionString要设置的选项。
valueObject要设置的值。

返回

TableChartBuilder - 此构建器适用于链接。


showRowNumberColumn(showRowNumber)

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

默认行为是不会显示行号。

参数

名称类型说明
showRowNumberBoolean如果表格的第一列应显示行号,则为 true;否则为 false

返回

TableChartBuilder - 此构建器适用于链接。


useAlternatingRowStyle(alternate)

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

默认行为是行采用交替颜色样式。

参数

名称类型说明
alternateBoolean如果颜色样式应交替,则为 true;否则为 false

返回

TableChartBuilder - 此构建器适用于链接。