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

EdgeProgramOptions

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

Options for creating an edge program via createEdgeProgram().

Properties

defaultHead?

optional defaultHead?: string

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

Default extremity name for the head (target end). Defaults to “none” if not specified.

defaultTail?

optional defaultTail?: string

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

Default extremity name for the tail (source end). Defaults to “none” if not specified.

extremities?

optional extremities?: EdgeExtremity[]

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

Optional pool of extremity definitions (head/tail decorations). The “none” extremity is always available implicitly. Edges select which extremity via head and tail attributes.

label?

optional label?: EdgeLabelOptions

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

Label configuration options. If provided, a LabelProgram is automatically generated.

layers

layers: EdgeLayer[]

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

Array of layers that composite the edge body appearance. Layers are rendered in order and alpha-blended together. At least one layer is required.

paths

paths: EdgePath[]

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

Array of path definitions (geometry). Edges select their path via the path style (regular edges) or selfLoopPath style (self-loop edges). The first path is the default.