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.
NameTypeDescription
$edgeRedraw?(c:Connection<EL>) => anyOptional 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.
$edgeRemoved(edge:Edge, connection:Connection<EL>) => voidInvoked when an edge has been removed
$edgeRendered(p:ConnectionEstablishedParams) => voidNotification that an edge was rendered
$edgeUpdated(edge:Edge, connection:Connection<EL>) => voidInvoked when an edge has been updated
$groupCollapsed(element:ViewportGroupElement<EL>) => anyInvoked when a group has been collapsed
$groupExpanded(element:ViewportGroupElement<EL>) => anyInvoked when a group has been expanded
$groupMemberAdded(element:ViewportElement<EL>) => anyInvoked when a group member has been added
$groupMemberRemoved(element:ViewportElement<EL>) => anyInvoked when a group member has been removed
$groupRemoved(element:ViewportGroupElement<EL>) => voidInvoked when a group has been removed
$groupResized(params:GroupResizeResult<EL>) => anyInvoked when a group has been resized
$nodeRemoved(element:ViewportElement<EL>) => voidInvoked when a node has been removed
$vertexRerendered(p:{
  el:EL,
  id:string,
  size:Size,
  vertex:Vertex
}
) => 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)
$vertexResized(element:ViewportElement<EL>, width:number, height:number) => voidInvoked when a vertex has been rotated
$vertexRotated(element:ViewportElement<EL>, rotationInDegrees:number) => voidInvoked when a vertex has been resized
$vertexSynced(element:ViewportElement<EL>) => voidInvoked when an element has been synced with the view and a repaint was requested.
$vertexUpdated(element:ViewportElement<EL>, reason:VertexUpdatedReason) => voidInvoked when a vertex has been updated
tracksEdgeRedrawsbooleanSet this to true to inform the UI that the plugin wishes to be informed at the end of an edge paint.