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 - 一个 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)

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

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

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

参数

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

返回

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

setInitialSortingDescending(column)

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

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

// 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 - 此构建器，用于链接。