Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CategoricalColumnBuilder

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

asArray

  • asArray(labels?: string[] | number): this

  • converts the column type to be an array type, supports only base types: boolean, categorical, date, number, and string

    Parameters

    • Optional labels: string[] | number

      labels to use for each array item or the expected length of an value

    Returns this

asMap

  • asMap(): this

asOrdinal

  • asOrdinal(): this

asSet

  • asSet(separator?: undefined | string): this

  • converts this type to a set column, i.e. multiple unique category in a value

    Parameters

    • Optional separator: undefined | string

      optional separator separating a string value

    Returns this

build

categories

  • categories(categories: (string | object)[]): this

color

  • color(color: string): this

custom

  • custom(key: string, value: any): this

description

  • description(description: string): this

frozen

  • frozen(): this

label

  • label(label: string): this

missingCategory

  • missingCategory(missingCategory: string | object): this

renderer

  • renderer(renderer?: undefined | string, groupRenderer?: undefined | string, summaryRenderer?: undefined | string): this

  • specify the renderer to used for this column

    Parameters

    • Optional renderer: undefined | string

      within a cell

    • Optional groupRenderer: undefined | string

      within an aggregated cell

    • Optional summaryRenderer: undefined | string

      within the summary in the header and side panel

    Returns this

width

  • width(width: number): this