Provides a component that manages a surface.

Type Parameters

Properties

renderParams: RO

Options for the underlying surface widget.

runInsideAngular: boolean = false

Set this to false if you do not want the Surface to set itself up inside a runOutsideAngular call. We do not recommend this. When the Surface setup is run inside Angular all of the event bindings from the surface's pan/zoom/drag handlers are piped through Angular, causing change detection events, which can result in a performance hit. We've only added this in case there is an unforeseen backwards compatibility issue in someone's app, but all of our testing of this change suggests that is unlikely.

surface: Surface
surfaceId: string

ID to use for the created surface. Required.

toolkitId: string

ID of the Toolkit to which to attach the surface. Required.

toolkitParams?: JsPlumbToolkitOptions

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<{
    component: ComponentRef<any>;
    event: string;
    payload: any;
    vertex: Vertex;
}> = ...

output event emitter, for proxying events from vertex components.

Type declaration

  • component: ComponentRef<any>
  • event: string
  • payload: any
  • vertex: Vertex
view: VO

Options for the view - mappings of components and behaviour to model object types.

Version :