TypeDescriptorBase

Base interface for vertex/edge types. This interface contains parameters that are common between the two types, and is shared by internal methods and public methods.

Properties

anchor?

optional anchor: AnchorSpec

Spec for the anchor to use for both source and target.

---

anchors?

optional anchors: [AnchorSpec, AnchorSpec]

[source, target] anchor specs for edges.

---

connector?

optional connector: ConnectorSpec

Spec for connectors created for this type.

---

connectorClass?

optional connectorClass: string

Class to add to any connectors created for this type.

---

connectorHoverStyle?

optional connectorHoverStyle: PaintStyle

Paint style for connectors created for this type when pointer is hovering over the component.

---

connectorStyle?

optional connectorStyle: PaintStyle

Paint style for connectors created for this type.

---

cssClass?

optional cssClass: string

CSS class to add to the given component's representation in the UI

---

detachable?

optional detachable: boolean

Whether or not connections of this type should be detachable with the mouse. Defaults to true.

---

hoverPaintStyle?

optional hoverPaintStyle: PaintStyle

Paint style to use for the component when the pointer is hovering over it.

---

mergeStrategy?

optional mergeStrategy: string

When merging a type description into its parent(s), values in the child for connector, anchor and anchors will always overwrite any such values in the parent. But other values, such as overlays, will be merged with their parent's entry for that key. You can force a child's type to override every corresponding value in its parent by setting mergeStrategy:'override'.

---

overlays?

optional overlays: OverlaySpec[]

Array of overlays to add.

---

paintStyle?

optional paintStyle: PaintStyle

Paint style to use for the component.

---

parameters?

optional parameters: Record<string, any>

Optional set of parameters to store on the component that is generated from this type.

---

reattach?

optional reattach: boolean

Whether or not when a user detaches a connection of this type it should be automatically reattached. Defaults to false.

---

scope?

optional scope: string

Provides a simple means for controlling connectivity in the UI.

---

sourceMarker?

optional sourceMarker: OverlaySpec

Optional overlay to use as source marker.

---

targetMarker?

optional targetMarker: OverlaySpec

Optional overlay to use as target marker.