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

StepPathOptions

Defined in: packages/sigma/src/rendering/edges/paths/step.ts:18

Options for step path creation.

Properties

innerCornerSkipFactor?

optional innerCornerSkipFactor?: number

Defined in: packages/sigma/src/rendering/edges/paths/step.ts:54

Skip factor for inner corners when labels are positioned above/below. The gap at inner corners = innerCornerSkipFactor * fontSize (in screen pixels).

When a label follows the path around a corner, characters on the inner (concave) side of the bend would normally bunch up and overlap. This factor creates a gap at those corners to prevent overlap.

Default: 1.0

offset?

optional offset?: number

Defined in: packages/sigma/src/rendering/edges/paths/step.ts:42

Position of the middle segment as ratio [0-1]. 0 = at source, 0.5 = centered, 1 = at target. Default: 0.5

orientation?

optional orientation?: number | "horizontal" | "vertical" | "automatic"

Defined in: packages/sigma/src/rendering/edges/paths/step.ts:27

Path orientation preference.

  • “horizontal”: Always go horizontal first (H→V→H)
  • “vertical”: Always go vertical first (V→H→V)
  • “automatic”: Choose based on which delta is larger (abs(dx) vs abs(dy))
  • number: Fixed angle in radians for the first/last segments Default: “automatic”

rotateWithCamera?

optional rotateWithCamera?: boolean

Defined in: packages/sigma/src/rendering/edges/paths/step.ts:35

Whether edges rotate with camera or stay screen-aligned.

  • false: Edges stay horizontal/vertical on screen
  • true: Edges rotate with the graph (world-aligned) Default: false