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

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

Properties

Property	Modifiers	Type	Description
edgeAddFn		(a: any, e?: any) => any
edgeUpdateFn		(a: any, e?: any) => any
groupUpdateFn		(a: any, e?: any) => any
nodeUpdateFn		(a: any, e?: any) => any
portAddedFn		(a: any, e?: any) => any
portUpdateFn		(a: any, e?: any) => any
renderParams		RO	Options for the underlying surface widget.
surface		Surface
surfaceId		string	ID to use for the created surface. Required.
toolkit		BrowserUIAngular
toolkitId		string	ID 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.
vertexEvent		EventEmitter<{ vertex: Vertex; event: string; payload: any; component: ComponentRef<any>; }>	output event emitter, for proxying events from vertex components.
view		VO	Options for the view - mappings of components and behaviour to model object types.

Methods

Method	Modifiers	Description
portUpdated(params)