Skip to main content

BaseAngularOverlayComponent

A component that you can use as a base for your own overlay component if its convenient for you. This class offers an updateEdge and a removeEdge method, as helpers, and three signals:

$edgeData() - The current backing data for the edge, updated when an edge or its source/target is updated $sourceData() - The current backing data for the edge's source, updated when that vertex is updated $targetData() - The current backing data for the edge's target, updated when that vertex is updated

Type Parameters

T

T extends BrowserUI = BrowserUI

Implements

Methods

ngOnDestroy()

ngOnDestroy(): void

A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.

Returns

void

Implementation of

OnDestroy.ngOnDestroy


ngOnInit()

ngOnInit(): void

A callback method that is invoked immediately after the default change detector has checked the directive's data-bound properties for the first time, and before any of the view or content children have been checked. It is invoked only once when the directive is instantiated.

Returns

void

Implementation of

OnInit.ngOnInit


removeEdge()

removeEdge(): void

Remove the underlying edge. This will unload the edge and its visual representation, including this overlay component.

Returns

void

Class Member


updateEdge()

updateEdge(updates): void

Update the underlying edge with the given data.

Parameters

updates

ObjectData

Data to update the edge with

Returns

void

Class Member

Properties

$edgeData

$edgeData: WritableSignal<ObjectData>

Signal


$sourceData

$sourceData: WritableSignal<ObjectData>

Signal


$targetData

$targetData: WritableSignal<ObjectData>

Signal


data

data: ObjectData

Backing data for the edge this overlay is attached to

Class Member

Implementation of

AngularOverlayComponent.data


edge

edge: Edge

Underlying Edge model object this overlay is attached to

Class Member

Implementation of

AngularOverlayComponent.edge


model

model: VisuallyJsModel

The underlying model

Class Member

Implementation of

AngularOverlayComponent.model


ui

ui: T

The UI that this overlay is rendered by

Class Member

Implementation of

AngularOverlayComponent.ui