Class: MarkerMatrix

Experimental

The shared columns and style of a scatter plot matrix. Create cells with createCell; add each to its viewport. Disposing the matrix disposes its remaining cells.

Constructors

Constructor

new MarkerMatrix(
   context,
   columns?,
   style?,
   options?
): MarkerMatrix;

Experimental

Parameters

Parameter	Type	Default value
context	PrimitiveContext	undefined
columns	readonly ArrayLike<number>[]	[]
style	Partial<MarkerMatrixStyle>	{}
options	MarkerSetOptions	{}

Returns

MarkerMatrix

Accessors

cells

Get Signature

get cells(): ReadonlySet<MarkerMatrixCell>;

Experimental

Live cells.

Returns

ReadonlySet<MarkerMatrixCell>

---

colorscaleMode

Get Signature

get colorscaleMode(): boolean;

Experimental

Whether fill colors come from the colorscale (see MarkerSet.colorscaleMode).

Returns

boolean

---

columnCount

Get Signature

get columnCount(): number;

Experimental

Returns

number

---

columnUploads

Get Signature

get columnUploads(): number;

Experimental

Column buffers written so far (one per column per data change): for tests and debugging.

Returns

number

---

count

Get Signature

get count(): number;

Experimental

Points per column (the shortest column's length).

Returns

number

Methods

column()

column(i): object;

Experimental

The shared attribute of column i and its float64 RTC origin.

Parameters

Parameter	Type
i	number

Returns

object

Name	Type
attribute	InstancedBufferAttribute
origin	number

---

createCell()

createCell(
   x,
   y,
   options?
): MarkerMatrixCell;

Experimental

A draw of column x against column y: add it to its viewport (it is a primitive).

Parameters

Parameter	Type
x	number
y	number
options	{ renderOrder?: number; }
options.renderOrder?	number

Returns

MarkerMatrixCell

---

dispose()

dispose(): void;

Experimental

Dispose every cell, the columns and the shared style.

Returns

void

---

setColumns()

setColumns(columns): void;

Experimental

Replace every column (data space, float64 recommended): each is encoded and uploaded once, whatever the number of cells using it. The point count is the shortest column's length.

Parameters

Parameter	Type
columns	readonly ArrayLike<number>[]

Returns

void

---

update()

update(style): void;

Experimental

Update the shared per-point style (like MarkerSet.update without positions).

Parameters

Parameter	Type
style	Partial<MarkerMatrixStyle>

Returns

void