MiniviewPlugin

Miniview plugin for Surface.

Extends

• BaseBrowserUIPlugin

Implements

• BrowserUIPlugin<MiniviewPluginOptions>

Methods

$edgeRemoved()

$edgeRemoved(edge): void

Invoked when an edge has been removed

Parameters

edge

Edge

Returns

void

Implementation of

BrowserUIPlugin.$edgeRemoved

Inherited from

BaseBrowserUIPlugin.$edgeRemoved

---

$edgeRendered()

$edgeRendered(p): void

Invoked when an edge has been initially rendered. Only fired once for each edge.

Parameters

p

ConnectionEstablishedParams

Returns

void

Implementation of

BrowserUIPlugin.$edgeRendered

Inherited from

BaseBrowserUIPlugin.$edgeRendered

---

$edgeUpdated()

$edgeUpdated(edge): void

Invoked when an edge has been updated

Parameters

edge

Edge

Returns

void

Implementation of

BrowserUIPlugin.$edgeUpdated

Inherited from

BaseBrowserUIPlugin.$edgeUpdated

---

$groupCollapsed()

$groupCollapsed(element): void

Empty implementation of $groupCollapsed

Parameters

element

ViewportGroupElement<BrowserElement>

Returns

void

Implementation of

BrowserUIPlugin.$groupCollapsed

Overrides

BaseBrowserUIPlugin.$groupCollapsed

---

$groupExpanded()

$groupExpanded(element): void

Empty implementation of $groupExpanded.

Parameters

element

ViewportGroupElement<BrowserElement>

Returns

void

Implementation of

BrowserUIPlugin.$groupExpanded

Overrides

BaseBrowserUIPlugin.$groupExpanded

---

$vertexRerendered()

$vertexRerendered(p): void

Empty implementation of $vertexRerendered.

Parameters

p

el

BrowserElement

id

string

size

Size

vertex

Vertex

Returns

void

Implementation of

BrowserUIPlugin.$vertexRerendered

Inherited from

BaseBrowserUIPlugin.$vertexRerendered

---

$vertexResized()

$vertexResized(element, width, height): void

Empty implementation of $vertexResized

Parameters

element

ViewportElement<BrowserElement>

width

number

height

number

Returns

void

Implementation of

BrowserUIPlugin.$vertexResized

Overrides

BaseBrowserUIPlugin.$vertexResized

---

$vertexRotated()

$vertexRotated(element, rotation): void

Empty implementation of $vertexRotated.

Parameters

element

ViewportElement<BrowserElement>

rotation

number

Returns

void

Implementation of

BrowserUIPlugin.$vertexRotated

Overrides

BaseBrowserUIPlugin.$vertexRotated

---

$vertexSynced()

$vertexSynced(element): void

Empty implementation of $vertexSynced

Parameters

element

ViewportElement<BrowserElement>

Returns

void

Implementation of

BrowserUIPlugin.$vertexSynced

Inherited from

BaseBrowserUIPlugin.$vertexSynced

---

$vertexUpdated()

$vertexUpdated(element, reason): void

Empty implementation of $vertexUpdated

Parameters

element

ViewportElement<BrowserElement>

reason

VertexUpdatedReason

Returns

void

Implementation of

BrowserUIPlugin.$vertexUpdated

Overrides

BaseBrowserUIPlugin.$vertexUpdated

---

getRenderedVertex()

getRenderedVertex(vertexId): any

Parameters

vertexId

string

Returns

any

Deprecated

---

setVisible()

setVisible(v): void

Sets whether or not the miniview is visible. Strictly speaking you don't need to use this method you can just control the miniview's container via your own CSS or whatever. But the Surface uses this occasionally, and there is also the concept of having the miniview initially invisible until the related surface contains some data.

Parameters

v

boolean

Returns

void

---

toggleCollapsed()

toggleCollapsed(): void

Toggle the collapsed state of the miniview - which means that it toggles the class CLASS_MINIVIEW_COLLAPSED on the miniview element.

Returns

void

Properties

_clickToCenter

_clickToCenter: boolean

Defaults to true, meaning a click on a node/group in the miniview will cause that node/group to be centered in the related surface.

---

activeTracking

activeTracking: boolean

When true, which is the default, miniview elements move at the same time as their related element in the surface is being dragged.