Class TableChartBuilder

TableChartBuilder

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

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

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

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

var 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.
var 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.
var builder = Charts.newTableChart();
builder.enablePaging(5, 2);

参数

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

返回

TableChartBuilder - 此构建器对于链接非常有用。


enableRtlTable(rtlEnabled)

通过逆转表的列顺序来添加对从右到左书写的语言(例如阿拉伯语或希伯来语)的基本支持,以使第 0 列是最右列,最后一列是最左列。

这不会影响底层数据中的列索引,仅影响显示顺序。表可视化不支持完整的双向 (BiDi) 语言显示,即使使用此选项也是如此。如果您启用分页功能(使用页面选项),或者表具有滚动条(因为您指定的高度和宽度选项小于要求的表大小),此选项将被忽略。默认行为是停用 RTL 支持。

参数

名称类型说明
rtlEnabledBooleantrue(如果应启用从右到左支持),否则为 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.
var builder = Charts.newTableChart();
builder.setFirstRowNumber(2);

参数

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

返回

TableChartBuilder - 此构建器对于链接非常有用。


setInitialSortingAscending(column)

设置应最初对表进行排序(升序)的列索引。

该操作系统按升序排序,并标有小箭头。

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

参数

名称类型说明
columnInteger最初应按哪个列对表进行排序。

返回

TableChartBuilder - 此构建器对于链接非常有用。


setInitialSortingDescending(column)

设置应最初对表进行排序(降序)的列的索引。

该操作系统按降序排序,并带有一个小箭头进行标记。

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

参数

名称类型说明
columnInteger最初应按哪个列对表进行排序。

返回

TableChartBuilder - 此构建器对于链接非常有用。


setOption(option, value)

设置此图表的高级选项。请参阅此图表的可用选项。如果指定的选项无效,此方法无效。

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

参数

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

返回

TableChartBuilder - 此构建器对于链接非常有用。


showRowNumberColumn(showRowNumber)

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

默认行为是不显示行号。

参数

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

返回

TableChartBuilder - 此构建器对于链接非常有用。


useAlternatingRowStyle(alternate)

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

默认行为是颜色交替的行。

参数

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

返回

TableChartBuilder - 此构建器对于链接非常有用。