Interface DefaultEdge<Data, CustomEvents, Type>

Type Parameters

Hierarchy

Properties

animated? ariaLabel? class? data? deletable? events? focusable? hidden? id interactionWidth? label? labelBgBorderRadius? labelBgPadding? labelBgStyle? labelShowBg? labelStyle? markerEnd? markerStart? selectable? source sourceHandle? style? target targetHandle? template? type? updatable? zIndex?

Properties

Optional animated

animated?: boolean

Animated edge

Optional ariaLabel

ariaLabel?: null | string

Optional class

class?: string | ClassFunc<GraphEdge<Data, CustomEvents, string>>

Additional class names, can be a string or a callback returning a string (receives current flow element)

Optional data

data?: Data

Additional data that is passed to your custom components

Optional deletable

deletable?: boolean

Disable/enable deleting edge

Optional events

events?: Partial<EdgeEventsHandler<CustomEvents>>

contextual and custom events of edge

Optional focusable

focusable?: boolean

Disable/enable focusing edge (a11y)

Optional hidden

hidden?: boolean

Is edge hidden

id

id: string

Unique edge id

Optional interactionWidth

interactionWidth?: number

Radius of mouse event triggers (to ease selecting edges), defaults to 2

Optional label

label?: string | VNode<RendererNode, RendererElement, {
    [key: string]: any;
}> | Component<EdgeTextProps, any, any, ComputedOptions, MethodOptions>

An edge label

Optional labelBgBorderRadius

labelBgBorderRadius?: number

Label Bg border radius

Optional labelBgPadding

labelBgPadding?: [number, number]

Label Bg padding

Optional labelBgStyle

labelBgStyle?: CSSProperties

Label Bg styles (CSSProperties)

Optional labelShowBg

labelShowBg?: boolean

Show label bg

Optional labelStyle

labelStyle?: CSSProperties

Label styles (CSSProperties)

Optional markerEnd

markerEnd?: EdgeMarkerType

EdgeMarker

Optional markerStart

markerStart?: EdgeMarkerType

EdgeMarker

Optional selectable

selectable?: boolean

Disable/enable selecting edge

source

source: string

Source node id

Optional sourceHandle

sourceHandle?: null | string

Source handle id

Optional style

style?: Styles | StyleFunc<GraphEdge<Data, CustomEvents, string>>

Additional styles, can be an object or a callback returning an object (receives current flow element)

target

target: string

Target node id

Optional targetHandle

targetHandle?: null | string

Target handle id

Optional template

template?: EdgeComponent

Overwrites current edge type

Optional type

type?: Type

Edge type, can be a default type or a custom type

Optional updatable

updatable?: EdgeUpdatable

Disable/enable updating edge

Optional zIndex

zIndex?: number

Aria label for edge (a11y)

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc