Skip to main content

LineCrossingsPluginOptions

Options for the line crossings plugin.

Properties​

bridgeType​

bridgeType: "gap" | "dot" | "arch"

Type of bridge to use. Defaults to 'arch'.

dotColor?​

optional dotColor: string

Color to use for dot bridges. Defaults to null, and the dot is painted with the stroke color of the dominant segment. You can also control this via the CSS class defined by the constant CLASS_LINE_CROSSING_BRIDGE_DOT, but using CSS will be lost in an SVG export.

dotRadius?​

optional dotRadius: number

Radius to use for dot bridges. Defaults to 5.

onTap()?​

optional onTap: (edge1, edge2, canvasLocation, e) => any

Optional function to invoke when the user taps on a bridge. This will only fire for bridge types that draw extra components - arch and dot - but the gap bridge just masks

Parameters​

edge1​

Edge

First edge in the intersection

edge2​

Edge

Second edge in the intersection.

canvasLocation​

PointXY

The location on the canvas that the intersection is located at.

e​

MouseEvent

The mouse event associated with the tap.

Returns​

any

orientation​

orientation: "v" | "h"

Whether to apply the bridge to the horizontal or the vertical segment in a crossing. Defaults to horizontal.