Skip to main content

Class: ColumnColorHelper

dg.ColumnColorHelper

Constructors

constructor

new ColumnColorHelper(column)

Parameters

NameType
columnColumn<any>

Defined in

src/dataframe.ts:2313

Properties

column

Private Readonly column: Column<any>

Defined in

src/dataframe.ts:2311

Methods

getColor

getColor(i): number

Parameters

NameType
inumber

Returns

number

Defined in

src/dataframe.ts:2357


getColors

getColors(): Uint32Array

Returns

Uint32Array

Defined in

src/dataframe.ts:2361


getType

getType(): "Categorical" | "Conditional" | "Linear" | "Off"

Returns

"Categorical" | "Conditional" | "Linear" | "Off"

Defined in

src/dataframe.ts:2317


setCategorical

setCategorical(colorMap?): void

Parameters

NameTypeDefault value
colorMapnull | {}null

Returns

void

Defined in

src/dataframe.ts:2340


setConditional

setConditional(rules?): void

Parameters

NameTypeDefault value
rulesnull | { [index: string]: number | string; }null

Returns

void

Defined in

src/dataframe.ts:2346


setLinear

setLinear(range?, options?): void

Enables linear color-coding on a column.

Parameters

NameTypeDefault valueDescription
rangenull | number[]nulllist of palette colors.
optionsnull | { max?: number ; min?: number }nulllist of additional parameters, such as the minimum/maximum value to be used for scaling. Use the same numeric representation as [Column.min] and [Column.max].

Returns

void

Defined in

src/dataframe.ts:2330