Skip to main content

UIPlugin

A plugin for the UI. You don't need to worry about this class unless you're planning on writing your own plugin.

Advanced​

Extended by​

Type Parameters​

EL​

EL

O​

O extends UIPluginOptions

U​

U extends UICore<EL, any>

Properties​

$edgeRedraw()?​

optional $edgeRedraw: (c) => any

Optional method you can implement if you set tracksEdgeRedraws:true; the UI will invoke this method at the end of each edge's paint cycle. You can access the underlying edge via c.edge.

Parameters​

c​

Connection<EL>

Returns​

any

$edgeRemoved()​

$edgeRemoved: (edge, connection) => void

Invoked when an edge has been removed

Parameters​

edge​

Edge

connection​

Connection<EL>

Returns​

void

$edgeRendered()​

$edgeRendered: (p) => void

Notification that an edge was rendered

Parameters​

p​

ConnectionEstablishedParams

Returns​

void

$edgeUpdated()​

$edgeUpdated: (edge, connection) => void

Invoked when an edge has been updated

Parameters​

edge​

Edge

connection​

Connection<EL>

Returns​

void

$groupCollapsed()​

$groupCollapsed: (element) => any

Invoked when a group has been collapsed

Parameters​

element​

ViewportGroupElement<EL>

Returns​

any

$groupExpanded()​

$groupExpanded: (element) => any

Invoked when a group has been expanded

Parameters​

element​

ViewportGroupElement<EL>

Returns​

any

$groupMemberAdded()​

$groupMemberAdded: (element) => any

Invoked when a group member has been added

Parameters​

element​

ViewportElement<EL>

Returns​

any

$groupMemberRemoved()​

$groupMemberRemoved: (element) => any

Invoked when a group member has been removed

Parameters​

element​

ViewportElement<EL>

Returns​

any

$groupRemoved()​

$groupRemoved: (element) => void

Invoked when a group has been removed

Parameters​

element​

ViewportGroupElement<EL>

Returns​

void

$groupResized()​

$groupResized: (params) => any

Invoked when a group has been resized

Parameters​

params​

GroupResizeResult<EL>

Returns​

any

$nodeRemoved()​

$nodeRemoved: (element) => void

Invoked when a node has been removed

Parameters​

element​

ViewportElement<EL>

Returns​

void

$vertexRerendered()​

$vertexRerendered: (p) => void

Invoked when a vertex has been re-rendered (its type was changed and it was rerendered, which may have resulted in a different appearance)

Parameters​

p​
el​

EL

id​

string

size​

Size

vertex​

Vertex

Returns​

void

$vertexResized()​

$vertexResized: (element, width, height) => void

Invoked when a vertex has been rotated

Parameters​

element​

ViewportElement<EL>

width​

number

height​

number

Returns​

void

$vertexRotated()​

$vertexRotated: (element, rotationInDegrees) => void

Invoked when a vertex has been resized

Parameters​

element​

ViewportElement<EL>

rotationInDegrees​

number

Returns​

void

$vertexSynced()​

$vertexSynced: (element) => void

Invoked when an element has been synced with the view and a repaint was requested.

Parameters​

element​

ViewportElement<EL>

Returns​

void

$vertexUpdated()​

$vertexUpdated: (element, reason) => void

Invoked when a vertex has been updated

Parameters​

element​

ViewportElement<EL>

reason​

VertexUpdatedReason

Returns​

void

tracksEdgeRedraws​

tracksEdgeRedraws: boolean

Set this to true to inform the UI that the plugin wishes to be informed at the end of an edge paint.