Skip to content
sigma.js sigma.js
v4.0.6 Docs Examples GitHub 12.2K

EdgeProgramOptions

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

Options for creating an edge program via createEdgeProgram().

optional defaultHead?: string

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

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


optional defaultTail?: string

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

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


optional extremities?: EdgeExtremity[]

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

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


optional label?: EdgeLabelOptions

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

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


layers: EdgeLayer[]

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

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: EdgePath[]

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

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.