CreateEdgeLabelProgramOptions

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

Options for creating an edge label program. Extends EdgeLabelOptions with program-specific options (paths, extremity ratios).

Extends

EdgeLabelOptions

Properties

color?

optional color?: EdgeLabelColorSpecification

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

Label color configuration. Can specify either a fixed color or an attribute name. Default: uses settings.edgeLabelColor

Inherited from

EdgeLabelOptions.color

fontSizeMode?

optional fontSizeMode?: EdgeLabelFontSizeMode

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

Font size mode for edge labels.

“fixed”: Constant pixel size regardless of zoom (default)
“scaled”: Scales with zoom level using zoomToSizeRatioFunction from settings Default: uses settings.edgeLabelFontSizeMode

Inherited from

EdgeLabelOptions.fontSizeMode

fullVisibilityThreshold?

optional fullVisibilityThreshold?: number

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

Visibility ratio at which labels reach full opacity (0-1). Between minVisibilityThreshold and this value, labels fade in gradually. Default: 0.6

Inherited from

EdgeLabelOptions.fullVisibilityThreshold

headLengthRatio?

optional headLengthRatio?: number

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

Head extremity length ratio (length / thickness). Default: 0 (no head extremity)

margin?

optional margin?: number

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

Margin between the edge surface and the label (in pixels) for “above”/“below”/“auto” modes. Default: uses settings.edgeLabelMargin

Note: per-edge position is set via the style system (labelPosition style), not here — styles are the single source of truth so the text and its background/picking hitbox can’t disagree.