Graphora API
Preparing search index...
@graphora/react
GraphRef
Interface GraphRef<NodeData, EdgeData>
interface
GraphRef
<
NodeData
=
unknown
,
EdgeData
=
unknown
>
{
clearPositionMemory
()
:
void
;
clearSelection
()
:
SelectionState
;
fitToView
(
options
?:
FitBoundsOptions
)
:
ViewportState
|
null
;
getEngine
()
:
GraphEngine
<
NodeData
,
EdgeData
>
|
null
;
getSelection
()
:
SelectionState
;
getViewport
()
:
ViewportState
|
null
;
render
()
:
void
;
runLayout
(
options
?:
GraphEngineLayoutOptions
,
)
:
Promise
<
GraphEngineLayoutRun
|
null
>
;
setSelection
(
selection
:
SelectionStateInput
)
:
SelectionState
;
setViewport
(
viewport
:
ViewportPartial
)
:
ViewportState
|
null
;
}
Type Parameters
NodeData
=
unknown
EdgeData
=
unknown
Index
Methods
clear
Position
Memory
clear
Selection
fit
To
View
get
Engine
get
Selection
get
Viewport
render
run
Layout
set
Selection
set
Viewport
Methods
clear
Position
Memory
clearPositionMemory
()
:
void
Returns
void
clear
Selection
clearSelection
()
:
SelectionState
Returns
SelectionState
fit
To
View
fitToView
(
options
?:
FitBoundsOptions
)
:
ViewportState
|
null
Parameters
Optional
options
:
FitBoundsOptions
Returns
ViewportState
|
null
get
Engine
getEngine
()
:
GraphEngine
<
NodeData
,
EdgeData
>
|
null
Returns
GraphEngine
<
NodeData
,
EdgeData
>
|
null
get
Selection
getSelection
()
:
SelectionState
Returns
SelectionState
get
Viewport
getViewport
()
:
ViewportState
|
null
Returns
ViewportState
|
null
render
render
()
:
void
Returns
void
run
Layout
runLayout
(
options
?:
GraphEngineLayoutOptions
,
)
:
Promise
<
GraphEngineLayoutRun
|
null
>
Parameters
Optional
options
:
GraphEngineLayoutOptions
Returns
Promise
<
GraphEngineLayoutRun
|
null
>
set
Selection
setSelection
(
selection
:
SelectionStateInput
)
:
SelectionState
Parameters
selection
:
SelectionStateInput
Returns
SelectionState
set
Viewport
setViewport
(
viewport
:
ViewportPartial
)
:
ViewportState
|
null
Parameters
viewport
:
ViewportPartial
Returns
ViewportState
|
null
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
clear
Position
Memory
clear
Selection
fit
To
View
get
Engine
get
Selection
get
Viewport
render
run
Layout
set
Selection
set
Viewport
Graphora API
Loading...