Class Table<T>

Two-dimensional table class supporting column and row headers.

Type Parameters

T

The type of the data in the table.

Hierarchy

Table

Index

Constructors

Properties

_colIndexMap _data _headers

Accessors

data headers numColumns numRows

Methods

assertRowValidLength get set toArray toJSON fromJSON

Constructors

constructor

new Table<T>(data, headers?): Table<T>
Creates a new Table.
Type Parameters
- T
Parameters
- data: T[][]
  
  The data of the table.
- Optional headers: string[]
  
  The headers of the table.
Returns Table<T>
- Defined in packages/table/src/lib/Table.ts:37

Properties

`Protected` _colIndexMap

_colIndexMap: Record<string, number> = {}

Map from column names to column indices.

`Protected` _data

_data: T[][] = []

The data of the table.

`Protected` _headers

_headers: string[]

The headers of the table.

Accessors

data

get data(): T[][]
Returns the table as a two-dimensional array, without column headers.

Returns T[][]
- Defined in packages/table/src/lib/Table.ts:90

headers

get headers(): string[]
Gets the column headers.

Returns string[]
- Defined in packages/table/src/lib/Table.ts:83

numColumns

get numColumns(): number
Gets the number of cols in the table, not including headers.

Returns number
- Defined in packages/table/src/lib/Table.ts:69

numRows

get numRows(): number
Gets the number of rows in the table, not including headers.

Returns number
- Defined in packages/table/src/lib/Table.ts:76

Methods

`Protected` assertRowValidLength

assertRowValidLength(row): void
Checks if a row has the correct length.
Parameters
- row: T[]
  
  The row to check.
Returns void
- Defined in packages/table/src/lib/Table.ts:62

get

get(column, row): T
Returns a value at a given (row, col) position.
Parameters
- column: string | number
  
  Column index or name
- row: number
  
  Row index
Returns T
- Defined in packages/table/src/lib/Table.ts:99

set

set(column, row, value): Table<T>
Inserts a given value at a given (row, col) position.
Parameters
- column: string | number
  
  Column index
- row: number
  
  Row index
- value: T
  
  The value to insert
Returns Table<T>
- Defined in packages/table/src/lib/Table.ts:112

toArray

toArray(): (string | T)[][]
Returns the table as a two-dimensional array, including row and column headers..

Returns (string | T)[][]
- Defined in packages/table/src/lib/Table.ts:123

toJSON

toJSON(): ITableSerialized<T>
Override of the native toJSON method. When parsing the returned json string, it can be revived as a Table object when using the static Table.fromJSON method.

Returns ITableSerialized<T>
- Defined in packages/table/src/lib/Table.ts:131

`Static` fromJSON

fromJSON<T>(json): Table<T>
Revive a stringified Table object.
Type Parameters
- T
Parameters
- json: string
  
  a stringified Table object.
Returns Table<T>
- Defined in packages/table/src/lib/Table.ts:27

Generated using TypeDoc