createEdgeProgram

createEdgeProgram<N, E, G>(options): EdgeProgramType<N, E, G>

Defined in: packages/sigma/src/rendering/edges/factory.ts:101

Creates an edge program from paths, extremities, and layers.

Type Parameters

N

N extends Attributes = Attributes

E

E extends Attributes = Attributes

G

G extends Attributes = Attributes

Parameters

options

EdgeProgramOptions

Configuration for the edge program

Returns

EdgeProgramType<N, E, G>

An EdgeProgram class that can be used with Sigma

Example

import { createEdgeProgram, pathLine, pathCurved, extremityArrow, layerPlain } from "sigma/rendering";

// Simple line (no extremities needed - "none" is implicit)
const EdgeLineProgram = createEdgeProgram({
  paths: [pathLine()],
  layers: [layerPlain()],
});

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

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