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

Options for the dashed layer.

Properties

align?

optional align?: number

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

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


dashColor?

optional dashColor?: ValueSource<string>

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

Custom dash color:

  • String: Fixed color value (e.g., “#ff0000”)
  • Object with attribute: Read from node attribute (e.g., { attribute: “fillColor” })

Default

{ attribute: "color" }

dashOffset?

optional dashOffset?: DashSize

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

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

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


gapColor?

optional gapColor?: GapFilling

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

How gaps should be filled:

  • 0: Fully transparent gaps (default)
  • number (0-1): Same color as dash but with this opacity
  • string: CSS color for gaps (constant for all edges)
  • { attribute: string }: Per-edge attribute name for gap color

Default: 0


gapSize?

optional gapSize?: DashSize

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

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


solidExtremities?

optional solidExtremities?: SolidExtremities

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

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

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