Skip to main content

Home > @jsplumbtoolkit/browser-ui-vue2 > addMiniview

addMiniview() function#

Add a Miniview to the Surface with the given id. If the Surface already exists and has been initialised the Miniview will be added immediately; otherwise it will be enqueued for later processing. This is just a wrapper around addComponent.

Signature:

export declare function addMiniview(surfaceId: string, params?: MiniviewPluginOptions): void;

Parameters#

ParameterTypeDescription
surfaceIdstringID of the Surface to add the Miniview to.
paramsMiniviewPluginOptionsConstructor parameters for the Miniview.

Returns:

void