Skip to main content

Home > @jsplumbtoolkit/browser-ui-angular > jsPlumbSurfaceComponent

jsPlumbSurfaceComponent class#

Provides a component that manages a surface.

Signature:

export declare class jsPlumbSurfaceComponent<VO extends AngularViewOptions = AngularViewOptions, RO extends AngularRenderOptions = AngularRenderOptions> 

Constructors#

ConstructorModifiersDescription
(constructor)(el, $jsplumb, componentFactoryResolver, viewContainerRef)Constructs a new instance of the jsPlumbSurfaceComponent class

Properties#

PropertyModifiersTypeDescription
groupUpdateFn(a: any, e?: any) => any
nodeUpdateFn(a: any, e?: any) => any
portAddedFn(a: any, e?: any) => any
renderParamsROOptions for the underlying surface widget.
surfaceSurface
surfaceIdstringID to use for the created surface. Required.
toolkitBrowserUIAngular
toolkitIdstringID of the Toolkit to which to attach the surface. Required.
toolkitParams?JsPlumbToolkitOptions(Optional) Optional parameters for the underlying Toolkit. These will be used only if the Toolkit instance with the given ID has not yet been created somewhere else in the app.
vertexEventEventEmitter<{ vertex: Vertex; event: string; payload: any; component: ComponentRef<any>; }>output event emitter, for proxying events from vertex components.
viewVOOptions for the view - mappings of components and behaviour to model object types.