Class: LabelLayer

Defined in: src/layers.ts:1278

Categorical label layer: maps per-vertex integer labels to solid colors. Useful for parcellations when used inside a MultiLayerNeuroSurface.

Extends

• Layer

Constructors

Constructor

new LabelLayer(id, options): LabelLayer;

Defined in: src/layers.ts:1284

Parameters

id

string

options

LabelLayerOptions

Returns

LabelLayer

Overrides

Layer.constructor

Properties

id

id: string;

Defined in: src/layers.ts:103

Inherited from

Layer.id

---

visible

visible: boolean;

Defined in: src/layers.ts:104

Inherited from

Layer.visible

---

opacity

opacity: number;

Defined in: src/layers.ts:105

Inherited from

Layer.opacity

---

blendMode

blendMode: BlendMode;

Defined in: src/layers.ts:106

Inherited from

Layer.blendMode

---

order

order: number;

Defined in: src/layers.ts:107

Inherited from

Layer.order

---

needsUpdate

needsUpdate: boolean;

Defined in: src/layers.ts:108

Inherited from

Layer.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

Layer._onChangeCallback

Methods

setVisible()

setVisible(visible): void;

Defined in: src/layers.ts:132

Parameters

visible

boolean

Returns

void

Inherited from

Layer.setVisible

---

setOpacity()

setOpacity(opacity): void;

Defined in: src/layers.ts:139

Parameters

opacity

number

Returns

void

Inherited from

Layer.setOpacity

---

setBlendMode()

setBlendMode(mode): void;

Defined in: src/layers.ts:147

Parameters

mode

BlendMode

Returns

void

Inherited from

Layer.setBlendMode

---

dispose()

dispose(): void;

Defined in: src/layers.ts:167

Returns

void

Inherited from

Layer.dispose

---

registerOutlineLayer()

static registerOutlineLayer(ctor): void;

Defined in: src/layers.ts:183

Parameters

ctor

any

Returns

void

Inherited from

Layer.registerOutlineLayer

---

registerTemporalLayer()

static registerTemporalLayer(ctor): void;

Defined in: src/layers.ts:187

Parameters

ctor

any

Returns

void

Inherited from

Layer.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

Layer.fromConfig

---

setLabels()

setLabels(labels): void;

Defined in: src/layers.ts:1306

Parameters

labels

| Uint32Array<ArrayBufferLike> | Int32Array<ArrayBufferLike> | number[]

Returns

void

---

setLabelDefs()

setLabelDefs(labelDefs): void;

Defined in: src/layers.ts:1315

Parameters

labelDefs

object[]

Returns

void

---

update()

update(data): void;

Defined in: src/layers.ts:1323

Update layer data Must be implemented by subclasses

Parameters

data

LabelLayerOptions & LayerUpdateData

Returns

void

Overrides

Layer.update

---

getRGBAData()

getRGBAData(vertexCount): Float32Array;

Defined in: src/layers.ts:1345

Get RGBA values for this layer Must be implemented by subclasses

Parameters

vertexCount

number

Returns

Float32Array

Overrides

Layer.getRGBAData

---

toStateJSON()

toStateJSON(): Record<string, unknown>;

Defined in: src/layers.ts:1369

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

Returns

Record<string, unknown>

Overrides

Layer.toStateJSON