Class: TwoDataLayer

Defined in: layers.ts:1707

Layer with two data values mapped to a 2D colormap.

Maps two scalar fields (X and Y) to colors using a 2D colormap texture. Useful for visualizing relationships between variables, such as:

• Effect size (X) vs. statistical confidence (Y)
• Activation magnitude (X) vs. significance (Y)
• Any two correlated or independent scalar fields

Example

const layer = new TwoDataLayer(
  'effect-confidence',
  effectSizeData,    // X values
  confidenceData,    // Y values
  indices,
  'confidence',      // 2D colormap preset
  {
    rangeX: [-2, 2],
    rangeY: [0, 1],
    thresholdY: [0, 0.05]  // Hide low-confidence values
  }
);

Extends

• Layer

Constructors

Constructor

new TwoDataLayer(
   id, 
   dataX, 
   dataY, 
   indices, 
   colorMap, 
   config?
): TwoDataLayer;

Defined in: layers.ts:1721

Parameters

id

string

dataX

Float32Array<ArrayBufferLike> | number[]

dataY

Float32Array<ArrayBufferLike> | number[]

indices

number[] | Uint32Array<ArrayBufferLike> | null

colorMap

| ColorMap2DPreset | ColorMap2D

config?

TwoDataLayerConfig = {}

Returns

TwoDataLayer

Overrides

Layer.constructor

Properties

id

id: string;

Defined in: layers.ts:294

Inherited from

Layer.id

---

visible

visible: boolean;

Defined in: layers.ts:295

Inherited from

Layer.visible

---

opacity

opacity: number;

Defined in: layers.ts:296

Inherited from

Layer.opacity

---

blendMode

blendMode: BlendMode;

Defined in: layers.ts:297

Inherited from

Layer.blendMode

---

needsUpdate

needsUpdate: boolean;

Defined in: layers.ts:298

Inherited from

Layer.needsUpdate

---

_onChangeCallback

_onChangeCallback: ((changes) => void) | null;

Defined in: layers.ts:300

Callback set by the parent surface to propagate observable layer changes.

Inherited from

Layer._onChangeCallback

---

is2DLayer

readonly is2DLayer: boolean = true;

Defined in: layers.ts:1719

Flag to identify this as a 2D data layer for GPU compositor

Accessors

order

Get Signature

get order(): number;

Defined in: layers.ts:343

Numeric initialization hint used when this layer first enters a stack. Runtime ordering is owned exclusively by LayerStack.

Deprecated

Use LayerStack.setLayerOrder() or LayerStack.moveLayer() after the layer has been added. Runtime writes are ignored.

Returns

number

Set Signature

set order(order): void;

Defined in: layers.ts:347

Parameters

order

number

Returns

void

Inherited from

ParcelConnectivityLayer.order

Methods

getOrderConstraints()

getOrderConstraints(): LayerOrderConstraints;

Defined in: layers.ts:361

Returns

LayerOrderConstraints

Inherited from

Layer.getOrderConstraints

---

getPresentation()

getPresentation(): LayerPresentation;

Defined in: layers.ts:365

Returns

LayerPresentation

Inherited from

Layer.getPresentation

---

setPresentation()

setPresentation(presentation): void;

Defined in: layers.ts:369

Parameters

presentation

Partial<LayerPresentation>

Returns

void

Inherited from

Layer.setPresentation

---

getDataSummary()

getDataSummary(_options?): LayerDataSummary | null;

Defined in: layers.ts:377

Scalar layers override this without exposing their underlying arrays.

Parameters

_options?

LayerDataSummaryOptions = {}

Returns

LayerDataSummary | null

Inherited from

Layer.getDataSummary

---

setVisible()

setVisible(visible): void;

Defined in: layers.ts:432

Parameters

visible

boolean

Returns

void

Inherited from

Layer.setVisible

---

setOpacity()

setOpacity(opacity): void;

Defined in: layers.ts:439

Parameters

opacity

number

Returns

void

Inherited from

Layer.setOpacity

---

setBlendMode()

setBlendMode(mode): void;

Defined in: layers.ts:447

Parameters

mode

BlendMode

Returns

void

Inherited from

Layer.setBlendMode

---

fromConfig()

static fromConfig(config): Layer;

Defined in: layers.ts:501

Backward-compatible throwing factory. The package entry point installs the same explicit registry exposed by createLayerFromConfig.

Parameters

config

unknown

Returns

Layer

Inherited from

Layer.fromConfig

---

setData()

setData(
   dataX, 
   dataY, 
   indices?
): void;

Defined in: layers.ts:1740

Parameters

dataX

Float32Array<ArrayBufferLike> | number[]

dataY

Float32Array<ArrayBufferLike> | number[]

indices?

number[] | Uint32Array<ArrayBufferLike> | null

Returns

void

---

getDataX()

getDataX(): Float32Array<ArrayBufferLike> | null;

Defined in: layers.ts:1774

Returns

Float32Array<ArrayBufferLike> | null

---

getDataY()

getDataY(): Float32Array<ArrayBufferLike> | null;

Defined in: layers.ts:1778

Returns

Float32Array<ArrayBufferLike> | null

---

setColorMap()

setColorMap(colorMap): void;

Defined in: layers.ts:1782

Parameters

colorMap

| ColorMap2DPreset | ColorMap2D

Returns

void

---

getColorMap()

getColorMap(): ColorMap2D | null;

Defined in: layers.ts:1811

Returns

ColorMap2D | null

---

setRangeX()

setRangeX(range): void;

Defined in: layers.ts:1815

Parameters

range

[number, number]

Returns

void

---

setRangeY()

setRangeY(range): void;

Defined in: layers.ts:1824

Parameters

range

[number, number]

Returns

void

---

setThresholdX()

setThresholdX(threshold): void;

Defined in: layers.ts:1833

Parameters

threshold

[number, number]

Returns

void

---

setThresholdY()

setThresholdY(threshold): void;

Defined in: layers.ts:1842

Parameters

threshold

[number, number]

Returns

void

---

getRangeX()

getRangeX(): [number, number];

Defined in: layers.ts:1851

Returns

[number, number]

---

getRangeY()

getRangeY(): [number, number];

Defined in: layers.ts:1852

Returns

[number, number]

---

getThresholdX()

getThresholdX(): [number, number];

Defined in: layers.ts:1853

Returns

[number, number]

---

getThresholdY()

getThresholdY(): [number, number];

Defined in: layers.ts:1854

Returns

[number, number]

---

getColorMapName()

getColorMapName(): string;

Defined in: layers.ts:1855

Returns

string

---

getRGBAData()

getRGBAData(vertexCount): Float32Array;

Defined in: layers.ts:1857

Get straight RGBA values for this layer.

Alpha here is intrinsic data/colormap coverage only. Layer.opacity is applied exactly once by the CPU or GPU compositor.

Parameters

vertexCount

number

Returns

Float32Array

Overrides

Layer.getRGBAData

---

update()

update(updates): void;

Defined in: layers.ts:1907

Update layer data Must be implemented by subclasses

Parameters

updates

TwoDataLayerUpdateData

Returns

void

Overrides

Layer.update

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: layers.ts:1962

Serialize common layer state for state persistence. Override in subclasses.

Returns

Record<string, unknown>

Overrides

Layer.toStateJSON

---

dispose()

dispose(): void;

Defined in: layers.ts:1974

Returns

void

Overrides

Layer.dispose