Skip to main content

VertexMapping

Base mapping for nodes, groups and ports.

Extends

Extended by

Type Parameters

O

O

EVT

EVT

Properties

allowLoopback?

optional allowLoopback: boolean

Whether or not to allow edges from this vertex back to itself. Defaults to false.

Inherited from

VertexDefinition.allowLoopback


allowVertexLoopback?

optional allowVertexLoopback: boolean

Whether or not to allow edges from a port back to the vertex it belongs to. Defaults to true.

Inherited from

VertexDefinition.allowVertexLoopback


anchorPositionFinder?

optional anchorPositionFinder: AnchorPositionFinder<any>

Optional function to call on connection drop, to determine the location for the target anchor for the new connection. Returning null from this indicates no preference, and VisuallyJs will use its own computed value.


anchorPositions?

optional anchorPositions: ObjectAnchorSpec[]

Optional array of anchor positions to use.


edgeType?

optional edgeType: string

Type to assign to edges connected to this vertex as a source.


events?

optional events: EVT

Optional map of event bindings.


maxConnections?

optional maxConnections: number

Maximum number of connections this vertex supports. Default is 1. A value of -1 means no limit.

Overrides

VertexDefinition.maxConnections


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

Inherited from

BaseViewObjectMapping.mergeStrategy


parent?

optional parent: string | string[]

Optional ID of one or more edge definitions to include in this definition. The child definition is merged on top of the parent definition(s). Circular references are not allowed and will throw an error.

Inherited from

BaseViewObjectMapping.parent