Class: TemporalDataLayer

Defined in: src/temporal/TemporalDataLayer.ts:18

A DataLayer whose scalar data varies over time.

Stores T frames of V-length Float32Arrays. On each call to setTime(), linearly interpolates between bracketing frames and writes the result into this.data (inherited from DataLayer), then invalidates so that the layer stack will re-composite.

Design: CPU interpolation happens before colormapping, which produces correct visual blending (interpolating RGBA after colormapping would produce muddy blends).

Extends

• DataLayer

Constructors

Constructor

new TemporalDataLayer(
   id, 
   frames, 
   times, 
   colorMap, 
   config): TemporalDataLayer;

Defined in: src/temporal/TemporalDataLayer.ts:24

Parameters

id

string

frames

Float32Array<ArrayBufferLike>[]

times

number[]

colorMap

string | ColorMap | Color[]

config

TemporalDataConfig

Returns

TemporalDataLayer

Overrides

DataLayer.constructor

Properties

id

id: string;

Defined in: src/layers.ts:103

Inherited from

DataLayer.id

---

visible

visible: boolean;

Defined in: src/layers.ts:104

Inherited from

DataLayer.visible

---

opacity

opacity: number;

Defined in: src/layers.ts:105

Inherited from

DataLayer.opacity

---

blendMode

blendMode: BlendMode;

Defined in: src/layers.ts:106

Inherited from

DataLayer.blendMode

---

order

order: number;

Defined in: src/layers.ts:107

Inherited from

DataLayer.order

---

needsUpdate

needsUpdate: boolean;

Defined in: src/layers.ts:108

Inherited from

DataLayer.needsUpdate

---

_onChangeCallback

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

Defined in: src/layers.ts:110

Callback set by the parent surface to trigger re-compositing on change.

Inherited from

DataLayer._onChangeCallback

Methods

setVisible()

setVisible(visible): void;

Defined in: src/layers.ts:132

Parameters

visible

boolean

Returns

void

Inherited from

DataLayer.setVisible

---

setOpacity()

setOpacity(opacity): void;

Defined in: src/layers.ts:139

Parameters

opacity

number

Returns

void

Inherited from

DataLayer.setOpacity

---

setBlendMode()

setBlendMode(mode): void;

Defined in: src/layers.ts:147

Parameters

mode

BlendMode

Returns

void

Inherited from

DataLayer.setBlendMode

---

registerOutlineLayer()

static registerOutlineLayer(ctor): void;

Defined in: src/layers.ts:183

Parameters

ctor

any

Returns

void

Inherited from

DataLayer.registerOutlineLayer

---

registerTemporalLayer()

static registerTemporalLayer(ctor): void;

Defined in: src/layers.ts:187

Parameters

ctor

any

Returns

void

Inherited from

DataLayer.registerTemporalLayer

---

fromConfig()

static fromConfig(config): Layer;

Defined in: src/layers.ts:199

Create a concrete Layer instance from a plain object configuration. Supports: base, rgba, data, outline.

Parameters

config

Record<string, any>

Returns

Layer

Inherited from

DataLayer.fromConfig

---

setData()

setData(data, indices?): void;

Defined in: src/layers.ts:422

Parameters

data

Float32Array<ArrayBufferLike> | number[]

indices?

Uint32Array<ArrayBufferLike> | number[] | null

Returns

void

Inherited from

DataLayer.setData

---

getData()

getData(): Float32Array<ArrayBufferLike> | null;

Defined in: src/layers.ts:447

Returns

Float32Array<ArrayBufferLike> | null

Inherited from

DataLayer.getData

---

setColorMap()

setColorMap(colorMap): void;

Defined in: src/layers.ts:451

Parameters

colorMap

string | ColorMap | Color[]

Returns

void

Inherited from

DataLayer.setColorMap

---

setRange()

setRange(range): void;

Defined in: src/layers.ts:492

Parameters

range

[number, number]

Returns

void

Inherited from

DataLayer.setRange

---

setThreshold()

setThreshold(threshold): void;

Defined in: src/layers.ts:500

Parameters

threshold

[number, number]

Returns

void

Inherited from

DataLayer.setThreshold

---

getRange()

getRange(): [number, number];

Defined in: src/layers.ts:508

Returns

[number, number]

Inherited from

DataLayer.getRange

---

getThreshold()

getThreshold(): [number, number];

Defined in: src/layers.ts:512

Returns

[number, number]

Inherited from

DataLayer.getThreshold

---

getColorMapName()

getColorMapName(): string;

Defined in: src/layers.ts:516

Returns

string

Inherited from

DataLayer.getColorMapName

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: src/layers.ts:520

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

Returns

Record<string, unknown>

Inherited from

DataLayer.toStateJSON

---

getRGBAData()

getRGBAData(vertexCount): Float32Array;

Defined in: src/layers.ts:530

Get RGBA values for this layer Must be implemented by subclasses

Parameters

vertexCount

number

Returns

Float32Array

Inherited from

DataLayer.getRGBAData

---

update()

update(updates): void;

Defined in: src/layers.ts:591

Update layer data Must be implemented by subclasses

Parameters

updates

DataLayerUpdateData

Returns

void

Inherited from

DataLayer.update

---

setTime()

setTime(
   frameA, 
   frameB, 
   alpha): void;

Defined in: src/temporal/TemporalDataLayer.ts:91

Interpolate between two bracketing frames and update internal data.

Parameters

frameA

number

Index of the earlier frame

frameB

number

Index of the later frame

alpha

number

Interpolation factor [0, 1] where 0 = frameA, 1 = frameB

Returns

void

---

getTimeSeries()

getTimeSeries(vertexIndex): Float32Array;

Defined in: src/temporal/TemporalDataLayer.ts:114

Extract the time series for a single vertex across all frames.

Parameters

vertexIndex

number

Returns

Float32Array

---

getTimes()

getTimes(): number[];

Defined in: src/temporal/TemporalDataLayer.ts:126

Return a copy of the time values array.

Returns

number[]

---

getFactorDescriptor()

getFactorDescriptor(): FactorDescriptor | null;

Defined in: src/temporal/TemporalDataLayer.ts:133

Return the factor descriptor, or null if none was provided.

Returns

FactorDescriptor | null

---

getFrameCount()

getFrameCount(): number;

Defined in: src/temporal/TemporalDataLayer.ts:140

Return the number of temporal frames.

Returns

number

---

getVertexCount()

getVertexCount(): number;

Defined in: src/temporal/TemporalDataLayer.ts:147

Return the number of vertices per frame.

Returns

number

---

dispose()

dispose(): void;

Defined in: src/temporal/TemporalDataLayer.ts:151

Returns

void

Overrides

DataLayer.dispose