Interface: DefaultEdge<Data, CustomEvents> #

Type parameters #

Hierarchy #

• EdgeLabelOptions

  ↳ DefaultEdge

Table of contents #

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 #

animated #

• Optional animated: boolean

Animated edge

ariaLabel #

• Optional ariaLabel: null | string

class #

• Optional class: string | ClassFunc<GraphEdge<Data, CustomEvents, string>>

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

data #

• Optional data: Data

Additional data that is passed to your custom components

deletable #

• Optional deletable: boolean

Disable/enable deleting edge

events #

• Optional events: Partial<EdgeEventsHandler<CustomEvents>>

contextual and custom events of edge

focusable #

• Optional focusable: boolean

Disable/enable focusing edge (a11y)

hidden #

• Optional hidden: boolean

Is edge hidden

id #

• id: string

Unique edge id

interactionWidth #

• Optional interactionWidth: number

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

label #

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

An edge label

labelBgBorderRadius #

• Optional labelBgBorderRadius: number

Label Bg border radius

Inherited from #

EdgeLabelOptions.labelBgBorderRadius

labelBgPadding #

• Optional labelBgPadding: [number, number]

Label Bg padding

Inherited from #

EdgeLabelOptions.labelBgPadding

labelBgStyle #

• Optional labelBgStyle: CSSProperties

Label Bg styles (CSSProperties)

Inherited from #

EdgeLabelOptions.labelBgStyle

labelShowBg #

• Optional labelShowBg: boolean

Show label bg

Inherited from #

EdgeLabelOptions.labelShowBg

labelStyle #

• Optional labelStyle: CSSProperties

Label styles (CSSProperties)

Inherited from #

EdgeLabelOptions.labelStyle

markerEnd #

• Optional markerEnd: EdgeMarkerType

EdgeMarker

markerStart #

• Optional markerStart: EdgeMarkerType

EdgeMarker

selectable #

• Optional selectable: boolean

Disable/enable selecting edge

source #

• source: string

Source node id

sourceHandle #

• Optional sourceHandle: null | string

Source handle id

style #

• Optional 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

targetHandle #

• Optional targetHandle: null | string

Target handle id

template #

• Optional template: EdgeComponent

Overwrites current edge type

type #

• Optional type: string

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

updatable #

• Optional updatable: EdgeUpdatable

Disable/enable updating edge

zIndex #

• Optional zIndex: number

Aria label for edge (a11y)