Class BasePortComponent

The base class for components used to render ports. You must extend this component if you use a component for rendering ports. Your extension of this component needs to declare a constructor that takes an ElementRef. When you call the port component you need to pass the port's backing data as obj and its parent node/group component as parent.

Constructors

constructor

Properties

el obj parent

Methods

getPort getPortId removePort updatePort

Constructors

constructor

Properties

el

el: ElementRef<any>

obj

obj: ObjectData

Data object for the port. Required.

parent

parent: BaseNodeComponent

Parent node (or group) component. Required.

Methods

getPort

  • getPort(): Port

  • Returns the Port backing this component.

    Returns Port

getPortId

  • getPortId(): string

  • Returns the ID of the port. This is the ID of the port on its node, not the unique id of the port across the entire graph.

    Returns string

removePort

  • removePort(): void

  • Removes the port backing this component from the data model and from the UI.

    Returns void

updatePort

  • updatePort(data): void

  • Updates the data for the port backing this component, redrawing the component.

    Parameters

    • data: ObjectData

    Returns void

Settings

Member Visibility

Theme

On This Page

constructorelobjparentgetPortgetPortIdremovePortupdatePort
Version :