Skip to content

pivotick v3.0.0


pivotick / RendererOptions / EdgeStyle

Interface: EdgeStyle ​

Defined in: interfaces/RendererOptions.ts:673

Properties ​

animateDash? ​

optional animateDash: boolean

Defined in: interfaces/RendererOptions.ts:691

Whether the dash should be animated (e.g., animation moving along the path) @default: true


curveStyle ​

curveStyle: CurveStyle

Defined in: interfaces/RendererOptions.ts:681

Default ​

ts
bidirectional

dashed? ​

optional dashed: boolean | (edge) => boolean

Defined in: interfaces/RendererOptions.ts:686

Whether the stroke is dashed

Default ​

ts
false

markerEnd? ​

optional markerEnd: string | (edge) => string

Defined in: interfaces/RendererOptions.ts:701

Which end marker should the edge use

Default ​

ts
arrow

markerStart? ​

optional markerStart: string | (edge) => string

Defined in: interfaces/RendererOptions.ts:706

Which start marker should the edge use

Default ​

ts
undefined

opacity ​

opacity: number

Defined in: interfaces/RendererOptions.ts:679

Default ​

ts
1.0

rotateLabel ​

rotateLabel: boolean

Defined in: interfaces/RendererOptions.ts:696

Keeps labels horizontally aligned to the viewport

Default ​

ts
false

strokeColor ​

strokeColor: string

Defined in: interfaces/RendererOptions.ts:675

Default ​

ts
'var(--pvt-edge-stroke, #999)'

strokeWidth ​

strokeWidth: number

Defined in: interfaces/RendererOptions.ts:677

Default ​

ts
2

styleCb()? ​

optional styleCb: (edge) => Partial<EdgeStyle>

Defined in: interfaces/RendererOptions.ts:718

Callback to dynamically override style properties based on the edge.

Where it sits depends on which style block declares it. On an edge's own style it wins outright, and edgeStyleMap is skipped entirely. On render.defaultEdgeStyle it is the computed form of the default slot: it fills only what neither the edge nor edgeStyleMap set (and what a per-edge styleCb left out), and its result still loses to both.

Runs once per edge per render, so keep it cheap.

Parameters ​

edge ​

Edge

Returns ​

Partial<EdgeStyle>