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

extremityArrow

extremityArrow(options?): EdgeExtremity

Defined in: packages/sigma/src/rendering/edges/extremities/arrow.ts:46

Creates an arrow extremity (triangular arrow head).

The arrow is rendered as a triangle pointing in the direction of travel. Size is relative to edge thickness.

Parameters

options?

ArrowExtremityOptions

Arrow configuration

Returns

EdgeExtremity

EdgeExtremity definition for arrow

Example

// Arrow with default settings
const EdgeArrowProgram = createEdgeProgram({
paths: [pathLine()],
extremities: [extremityNone(), extremityArrow()],
layers: [layerPlain()],
});
// Custom arrow with margin
const EdgeArrowMarginProgram = createEdgeProgram({
paths: [pathLine()],
extremities: [extremityNone(), extremityArrow({ lengthRatio: 3, widthRatio: 2.5, margin: 5 })],
layers: [layerPlain()],
});