@braks/vue-flow / Edge

Interface: Edge<Data, CustomEvents>

Type parameters

NameType
DataElementData
CustomEventsextends Record<string, CustomEvent> = any

Table of contents

Properties

Properties

animated

Optional animated: boolean

Animated edge


class

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

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


events

Optional events: Partial<EdgeEventsHandler<CustomEvents>>

contextual and custom events of edge


hidden

Optional hidden: boolean

Is edge hidden


id

id: string

Unique edge id


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


labelBgPadding

Optional labelBgPadding: [number, number]

Label Bg padding


labelBgStyle

Optional labelBgStyle: CSSProperties

Label Bg styles (CSSProperties)


labelShowBg

Optional labelShowBg: boolean

Show label bg


labelStyle

Optional labelStyle: CSSProperties

Label styles (CSSProperties)


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

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: boolean

Disable/enable updating edge