Skip to main content

MiniviewPluginOptions

Options for the MiniviewPlugin

Extends​

Properties​

activeTracking?​

optional activeTracking: boolean

Defaults to true, meaning the miniview actively updates as nodes/groups are dragged on the related surface. If this is set to false, the miniview only updates after mouseup.

clickToCenter?​

optional 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.

collapsible?​

optional collapsible: boolean

Defaults to true, determines whether or not the miniview can be collapsed.

container​

container: BrowserElement

Element to render into. When using a library integration you do not provide this.

elementFilter()?​

optional elementFilter: (v) => boolean

Optional filter for elements to display. Defaults to undefined - all elements displayed.

Parameters​

v​

Vertex

Returns​

boolean

enableWheelZoom?​

optional enableWheelZoom: boolean

Defauts to true, Whether or not to enable the wheel zoom.

showLasso?​

optional showLasso: boolean

Defaults to true - the miniview will display a lasso as the user is using the lasso in the canvas

suspended?​

optional suspended: boolean

Defaults to false. Whether or not to suspend rendering after load.

trackSelection?​

optional trackSelection: boolean

Defaults to true - the miniview will add a CSS class to elements whose model object is in the current selection.

typeFunction()?​

optional typeFunction: (v) => string

Optional function to use to derive a type for each rendered node/group. This is written onto the corresponding element as the value of the data-vjs-miniview-type attribute, and can be useful for styling.

Parameters​

v​

Node | Group

Returns​

string

visible?​

optional visible: boolean

Defaults to true. Whether or not the miniview is initially visible.

wheelReverse?​

optional wheelReverse: boolean

Defaults to false. Whether or not to reverse the zoom direction in response to a wheel event.

wheelSensitivity?​

optional wheelSensitivity: number

Optional override for how sensitive the wheel zoom should be.