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();
Methods
Method | Return type | Brief description |
---|---|---|
addColumn(type, label) | DataTableBuilder | Adds a column to the data table. |
addRow(values) | DataTableBuilder | Adds a row to the data table. |
build() | DataTable | Builds and returns a data table. |
setValue(row, column, value) | DataTableBuilder | Sets a specific value in the table. |
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()
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