Router

Defined in: render/Router.ts:16

GoJS-compatible: abstract base class for a pluggable link-routing strategy, mirroring real GoJS’s Router. graphojs’s own rendering already computes link paths per Link.routing/avoidObstacles (render/LinkRouter.ts’s route* functions) rather than delegating to an instantiable Router — subclassing this and overriding routeLinks lets ported GoJS code plug into that decision instead of the individual per-link flags, but graphojs itself doesn’t consult a Router instance anywhere in its own rendering path.

Extended by

• AvoidsNodesRouter

Constructors

Constructor

new Router(): Router

Returns

Router

Properties

isEnabled

isEnabled: boolean = true

Defined in: render/Router.ts:18

---

isRealtime

isRealtime: boolean = false

Defined in: render/Router.ts:19

---

name

name: string = ''

Defined in: render/Router.ts:17

Accessors

diagram

Get Signature

get diagram(): Diagram | null

Defined in: render/Router.ts:22

Returns

Diagram | null

Set Signature

set diagram(value): void

Defined in: render/Router.ts:26

Parameters

value

Diagram | null

Returns

void

Methods

canRoute()

canRoute(_container): boolean

Defined in: render/Router.ts:36

Whether this router applies to the given container at all. Default: isEnabled.

Parameters

_container

Diagram | Group

Returns

boolean

---

invalidateRouter()

invalidateRouter(): void

Defined in: render/Router.ts:31

Request that routes be recomputed; the default just invalidates the diagram.

Returns

void

---

isRoutable()

isRoutable(_link, _container): boolean

Defined in: render/Router.ts:41

Whether this router should route the given link. Default: always.

Parameters

_link

Link

_container

Diagram | Group

Returns

boolean

---

routeLinks()

abstract routeLinks(links, container): void

Defined in: render/Router.ts:46

Route every link in links, within container. Must be overridden.

Parameters

links

Set<Link>

container

Diagram | Group

Returns

void