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
| Property | Modifiers | Type | Description |
|---|---|---|---|
| _collapsed | boolean | ||
| _collapser | any | ||
| _collapsible | boolean | ||
| _doToggleCollapse | Function | ||
| _zoomToFit | (a: any, e?: any) => any | ||
| canvasElement | any | ||
| containerElement | any | ||
| downAt | PointXY | ||
| elementFilter | (vertex: Node | Group) => boolean | ||
| enableWheelZoom | boolean | ||
| eventManager | EventManager | ||
| pannerAtMouseDown | PointXY | ||
| pannerElement | any | ||
| pannerPos | PointXY | ||
| panning | boolean | ||
| panzoom | PanZoom | ||
| surface | Surface | ||
| surfaceBindings | Array<[string, Function]> | ||
| surfaceBounds | ViewportBounds | ||
| suspended | boolean | ||
| type | static | string | |
| typeFunction | (v: Node | Group) => string | ||
| vertexMap | Record<string, MiniviewDOMElement> | ||
| viewport | Viewport<any> | ||
| visible | boolean | ||
| wheelReverse | boolean | ||
| wheelSensitivity | number | ||
| zoomingWithWheel | boolean |
Methods
| Method | Modifiers | Description |
|---|---|---|
| _migrateGroupMembers(group, groupEl) | ||
| _nodeAdded(params, extraClasses) | ||
| _objectRepainted(info) | ||
| _showGroupMembers(group, state) | ||
| _updatePanner() | ||
| _updateSurface(pannerPos) | ||
| bindToSurface(evtName, handler) | ||
| destroy() | ||
| getPan() | ||
| 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. |