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

LayerDashedOptions

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:59

Options for the dashed layer.

Properties

align?

optional align?: number

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:116

Controls where the dash pattern is anchored along the edge:

  • 0: Pattern starts at the beginning of the edge
  • 0.5: Pattern is centered on the edge (default)
  • 1: Pattern ends at the end of the edge

Default: 0.5


cap?

optional cap?: DashCap

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:106

Shape of dash ends:

  • “butt”: Straight ends, dashes span the full edge thickness (default)
  • “round”: Round caps, carved inside the dash length so a dash never exceeds its dashSize. Dashes shorter than the edge thickness degenerate to circles, so cap: "round" with a small dashSize (e.g. { value: 1, mode: "relative" }) renders dotted edges.

Default: “butt”


dashColor?

optional dashColor?: EdgeColorValue

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:72

Dash color: constant color, per-edge attribute, or node color reference (e.g. { node: "source" }).

Default

{ attribute: "color" }

dashOffset?

optional dashOffset?: DashSize

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:78

Offset to shift the dash pattern along the edge. Default: { value: 0, mode: ‘pixels’ }


dashSize?

optional dashSize?: DashSize

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:64

Size of each dash. Default: { value: 10, mode: ‘pixels’ }


gapColor?

optional gapColor?: GapFilling

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:94

How gaps should be filled:

  • number (0-1): Same color as dash but with this opacity (0 = fully transparent, the default)
  • EdgeColorValue: constant color, per-edge attribute, or node color

Default: 0


gapSize?

optional gapSize?: DashSize

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:84

Size of gaps between dashes. Default: { value: 10, mode: ‘pixels’ }


solidExtremities?

optional solidExtremities?: SolidExtremities

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:127

Render extremity zones with solid color instead of dashes.

  • true: Both head and tail extremities are solid
  • “head”: Only head (target) extremity is solid
  • “tail”: Only tail (source) extremity is solid
  • false: Dashes continue through extremities (default)

Default: false


solidMargin?

optional solidMargin?: SolidMargin

Defined in: packages/sigma/src/rendering/edges/layers/dashed.ts:137

Extra solid margin (in pixels) before the dash pattern starts. This is in addition to the extremity zone when solidExtremities is enabled.

  • number: Same margin on both ends
  • { head?: number, tail?: number }: Different margins for each end

Default: 0