Class Table<V>

columnCount

• get columnCount(): number

  Return the maximum number of columns in any row

  Returns number

rowCount

• get rowCount(): number

  Return the number of rows

  Returns number

constructor

• new Table<V>(): Table<V>

  Type Parameters

  • V

  Returns Table<V>

appendRow

• appendRow(...data: TableValue<V>[]): TableRow<V>

  Adds a new row

  Parameters

  • ...data: TableValue<V>[]

    Columns

  Returns TableRow<V>

asArray

• asArray(): (undefined | V)[][]

  Return a copy of table as nested array

  const t = new Table();
  // add stuff
  // ...
  const m = t.asArray();
  for (const row of m) {
   for (const colValue of row) {
     // iterate over all column values for this row
   }
  }
  Copy

  Alternative: get value at row Y and column X

  const value = m[y][x];
  Copy

  Returns (undefined | V)[][]

get

• get(row: string | number, column: string | number): TableValue<V>

  Gets the value at a specified row and column. Throws an error if coordinates are out of range or missing.

  Parameters

  • row: string | number

    Row index or label
  • column: string | number

    Column index or label

  Returns TableValue<V>

getColumnLabelIndex

• getColumnLabelIndex(label: string): undefined | number

  Gets the label for a given column index, returning undefined if not found.

  Case-sensitive

  Parameters

  • label: string

    Label to seek

  Returns undefined | number

  Index of column, or undefined if not found

getRowLabelIndex

• getRowLabelIndex(label: string): undefined | number

  Gets the label for a given row index, returning undefined if not found.

  Case-sensitive

  Parameters

  • label: string

    Label to seek

  Returns undefined | number

  Index of row, or undefined if not found

getRowWithLabelsArray

• getRowWithLabelsArray(rowIndex: number): undefined | [label: string, value: V][]

  Gets a row along with labels, as an array

  Parameters

  • rowIndex: number

  Returns undefined | [label: string, value: V][]

getRowWithLabelsObject

• getRowWithLabelsObject(rowIndex: number): undefined | object

  Return a row of objects. Keys use the column labels.

  const row = table.getRowWithLabelsObject(10);
  // eg:
  // [{ colour: red, size: 10}, { colour: blue, size: 20 }]
  Copy

  Parameters

  • rowIndex: number

  Returns undefined | object

labelColumn

• labelColumn(columnIndex: number, label: string): void

  Assign label to a specific column First column has an index of 0

  Parameters

  • columnIndex: number
  • label: string

  Returns void

labelColumns

• labelColumns(...labels: string[]): void

  Assign labels to columns

  Parameters

  • ...labels: string[]

  Returns void

labelRow

• labelRow(rowIndex: number, label: string): void

  Assign label to a specific row First row has an index of 0

  Parameters

  • rowIndex: number
  • label: string

  Returns void

labelRows

• labelRows(...labels: string[]): void

  Label rows

  Parameters

  • ...labels: string[]

    Labels

  Returns void

print

• print(): void

  Dumps the values of the table to the console

  Returns void

row

• row(row: string | number): undefined | readonly (undefined | V)[]

  Gets a copy of values at given row, specified by index or label

  Parameters

  • row: string | number

  Returns undefined | readonly (undefined | V)[]

  Returns row or throws an error if label or index not found

rowsWithLabelsArray

• rowsWithLabelsArray(): Generator<
      undefined
      | [label: string, value: V][],
      void,
      unknown,
  >

  Iterates over each row, including the labels if available

  Returns Generator<undefined | [label: string, value: V][], void, unknown>

  See

  rowsWithLabelsObject to get rows in object format

rowsWithLabelsObject

• rowsWithLabelsObject(): Generator<undefined | object, void, unknown>

  Iterates over the table row-wise, in object format.

  Returns Generator<undefined | object, void, unknown>

  See

  rowsWithLabelsArray to get rows in array format

set

• set(row: string | number, column: string | number, value: undefined | V): void

  Set the value of row,columm. Row is created if it doesn't exist, with the other column values being undefined

  Parameters

  • row: string | number

    Index or label
  • column: string | number

    Column
  • value: undefined | V

    Value to set at row,column

  Returns void

setRow

• setRow(row: string | number, value: undefined | V, length?: number): TableRow<V>

  Set all the columns of a row to a specified value.

  By default, sets the number of columns corresponding to the table's maximum column length. To set an arbitrary length of the row, use length

  Parameters

  • row: string | number

    Index or label of row
  • value: undefined | V

    Value to set
  • Optionallength: number

    How wide the row is. If unset, uses the current maximum width of rows.

  Returns TableRow<V>

colLabels

columnMaxLength

rowLabels

rows