@advjs/monorepo / @advjs/types / AdvFlowEdge

Interface: AdvFlowEdge

Defined in: packages/types/src/flow/edge.ts:6

Edge

Extends

• DefaultEdge

Properties

animated?

optional animated: boolean

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:75

Animated edge

Inherited from

DefaultEdge.animated

---

ariaLabel?

optional ariaLabel: null | string

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:104

Inherited from

DefaultEdge.ariaLabel

---

class?

optional class: string | string[] | Record<string, any> | ClassFunc<GraphEdge<any, any, string>>

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:89

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

Inherited from

DefaultEdge.class

---

data?

optional data: any

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:99

Additional data that is passed to your custom components

Inherited from

DefaultEdge.data

---

deletable?

optional deletable: boolean

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:87

Disable/enable deleting edge

Inherited from

DefaultEdge.deletable

---

domAttributes?

optional domAttributes: Omit<SVGAttributes, "style" | "id" | "className" | "role" | "aria-label" | "onClick" | "onMouseenter" | "onMousemove" | "onMouseleave" | "onContextmenu" | "onDblclick" | "onKeyDown">

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:108

General escape hatch for adding custom attributes to the edge's DOM element.

Inherited from

DefaultEdge.domAttributes

---

events?

optional events: Partial<EdgeEventsHandler<any>>

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:101

Deprecated

will be removed in the next major version

Inherited from

DefaultEdge.events

---

focusable?

optional focusable: boolean

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:85

Disable/enable focusing edge (a11y)

Inherited from

DefaultEdge.focusable

---

hidden?

optional hidden: boolean

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:93

Is edge hidden

Inherited from

DefaultEdge.hidden

---

id

id: string

Defined in: packages/types/src/flow/edge.ts:7

Unique edge id

Overrides

DefaultEdge.id

---

interactionWidth?

optional interactionWidth: number

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:95

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

Inherited from

DefaultEdge.interactionWidth

---

label?

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

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:63

An edge label

Inherited from

DefaultEdge.label

---

labelBgBorderRadius?

optional labelBgBorderRadius: number

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:53

Label Bg border radius

Inherited from

DefaultEdge.labelBgBorderRadius

---

labelBgPadding?

optional labelBgPadding: [number, number]

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:51

Label Bg padding

Inherited from

DefaultEdge.labelBgPadding

---

labelBgStyle?

optional labelBgStyle: CSSProperties

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:49

Label Bg styles (CSSProperties)

Inherited from

DefaultEdge.labelBgStyle

---

labelShowBg?

optional labelShowBg: boolean

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:47

Show label bg

Inherited from

DefaultEdge.labelShowBg

---

labelStyle?

optional labelStyle: CSSProperties

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:45

Label styles (CSSProperties)

Inherited from

DefaultEdge.labelStyle

---

markerEnd?

optional markerEnd: EdgeMarkerType

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:79

EdgeMarker

Inherited from

DefaultEdge.markerEnd

---

markerStart?

optional markerStart: EdgeMarkerType

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:77

EdgeMarker

Inherited from

DefaultEdge.markerStart

---

selectable?

optional selectable: boolean

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:83

Disable/enable selecting edge

Inherited from

DefaultEdge.selectable

---

source

source: string

Defined in: packages/types/src/flow/edge.ts:8

Source node id

Overrides

DefaultEdge.source

---

sourceHandle?

optional sourceHandle: null | string

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:71

Source handle id

Inherited from

DefaultEdge.sourceHandle

---

style?

optional style: Styles | StyleFunc<GraphEdge<any, any, string>>

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:91

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

Inherited from

DefaultEdge.style

---

target

target: string

Defined in: packages/types/src/flow/edge.ts:9

Target node id

Overrides

DefaultEdge.target

---

targetHandle?

optional targetHandle: null | string

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:73

Target handle id

Inherited from

DefaultEdge.targetHandle

---

template?

optional template: EdgeComponent

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:97

Overwrites current edge type

Inherited from

DefaultEdge.template

---

type?

optional type: string

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:65

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

Inherited from

DefaultEdge.type

---

updatable?

optional updatable: EdgeUpdatable

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:81

Disable/enable updating edge

Inherited from

DefaultEdge.updatable

---

zIndex?

optional zIndex: number

Defined in: node_modules/.pnpm/@vue-flow+core@1.45.0_vue@3.5.17_typescript@5.8.3_/node_modules/@vue-flow/core/dist/types/edge.d.ts:103

Aria label for edge (a11y)

Inherited from

DefaultEdge.zIndex