Skip to main content

Home > @jsplumbtoolkit/browser-ui-plugin-miniview > MiniviewPlugin

MiniviewPlugin class#

Miniview plugin for Surface. In previous versions of jsplumb this was embedded in the Surface.

Signature:

export declare class MiniviewPlugin extends OptimisticEventGenerator implements SurfacePlugin 

Extends: OptimisticEventGenerator

Implements: SurfacePlugin

Properties#

PropertyModifiersTypeDescription
_collapsedboolean
_collapserany
_collapsibleboolean
_doToggleCollapseFunction
_zoomToFit(a: any, e?: any) => any
canvasElementany
containerElementany
downAtPointXY
elementFilter(vertex: Node | Group) => boolean
enableWheelZoomboolean
eventManagerEventManager
pannerAtMouseDownPointXY
pannerElementany
pannerPosPointXY
panningboolean
panzoomPanZoom
surfaceSurface
surfaceBindingsArray<[string, Function]>
surfaceBoundsViewportBounds
suspendedboolean
typestaticstring
typeFunction(v: Node | Group) => string
vertexMapDictionary<MiniviewDOMElement>
viewportViewport<any>
visibleboolean
wheelReverseboolean
wheelSensitivitynumber
zoomingWithWheelboolean

Methods#

MethodModifiersDescription
_migrateGroupMembers(group, groupEl)
_nodeAdded(params, extraClasses)
_objectRepainted(info)
_showGroupMembers(group, state)
_updatePanner()
_updateSurface(pannerPos)
bindToSurface(evtName, handler)
destroy()
getPan()
getPosition(nodeId)
getRenderedVertex(vertexId)
initialise(surface, options)
invalidate(id)
registerNode(params)
reset()
setSuspended(s, updateAfterwards)
setVisible(v)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.