Graphora API
Preparing search index...
@graphora/renderer
GraphRenderer
Interface GraphRenderer<NodeData, EdgeData>
interface
GraphRenderer
<
NodeData
=
unknown
,
EdgeData
=
unknown
>
{
destroy
?
()
:
void
;
exportImage
?
(
options
?:
GraphImageExportOptions
)
:
GraphImageExport
;
mount
(
container
:
HTMLElement
)
:
void
;
pick
(
point
:
ScreenPoint
,
snapshot
?:
RenderSnapshot
<
NodeData
,
EdgeData
>
,
)
:
PickResult
<
NodeData
,
EdgeData
>
|
null
;
render
(
snapshot
:
RenderSnapshot
<
NodeData
,
EdgeData
>
)
:
void
;
resize
(
size
:
ViewportSize
)
:
void
;
setInvalidationHandler
?
(
handler
:
(
()
=>
void
)
|
null
)
:
void
;
unmount
()
:
void
;
}
Type Parameters
NodeData
=
unknown
EdgeData
=
unknown
Implemented by
CanvasGraphRenderer
Index
Methods
destroy?
export
Image?
mount
pick
render
resize
set
Invalidation
Handler?
unmount
Methods
Optional
destroy
destroy
?
()
:
void
Returns
void
Optional
export
Image
exportImage
?
(
options
?:
GraphImageExportOptions
)
:
GraphImageExport
Parameters
Optional
options
:
GraphImageExportOptions
Returns
GraphImageExport
mount
mount
(
container
:
HTMLElement
)
:
void
Parameters
container
:
HTMLElement
Returns
void
pick
pick
(
point
:
ScreenPoint
,
snapshot
?:
RenderSnapshot
<
NodeData
,
EdgeData
>
,
)
:
PickResult
<
NodeData
,
EdgeData
>
|
null
Parameters
point
:
ScreenPoint
Optional
snapshot
:
RenderSnapshot
<
NodeData
,
EdgeData
>
Returns
PickResult
<
NodeData
,
EdgeData
>
|
null
render
render
(
snapshot
:
RenderSnapshot
<
NodeData
,
EdgeData
>
)
:
void
Parameters
snapshot
:
RenderSnapshot
<
NodeData
,
EdgeData
>
Returns
void
resize
resize
(
size
:
ViewportSize
)
:
void
Parameters
size
:
ViewportSize
Returns
void
Optional
set
Invalidation
Handler
setInvalidationHandler
?
(
handler
:
(
()
=>
void
)
|
null
)
:
void
Engine-owned redraw scheduling for renderer extensions.
Parameters
handler
: (
()
=>
void
)
|
null
Returns
void
unmount
unmount
()
:
void
Returns
void
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
destroy
export
Image
mount
pick
render
resize
set
Invalidation
Handler
unmount
Graphora API
Loading...
Engine-owned redraw scheduling for renderer extensions.