Type Alias DataColumn<T>

DataColumn: {
    colorLogScale?: boolean;
    colors?: Colors;
    data?: DataStructureTypes[T];
    datatype: T;
    delimiter?: T extends "multitext" ? string : never;
    dirty?: boolean;
    editable?: boolean;
    field: FieldName;
    getValue: (i: number) => T extends CategoricalDataType ? string : number;
    is_url?: T extends CategoricalDataType ? boolean : never;
    minMax: T extends NumberDataType ? [number, number] : never;
    name: ColumnName;
    quantiles: T extends NumberDataType ? Quantiles : never;
    sgindex?: number;
    sgtype?: "dense" | "sparse";
    stringLength: T extends "unique" ? number : never;
    subgroup?: SubgroupName;
    values: T extends CategoricalDataType ? string[] : never;
}

Type Parameters

Type declaration

  • OptionalcolorLogScale?: boolean

    if true then the colors will be displayed on a log scale- useful if the dataset contains outliers. Because a symlog scale is used the data can contain 0 and negative values

  • Optionalcolors?: Colors

    An array of rgb hex colors. In the case of a "text" column the colors should match the values. For number columns, the list represents colors that will be interpolated. If not specified, default color pallettes will be supplied.

  • Optionaldata?: DataStructureTypes[T]

    In the case of a double/integer (number) column, the array buffer should be the appropriate size to contain float32s. For text it should be Uint8 and contain numbers corresponding to the indexes in the values parameter. For a column of be added later see DataStore#setColumnData. A can be used to represent a column that is known to have loaded data.

  • datatype: T

    the datatype- can be one of

    • "double" - any floating point data
    • "integer" - any integer data
    • "text" - data containing strings but with no more than 256 categories
    • "text16" - data containing strings with up to 65536 categories
    • "unique" - data containing strings but with many categories
    • "multitext" -
  • Optionaldelimiter?: T extends "multitext" ? string : never
  • Optionaldirty?: boolean

    if true then the store will keep a record that this column has been added and is not permanently stored in the backend

  • Optionaleditable?: boolean

    whether the column's data can be changed

  • field: FieldName

    id of the column, used internally

  • getValue: (i: number) => T extends CategoricalDataType ? string : number

    return the value corresponding to a given row index i. If the data is categorical, this will be the appropriate value from values

  • Optionalis_url?: T extends CategoricalDataType ? boolean : never

    the column's values will be displayed as links (text and unique columns only). not sure if this is strictly boolean or can be undefined

  • minMax: T extends NumberDataType ? [number, number] : never

    the min max values in the column's values (integer/double only)

  • name: ColumnName

    human-readable column

  • quantiles: T extends NumberDataType ? Quantiles : never

    an object describing the 0.05,0.01 and 0,001 qunatile ranges (integer/double only)

  • Optionalsgindex?: number
  • Optionalsgtype?: "dense" | "sparse"
  • stringLength: T extends "unique" ? number : never
  • Optionalsubgroup?: SubgroupName
  • values: T extends CategoricalDataType ? string[] : never

Settings

Member Visibility