Internal manager for registration, selection, and execution of edge routing implementations.

Remarks

For application code, use NgDiagramService routing methods instead. This class is exposed primarily for middleware development where you can access it via context.edgeRoutingManager.

The manager comes pre-populated with built-in routings (orthogonal, bezier, polyline). You can register custom routings at runtime.

Example

const middleware: Middleware = {
  name: 'routing-optimizer',
  execute: (context, next) => {
    const routingManager = context.edgeRoutingManager;
    const defaultRouting = routingManager.getDefaultRouting();
    console.log('Using routing:', defaultRouting);
    next();
  }
};

Methods

computePath()

computePath(routingName, points): string

Computes an SVG path string for the given points using the specified routing.

Parameters

routingName

The routing to use. If omitted or undefined, the default routing is used.

undefined | EdgeRoutingName

points

Point[]

The points to convert into an SVG path string

Returns

string

An SVG path string suitable for the d attribute of an SVG <path> element

Example

const points = [{ x: 0, y: 0 }, { x: 100, y: 100 }, { x: 200, y: 100 }];
const path = routingManager.computePath('polyline', points);
// Returns: "M 0 0 L 100 100 L 200 100"

---

computePointOnPath()

computePointOnPath(routingName, points, percentage): Point

Computes a point along the path at a given percentage.

Parameters

routingName

The routing to use. If omitted or undefined, the default routing is used.

undefined | EdgeRoutingName

points

Point[]

The path points

percentage

number

Position along the path in range [0, 1] where 0 = start, 1 = end

Returns

Point

The interpolated point on the path

Remarks

If the selected routing implements computePointOnPath, it will be used. Otherwise, falls back to linear interpolation between the first and last points.

Example

const points = [{ x: 0, y: 0 }, { x: 100, y: 100 }];
const midpoint = routingManager.computePointOnPath('polyline', points, 0.5);
// Returns: { x: 50, y: 50 }
const quarterPoint = routingManager.computePointOnPath('polyline', points, 0.25);
// Returns: { x: 25, y: 25 }

---

computePoints()

computePoints(routingName, context): Point[]

Computes the routed points for an edge using the specified routing algorithm.

Parameters

routingName

The routing to use. If omitted or undefined, the default routing is used.

undefined | EdgeRoutingName

context

EdgeRoutingContext

The routing context containing source/target nodes, ports, edge data, etc.

Returns

Point[]

The computed polyline as an array of points

Example

const points = routingManager.computePoints('orthogonal', {
  sourceNode: node1,
  targetNode: node2,
  sourcePosition: { x: 100, y: 50 },
  targetPosition: { x: 300, y: 200 },
  edge: edge
});

---

getDefaultRouting()

getDefaultRouting(): EdgeRoutingName

Gets the current default routing name.

Returns

EdgeRoutingName

The name of the current default routing

---

getRegisteredRoutings()

getRegisteredRoutings(): EdgeRoutingName[]

Gets all registered routing names.

Returns

EdgeRoutingName[]

An array of registered routing names (built-in and custom)

---

getRouting()

getRouting(name): undefined | EdgeRouting

Gets a routing implementation by name.

Parameters

name

EdgeRoutingName

The routing name to look up

Returns

undefined | EdgeRouting

The routing implementation or undefined if not registered

---

hasRouting()

hasRouting(name): boolean

Checks whether a routing is registered.

Parameters

name

EdgeRoutingName

The routing name to check

Returns

boolean

true if registered; otherwise false

---

registerRouting()

registerRouting(routing): void

Registers (or replaces) a routing implementation.

Parameters

routing

EdgeRouting

The routing instance to register. Its name must be non-empty.

Returns

void

---

setDefaultRouting()

setDefaultRouting(name): void

Sets the default routing to use for all edges when no specific routing is specified.

Parameters

name

EdgeRoutingName

The routing name to set as default

Returns

void

---

unregisterRouting()

unregisterRouting(name): void

Unregisters a routing by name.

Parameters

name

EdgeRoutingName

The routing name to remove

Returns

void