Skip to main content

ColumnColorHelper

Constructors

new ColumnColorHelper()

new ColumnColorHelper(column): ColumnColorHelper

Parameters

ParameterType
columnColumn<any>

Returns

ColumnColorHelper

Source

src/dataframe.ts:2387

Properties

PropertyModifierType
columnprivateColumn<any>

Methods

getColor()

getColor(i): number

Parameters

ParameterType
inumber

Returns

number

Source

src/dataframe.ts:2439


getColors()

getColors(): Uint32Array

Returns

Uint32Array

Source

src/dataframe.ts:2443


getType()

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

Returns

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

Source

src/dataframe.ts:2391


setCategorical()

setCategorical(colorMap, options): void

Parameters

ParameterTypeDefault value
colorMapnull | objectnull
optionsnull | objectnull

Returns

void

Source

src/dataframe.ts:2414


setConditional()

setConditional(rules): void

Parameters

ParameterTypeDefault value
rulesnull | objectnull

Returns

void

Source

src/dataframe.ts:2424


setDisabled()

setDisabled(): void

Returns

void

Source

src/dataframe.ts:2435


setLinear()

setLinear(range, options): void

Enables linear color-coding on a column.

Parameters

ParameterTypeDefault valueDescription
rangenull | number[]nulllist of palette colors (ARGB integers; see Color).
optionsnull | objectnulllist 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

Source

src/dataframe.ts:2404