ColumnMarkerHelper

Defined in: js-api/src/dataframe/column-helpers.ts:135

Constructors

Constructor

new ColumnMarkerHelper(column): ColumnMarkerHelper

Defined in: js-api/src/dataframe/column-helpers.ts:138

Parameters

Parameter	Type
column	Column

Returns

ColumnMarkerHelper

Methods

assign()

assign(category, marker): ColumnMarkerHelper

Defined in: js-api/src/dataframe/column-helpers.ts:143

Draws [category] with [marker] on scatter plots; chainable.

Parameters

Parameter	Type
category	string
marker	"circle" | "dot" | "diamond" | "circle border" | "square" | "square border" | "cross border" | "cross x border" | "outlier" | "diamond border" | "triangle top" | "triangle right" | "triangle bottom" | "triangle left" | "triangle top border" | "triangle right border" | "triangle bottom border" | "triangle left border" | "asterisk" | "star" | "gradient"

Returns

ColumnMarkerHelper

---

default()

default(marker): ColumnMarkerHelper

Defined in: js-api/src/dataframe/column-helpers.ts:153

The marker for every category that assign gave none; chainable.

Parameters

Parameter	Type
marker	"circle" | "dot" | "diamond" | "circle border" | "square" | "square border" | "cross border" | "cross x border" | "outlier" | "diamond border" | "triangle top" | "triangle right" | "triangle bottom" | "triangle left" | "triangle top border" | "triangle right border" | "triangle bottom border" | "triangle left border" | "asterisk" | "star" | "gradient"

Returns

ColumnMarkerHelper

---

reset()

reset(): ColumnMarkerHelper

Defined in: js-api/src/dataframe/column-helpers.ts:172

Returns

ColumnMarkerHelper

---

setAll()

setAll(categoryMarkerMap): ColumnMarkerHelper

Defined in: js-api/src/dataframe/column-helpers.ts:166

Parameters

Parameter	Type
categoryMarkerMap	{[key: string]: "circle" | "dot" | "diamond" | "circle border" | "square" | "square border" | "cross border" | "cross x border" | "outlier" | "diamond border" | "triangle top" | "triangle right" | "triangle bottom" | "triangle left" | "triangle top border" | "triangle right border" | "triangle bottom border" | "triangle left border" | "asterisk" | "star" | "gradient"; }

Returns

ColumnMarkerHelper

---

setMarkerCoding()

setMarkerCoding(category, marker): void

Defined in: js-api/src/dataframe/column-helpers.ts:158

Parameters

Parameter	Type
category	string
marker	"circle" | "dot" | "diamond" | "circle border" | "square" | "square border" | "cross border" | "cross x border" | "outlier" | "diamond border" | "triangle top" | "triangle right" | "triangle bottom" | "triangle left" | "triangle top border" | "triangle right border" | "triangle bottom border" | "triangle left border" | "asterisk" | "star" | "gradient"

Returns

void

Deprecated

Use assign. Removed in 1.29.