Class DataTableBuilder
Stay organized with collections
Save and categorize content based on your preferences.
DataTableBuilder
Builder of DataTable objects. Building a data table consists of first specifying its columns, and
then adding its rows, one at a time. Example:
const data = Charts.newDataTable()
.addColumn(Charts.ColumnType.STRING, 'Month')
.addColumn(Charts.ColumnType.NUMBER, 'In Store')
.addColumn(Charts.ColumnType.NUMBER, 'Online')
.addRow(['January', 10, 1])
.addRow(['February', 12, 1])
.addRow(['March', 20, 2])
.addRow(['April', 25, 3])
.addRow(['May', 30, 4])
.build();
Detailed documentation
addColumn(type, label)
Adds a column to the data table. Columns will be added from 0 to n.
The first column is often used by charts for labels (for instance, X-axis labels on line
charts, or slice labels in pie charts). The other columns are often used for data and therefore
often require numeric values.
Parameters
| Name | Type | Description |
type | ColumnType | type of data in the column (number, string, or date) |
label | String | label of the column (it's used for chart legends). |
Return
DataTableBuilder — this builder, for chaining.
addRow(values)
Adds a row to the data table.
Parameters
| Name | Type | Description |
values | Object[] | values for the row, specified in the same order that the columns are entered. |
Return
DataTableBuilder — this builder, for chaining.
build()
Builds and returns a data table.
Return
DataTable — the data table
Throws
Error — if the data table is empty or otherwise malformed
setValue(row, column, value)
Sets a specific value in the table.
You may set a value before adding the column to the data table. However, unless the column
is added at some point, the value will be ignored.
Not all column values need to be filled in. Those missing will be considered null.
Parameters
| Name | Type | Description |
row | Integer | the row index (the first row has index 0) |
column | Integer | the column index (the first column has index 0) |
value | Object | the value of the table cell (should have the right type for the column). |
Return
DataTableBuilder — this builder, for chaining
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003eDataTableBuilder facilitates the creation of DataTable objects by defining columns and adding rows sequentially.\u003c/p\u003e\n"],["\u003cp\u003eColumns are defined using \u003ccode\u003eaddColumn\u003c/code\u003e with specified data type and label, and rows are added using \u003ccode\u003eaddRow\u003c/code\u003e with corresponding values.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ebuild\u003c/code\u003e method finalizes the DataTable construction and returns the resulting object.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003esetValue\u003c/code\u003e allows modification of individual cell values within the table by specifying row, column, and the new value.\u003c/p\u003e\n"],["\u003cp\u003eDataTableBuilder uses a chaining pattern, where method calls can be linked for streamlined table construction.\u003c/p\u003e\n"]]],[],null,["# Class DataTableBuilder\n\nDataTableBuilder\n\nBuilder of DataTable objects. Building a data table consists of first specifying its columns, and\nthen adding its rows, one at a time. Example:\n\n```javascript\nconst data = Charts.newDataTable()\n .addColumn(Charts.ColumnType.STRING, 'Month')\n .addColumn(Charts.ColumnType.NUMBER, 'In Store')\n .addColumn(Charts.ColumnType.NUMBER, 'Online')\n .addRow(['January', 10, 1])\n .addRow(['February', 12, 1])\n .addRow(['March', 20, 2])\n .addRow(['April', 25, 3])\n .addRow(['May', 30, 4])\n .build();\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------------------------|-------------------------------------------------------|-------------------------------------|\n| [addColumn(type, label)](#addColumn(ColumnType,String)) | [DataTableBuilder](#) | Adds a column to the data table. |\n| [addRow(values)](#addRow(Object)) | [DataTableBuilder](#) | Adds a row to the data table. |\n| [build()](#build()) | [DataTable](/apps-script/reference/charts/data-table) | Builds and returns a data table. |\n| [setValue(row, column, value)](#setValue(Integer,Integer,Object)) | [DataTableBuilder](#) | Sets a specific value in the table. |\n\nDetailed documentation\n----------------------\n\n### `add``Column(type, label)`\n\nAdds a column to the data table. Columns will be added from 0 to n.\n\nThe first column is often used by charts for labels (for instance, X-axis labels on line\ncharts, or slice labels in pie charts). The other columns are often used for data and therefore\noften require numeric values.\n\n#### Parameters\n\n| Name | Type | Description |\n|---------|---------------------------------------------------------|------------------------------------------------------|\n| `type` | [ColumnType](/apps-script/reference/charts/column-type) | type of data in the column (number, string, or date) |\n| `label` | `String` | label of the column (it's used for chart legends). |\n\n#### Return\n\n\n[DataTableBuilder](#) --- this builder, for chaining.\n\n*** ** * ** ***\n\n### `add``Row(values)`\n\nAdds a row to the data table.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------|------------|-------------------------------------------------------------------------------|\n| `values` | `Object[]` | values for the row, specified in the same order that the columns are entered. |\n\n#### Return\n\n\n[DataTableBuilder](#) --- this builder, for chaining.\n\n*** ** * ** ***\n\n### `build()`\n\nBuilds and returns a data table.\n\n#### Return\n\n\n[DataTable](/apps-script/reference/charts/data-table) --- the data table\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the data table is empty or otherwise malformed\n\n*** ** * ** ***\n\n### `set``Value(row, column, value)`\n\nSets a specific value in the table.\n\nYou may set a value before adding the column to the data table. However, unless the column\nis added at some point, the value will be ignored.\n\nNot all column values need to be filled in. Those missing will be considered `null`.\n\n#### Parameters\n\n| Name | Type | Description |\n|----------|-----------|--------------------------------------------------------------------------|\n| `row` | `Integer` | the row index (the first row has index 0) |\n| `column` | `Integer` | the column index (the first column has index 0) |\n| `value` | `Object` | the value of the table cell (should have the right type for the column). |\n\n#### Return\n\n\n[DataTableBuilder](#) --- this builder, for chaining"]]
