BrowserUIPlugin

Defines a BrowserUI plugin

Extends

• UIPlugin<BrowserElement, O, BrowserUI>

Type Parameters

O

O extends UIPluginOptions

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<BrowserElement>

Returns

any

Inherited from

UIPlugin.$edgeRedraw

---

$edgeRemoved()

$edgeRemoved: (edge, connection) => void

Invoked when an edge has been removed

Parameters

edge

Edge

connection

Connection<BrowserElement>

Returns

void

Inherited from

UIPlugin.$edgeRemoved

---

$edgeRendered()

$edgeRendered: (p) => void

Notification that an edge was rendered

Parameters

p

ConnectionEstablishedParams

Returns

void

Inherited from

UIPlugin.$edgeRendered

---

$edgeUpdated()

$edgeUpdated: (edge, connection) => void

Invoked when an edge has been updated

Parameters

edge

Edge

connection

Connection<BrowserElement>

Returns

void

Inherited from

UIPlugin.$edgeUpdated

---

$groupCollapsed()

$groupCollapsed: (element) => any

Invoked when a group has been collapsed

Parameters

element

ViewportGroupElement<BrowserElement>

Returns

any

Inherited from

UIPlugin.$groupCollapsed

---

$groupExpanded()

$groupExpanded: (element) => any

Invoked when a group has been expanded

Parameters

element

ViewportGroupElement<BrowserElement>

Returns

any

Inherited from

UIPlugin.$groupExpanded

---

$groupMemberAdded()

$groupMemberAdded: (element) => any

Invoked when a group member has been added

Parameters

element

ViewportElement<BrowserElement>

Returns

any

Overrides

UIPlugin.$groupMemberAdded

---

$groupMemberRemoved()

$groupMemberRemoved: (element) => any

Invoked when a group member has been removed

Parameters

element

ViewportElement<BrowserElement>

Returns

any

Overrides

UIPlugin.$groupMemberRemoved

---

$groupRemoved()

$groupRemoved: (element) => void

Invoked when a group has been removed

Parameters

element

ViewportGroupElement<BrowserElement>

Returns

void

Inherited from

UIPlugin.$groupRemoved

---

$groupResized()

$groupResized: (params) => any

Invoked when a group has been resized

Parameters

params

GroupResizeResult<BrowserElement>

Returns

any

Inherited from

UIPlugin.$groupResized

---

$nodeRemoved()

$nodeRemoved: (element) => void

Invoked when a node has been removed

Parameters

element

ViewportElement<BrowserElement>

Returns

void

Inherited from

UIPlugin.$nodeRemoved

---

$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

BrowserElement

id

string

size

Size

vertex

Vertex

Returns

void

Inherited from

UIPlugin.$vertexRerendered

---

$vertexResized()

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

Invoked when a vertex has been rotated

Parameters

element

ViewportElement<BrowserElement>

width

number

height

number

Returns

void

Inherited from

UIPlugin.$vertexResized

---

$vertexRotated()

$vertexRotated: (element, rotationInDegrees) => void

Invoked when a vertex has been resized

Parameters

element

ViewportElement<BrowserElement>

rotationInDegrees

number

Returns

void

Inherited from

UIPlugin.$vertexRotated

---

$vertexSynced()

$vertexSynced: (element) => void

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

Parameters

element

ViewportElement<BrowserElement>

Returns

void

Inherited from

UIPlugin.$vertexSynced

---

$vertexUpdated()

$vertexUpdated: (element, reason) => void

Invoked when a vertex has been updated

Parameters

element

ViewportElement<BrowserElement>

reason

VertexUpdatedReason

Returns

void

Inherited from

UIPlugin.$vertexUpdated

---

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.

Inherited from

UIPlugin.tracksEdgeRedraws