ColumnColorHelper

Constructors

new ColumnColorHelper()

new ColumnColorHelper(column): ColumnColorHelper

Parameters

Parameter	Type
column	Column<any, any>

Returns

ColumnColorHelper

Source

src/dataframe.ts:2552

Properties

Property	Modifier	Type
column	private	Column<any, any>

Methods

_setOutOfRangeLinearColors()

private _setOutOfRangeLinearColors(belowMinColor?, aboveMaxColor?): void

Parameters

Parameter	Type
belowMinColor?	string
aboveMaxColor?	string

Returns

void

Source

src/dataframe.ts:2564

---

getColor()

getColor(i): number

Parameters

Parameter	Type
i	number

Returns

number

Source

src/dataframe.ts:2629

---

getColors()

getColors(): Uint32Array

Returns

Uint32Array

Source

src/dataframe.ts:2633

---

getType()

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

Returns

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

Source

src/dataframe.ts:2556

---

setCategorical()

setCategorical(colorMap, options): void

Parameters

Parameter	Type	Default value
colorMap	null | object	null
options	null | object	null

Returns

void

Source

src/dataframe.ts:2604

---

setConditional()

setConditional(rules): void

Parameters

Parameter	Type	Default value
rules	null | object	null

Returns

void

Source

src/dataframe.ts:2614

---

setDisabled()

setDisabled(): void

Returns

void

Source

src/dataframe.ts:2625

---

setLinear()

setLinear(range, options): void

Enables linear color-coding on a column.

Parameters

Parameter	Type	Default value	Description
range	null | number[]	null	list of palette colors (ARGB integers; see Color).
options	null | object	null	list of additional parameters, such as the minimum/maximum value to be used for scaling and the colors for values below the minimum and above the maximum. Use the same numeric representation as [Column.min] and [Column.max].

Returns

void

Source

src/dataframe.ts:2576

---

setLinearAbsolute()

setLinearAbsolute(valueColors, options): void

Enables linear color-coding on a column with absolute values.

Parameters

Parameter	Type	Default value	Description
valueColors	object	undefined	dictionary of numerical values and hex-colors.
options	null | object	null	list of additional parameters, such as the colors for values below the minimum and above the maximum. See samples: https://public.datagrok.ai/js/samples/grid/color-coding/color-coding}

Returns

void

Source

src/dataframe.ts:2593