Class ColumnBuilder<T>

Type Parameters

T extends IColumnDesc = IColumnDesc

Hierarchy (View Summary)

ColumnBuilder

Index

Constructors

Properties

Methods

asArray asMap build color custom description frozen hidden htmlLabel htmlSummary label renderer summary width

Constructors

constructor

new ColumnBuilder<T extends IColumnDesc = IColumnDesc>(
type: string,
column: string,
): ColumnBuilder<T>
Type Parameters
- T extends IColumnDesc = IColumnDesc
Parameters
- type: string
- column: string
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:6

Properties

`Protected` `Readonly`desc

desc: T

Methods

asArray

asArray(labels?: number | string[]): ColumnBuilder<T>
converts the column type to be an array type, supports only base types: boolean, categorical, date, number, and string
Parameters
- Optionallabels: number | string[]
  labels to use for each array item or the expected length of an value
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:109

asMap

asMap(): ColumnBuilder<T>
converts the column type to be a map type, supports only base types: categorical, date, number, and string

Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:125

build

build(_data: any[]): T
build the column description
Parameters
- _data: any[]
Returns T
- Defined in builder/column/ColumnBuilder.ts:134

color

color(_color: string): ColumnBuilder<T>
sets the column color in case of numerical columns
Parameters
- _color: string
Returns ColumnBuilder<T>
Deprecated
use colorMapping in the number case instead
- Defined in builder/column/ColumnBuilder.ts:101

custom

custom(key: string, value: any): ColumnBuilder<T>
specify a custom additional attribute for the description
Parameters
- key: string
  the property key
- value: any
  its value
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:84

description

description(description: string): ColumnBuilder<T>
column description
Parameters
- description: string
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:47

frozen

frozen(): ColumnBuilder<T>
sets the frozen state of this column, i.e is sticky to the left side when scrolling horizontally

Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:55

hidden

hidden(): ColumnBuilder<T>
hide this column by default

Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:26

htmlLabel

htmlLabel(label: string, render?: IStyleHTMLWrapper): ColumnBuilder<T>
Parameters
- label: string
- Optionalrender: IStyleHTMLWrapper
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:17

htmlSummary

htmlSummary(label: string, render?: IStyleHTMLWrapper): ColumnBuilder<T>
Parameters
- label: string
- Optionalrender: IStyleHTMLWrapper
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:38

label

label(label: string): ColumnBuilder<T>
column label
Parameters
- label: string
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:13

renderer

renderer(
    renderer?: string,
    groupRenderer?: string,
    summaryRenderer?: string,
): ColumnBuilder<T>
specify the renderer to used for this column
Parameters
- Optionalrenderer: string
  within a cell
- OptionalgroupRenderer: string
  within an aggregated cell
- OptionalsummaryRenderer: string
  within the summary in the header and side panel
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:66

summary

summary(summary: string): ColumnBuilder<T>
column summary text (subtitle)
Parameters
- summary: string
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:34

width

width(width: number): ColumnBuilder<T>
sets the default width of the column
Parameters
- width: number
Returns ColumnBuilder<T>
- Defined in builder/column/ColumnBuilder.ts:92