Skip to main content

Home > @jsplumbtoolkit/browser-ui-vue3 > registerSurface

registerSurface() function

Register an externally created Surface with the Toolkit's Vue subsystem. This method lets you register a Surface that you created using vanilla JS (for instance if you dont want to render using Vue components) and then other Vue components such as a Palette or Inspector will be able to interact with it.

Signature:

export declare function registerSurface(surfaceId: string, surface: Surface): void;

Parameters

ParameterTypeDescription
surfaceIdstring
surfaceSurface

Returns:

void