Graphora API
Preparing search index...
@graphora/layouts
ObstacleRouter
Class ObstacleRouter<NodeData, EdgeData>
Bounded, cancellable obstacle routing over measured world rectangles.
Type Parameters
NodeData
=
unknown
EdgeData
=
unknown
Implements
GraphLayout
<
NodeData
,
EdgeData
>
Index
Constructors
constructor
Properties
capabilities
name
options
Methods
cancel
dispose
get
Diagnostics
run
Constructors
constructor
new
ObstacleRouter
<
NodeData
=
unknown
,
EdgeData
=
unknown
>
(
options
?:
ObstacleRouterOptions
,
)
:
ObstacleRouter
<
NodeData
,
EdgeData
>
Type Parameters
NodeData
=
unknown
EdgeData
=
unknown
Parameters
options
:
ObstacleRouterOptions
= {}
Returns
ObstacleRouter
<
NodeData
,
EdgeData
>
Properties
Readonly
capabilities
capabilities
:
Readonly
<
{
edgeRoutes
:
true
;
labelPlacements
:
false
;
nodeGeometry
:
"required"
}
,
>
= ...
Readonly
name
name
:
"obstacle-router"
= 'obstacle-router'
Readonly
options
options
:
Required
<
ObstacleRouterOptions
>
Methods
cancel
cancel
()
:
void
Returns
void
dispose
dispose
()
:
void
Returns
void
get
Diagnostics
getDiagnostics
()
:
ObstacleRoutingDiagnostics
|
null
Returns
ObstacleRoutingDiagnostics
|
null
run
run
(
snapshot
:
LayoutInput
<
NodeData
,
EdgeData
>
,
context
?:
ObstacleRoutingContext
,
)
:
Promise
<
LayoutResult
>
Parameters
snapshot
:
LayoutInput
<
NodeData
,
EdgeData
>
Optional
context
:
ObstacleRoutingContext
Returns
Promise
<
LayoutResult
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
capabilities
name
options
Methods
cancel
dispose
get
Diagnostics
run
Graphora API
Loading...
Bounded, cancellable obstacle routing over measured world rectangles.