ITableColumn | API Documentation for SciChart.js

A named column of tabular data. String columns are dictionary-encoded into native storage; numeric columns are stored in WASM vectors.

Hierarchy

ITableColumn

Index

Properties

name

name: string

The name of the column. Used to address the column via BaseDataSeries.getYValuesByName (numeric) or BaseDataSeries.getTextAt/BaseDataSeries.getStringValuesCopy (string).

Optional type

type: EColumnType

What the values MEAN — see EColumnType. Optional; when given it also DECIDES the column's EColumnStorage via storageForColumnType, rather than the storage being inferred from typeof values[0].

remarks: That is what lets a string column be declared with values: []. Inference cannot see a type in an empty array, so without a declared type an empty string column would be created as a numeric one and every later text write would be lost — the reason consumers used to seed a throwaway first row.
remarks: Declaring a type whose storage disagrees with the values supplied THROWS at construction.

values

values: NumberArray | string[]

The column values. A numeric column is stored as a WASM vector; a string column is encoded into a native dictionary-backed store (see {@link StringColumnStore}).

remarks: Numeric columns are copied into WASM and are not aliased. String-column arrays are also copied on the way in (encoded into codes) — the passed array is not aliased and safe to mutate afterwards.