AvoidsNodesRouter

Defined in: render/AvoidsNodesRouter.ts:15

GoJS-compatible: a Router that routes links around node obstacles. Real implementation: sets Link.avoidObstacles = true on every routed link, which graphojs’s renderer already respects via routeOrthogonalAvoidingObstacles (render/LinkRouter.ts) — this class doesn’t duplicate that pathfinding, it just flips the same flag real GoJS’s Routing.AvoidsNodes would.

Extends

• Router

Constructors

Constructor

new AvoidsNodesRouter(init?): AvoidsNodesRouter

Defined in: render/AvoidsNodesRouter.ts:16

Parameters

init?

Partial<AvoidsNodesRouter>

Returns

AvoidsNodesRouter

Overrides

Router.constructor

Properties

isEnabled

isEnabled: boolean = true

Defined in: render/Router.ts:18

Inherited from

Router.isEnabled

---

isRealtime

isRealtime: boolean = false

Defined in: render/Router.ts:19

Inherited from

Router.isRealtime

---

name

name: string = ''

Defined in: render/Router.ts:17

Inherited from

Router.name

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

Inherited from

Router.diagram

Methods

canRoute()

canRoute(_container): boolean

Defined in: render/AvoidsNodesRouter.ts:21

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

Parameters

_container

Diagram | Group

Returns

boolean

Overrides

Router.canRoute

---

invalidateRouter()

invalidateRouter(): void

Defined in: render/Router.ts:31

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

Returns

void

Inherited from

Router.invalidateRouter

---

isRoutable()

isRoutable(_link, _container): boolean

Defined in: render/AvoidsNodesRouter.ts:25

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

Parameters

_link

Link

_container

Diagram | Group

Returns

boolean

Overrides

Router.isRoutable

---

routeLinks()

routeLinks(links, _container): void

Defined in: render/AvoidsNodesRouter.ts:29

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

Parameters

links

Set<Link>

_container

Diagram | Group

Returns

void

Overrides

Router.routeLinks