EdgeProgramOptions

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

Options for creating an edge program via createEdgeProgram().

Example

// Simple line with no extremities
createEdgeProgram({
  paths: [pathLine()],
  layers: [layerPlain()],
});

// Arrow at head
createEdgeProgram({
  paths: [pathLine()],
  extremities: [extremityArrow()],
  layers: [layerPlain()],
  defaultHead: "arrow",
});

// Multi-path: edges select via attributes
createEdgeProgram({
  paths: [pathLine(), pathCurved()],
  extremities: [extremityArrow()],
  layers: [layerPlain()],
});
// Edges select via: { path: "curved", head: "arrow", tail: "none" }

Properties

defaultHead?

optional defaultHead?: string

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

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:566

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:547

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:572

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

---

layers

layers: EdgeLayer[]

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

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:540

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.