Skip to main content
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.
NameTypeDescription
anchor?AnchorSpecSpec for the anchor to use for both source and target.
anchors?[AnchorSpec, AnchorSpec][source, target] anchor specs for edges.
connector?ConnectorSpecSpec for connectors created for this type.
connectorClass?stringClass to add to any connectors created for this type.
connectorHoverStyle?PaintStylePaint style for connectors created for this type when pointer is hovering over the component.
connectorStyle?PaintStylePaint style for connectors created for this type.
cssClass?stringCSS class to add to the given component's representation in the UI
detachable?booleanWhether or not connections of this type should be detachable with the mouse. Defaults to true.
hoverPaintStyle?PaintStylePaint style to use for the component when the pointer is hovering over it.
mergeStrategy?stringWhen 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?Array<OverlaySpec>Array of overlays to add.
paintStyle?PaintStylePaint style to use for the component.
parameters?Record<string,any>Optional set of parameters to store on the component that is generated from this type.
reattach?booleanWhether or not when a user detaches a connection of this type it should be automatically reattached. Defaults to false.
scope?stringProvides a simple means for controlling connectivity in the UI.
sourceMarker?OverlaySpecOptional overlay to use as source marker.
targetMarker?OverlaySpecOptional overlay to use as target marker.