Maps API for JavaScript Developer's Guide

H.service.extension.dataView.ITable

Interface Summary

An interface to provide access to two-dimensional rectangular data structures such as PDE and CLE data. It uses two generic types:

[ For full details, see the Interface Details ]

Method Summary

Table 1. Methods
Methods
`getMeta () : {M}` To get meta information of the table.
`getRowCount () : {!number}` To get the number of rows
`getRow (rowIndex) : {(!H.service.extension.dataView.IRow<C> \| undefined)}` To get the row at the given index.
`getColumnNames () : {!Array<string>}` To get a ordered list of all column names.
`getColumn (columnName) : {(!H.service.extension.dataView.IColumn<C> \| undefined)}` To get the column with the given name.
`getCell (rowIndex, columnName) : {(C \| undefined)}` To get the cell value at the given row index and named column
`concat (var_args) : {!H.service.extension.dataView.ITable<C, M>}` To merge two ore more tables. It doesn't change the existing table, but instead returns a new one. The concat method creates a new ITable consisting of the rows in the object on which it is called, followed in order by, for each argument, the rows of that argument. in the arguments list.

Interface Description

An interface to provide access to two-dimensional rectangular data structures such as PDE and CLE data. It uses two generic types:

C: The type for all cell values
M: The type for the meta information

Method Details

getMeta () : {M}

To get meta information of the table.

Returns:
: {M}

getRowCount () : {!number}

To get the number of rows

Returns:
: {!number}

getRow (rowIndex) : {(!H.service.extension.dataView.IRow<C> | undefined)}

To get the row at the given index.

Parameters:
rowIndex:: {number}
: The zero-based index of the row.

Returns:
: {(!H.service.extension.dataView.IRow<C> | undefined)}
: The specified row or undefined if the given row index is out of range.

getColumnNames () : {!Array<string>}

To get a ordered list of all column names.

Returns:
: {!Array<string>}
: the list of the column names.

getColumn (columnName) : {(!H.service.extension.dataView.IColumn<C> | undefined)}

To get the column with the given name.

Parameters:
columnName:: {string}
: The name of the column.

Returns:
: {(!H.service.extension.dataView.IColumn<C> | undefined)}
: The specified column or undefined if no column with the given name exists.

getCell (rowIndex, columnName) : {(C | undefined)}

To get the cell value at the given row index and named column

Parameters:
rowIndex:: {number}
: The zero-based index of the cell's row.
columnName:: {string}
: The name of the cell's column.

Returns:
: {(C | undefined)}
: The value of the specified cell or undefined if the given row index is out of range or a column of the given name doesn't exists.

concat (var_args) : {!H.service.extension.dataView.ITable<C, M>}

To merge two ore more tables. It doesn't change the existing table, but instead returns a new one. The concat method creates a new ITable consisting of the rows in the object on which it is called, followed in order by, for each argument, the rows of that argument. in the arguments list.

Parameters:
var_args:: {...!H.service.extension.dataView.ITable<C, M>}
: Tables to concatenate into a new table.

Returns:
: {!H.service.extension.dataView.ITable<C, M>}
: the resulting table.

Throws:
: {H.lang.InvalidArgumentError}
: if the tables have a different columns.