Skip to content
This is the alpha v4 version website. Looking for the v3 documentation?

EdgeLifecycleHooks

Defined in: packages/sigma/src/rendering/edges/types.ts:297

Lifecycle hooks for edge layers that need async resources.

Properties

beforeRender?

optional beforeRender?: () => void

Defined in: packages/sigma/src/rendering/edges/types.ts:306

Called before each render.

Returns

void


getAttributeData?

optional getAttributeData?: (data, attributeSource) => number | number[] | null

Defined in: packages/sigma/src/rendering/edges/types.ts:321

Returns data for special attribute sources.

Parameters

data

Record<string, unknown>

attributeSource

string

Returns

number | number[] | null


init?

optional init?: () => void

Defined in: packages/sigma/src/rendering/edges/types.ts:301

Called after the program is initialized.

Returns

void


kill?

optional kill?: () => void

Defined in: packages/sigma/src/rendering/edges/types.ts:316

Called when the program is destroyed.

Returns

void


regenerate?

optional regenerate?: () => EdgeLayer

Defined in: packages/sigma/src/rendering/edges/types.ts:311

Called when the layer’s shader needs regeneration.

Returns

EdgeLayer