Skip to main content
Version: 4.3

HaloMakeLinkParams

Arguments passed to a HaloMakeLink callback: the native ui.Halo.MakeLinkContext fields plus the originating event and the React context (model = the haloed source cell, paper, graph).

Extends​

  • HaloHandleEventContext

Properties​

action​

readonly action: string;

Halo action that triggered link creation (e.g. 'link').


defaultAction​

readonly defaultAction: string;

The handle's defaultAction, if any.


event​

readonly event: Event;

The originating (normalized) pointer event.


graph​

readonly graph: Graph;

The graph the cell belongs to.

model​

readonly model: Cell;

The cell the halo is attached to.

paper​

readonly paper: Paper;

The paper the halo is rendered on.

source​

readonly source: EndJSON;

Resolved source end of the link.


sourceMagnet​

readonly sourceMagnet: SVGElement;

Source magnet DOM element.


sourceView​

readonly sourceView: ElementView;

View of the source element.


target​

readonly target: EndJSON;

Resolved target end of the link.


targetMagnet​

readonly targetMagnet: SVGElement | null;

Target magnet DOM element, or null.


targetView​

readonly targetView: CellView | null;

View of the target cell, or null when dropping on blank.