Class CanvasGraphRenderer<NodeData, EdgeData>

Type Parameters

NodeData = unknown
EdgeData = unknown

Implements

GraphRenderer<NodeData, EdgeData>

Index

Constructors

Methods

addLayer destroy exportImage getLabelPlacements mount pick render resize setInvalidationHandler unmount

Constructors

constructor

new CanvasGraphRenderer<NodeData = unknown, EdgeData = unknown>(
options?: CanvasGraphRendererOptions,
): CanvasGraphRenderer<NodeData, EdgeData>
Type Parameters
- NodeData = unknown
- EdgeData = unknown
Parameters
- options: CanvasGraphRendererOptions = {}
Returns CanvasGraphRenderer<NodeData, EdgeData>

Methods

addLayer

addLayer(
layer: GraphLayer<NodeData, EdgeData>,
options?: { enabled?: boolean },
): GraphLayerHandle
Parameters
- layer: GraphLayer<NodeData, EdgeData>
- options: { enabled?: boolean } = {}
Returns GraphLayerHandle

destroy

destroy(): void

Returns void

Implementation of GraphRenderer.destroy

exportImage

exportImage(options?: GraphImageExportOptions): GraphImageExport
Parameters
- options: GraphImageExportOptions = {}
Returns GraphImageExport

Implementation of GraphRenderer.exportImage

getLabelPlacements

getLabelPlacements(): LabelPlacementReport | null

Returns LabelPlacementReport | null

mount

mount(container: HTMLElement): void
Parameters
- container: HTMLElement
Returns void

Implementation of GraphRenderer.mount

pick

pick(
point: ScreenPoint,
snapshot?: RenderSnapshot<NodeData, EdgeData> | undefined,
): PickResult<NodeData, EdgeData>
Parameters
- point: ScreenPoint
- snapshot: RenderSnapshot<NodeData, EdgeData> | undefined = ...
Returns PickResult<NodeData, EdgeData>

Implementation of GraphRenderer.pick

render

render(snapshot: RenderSnapshot<NodeData, EdgeData>): void
Parameters
- snapshot: RenderSnapshot<NodeData, EdgeData>
Returns void

Implementation of GraphRenderer.render

resize

resize(size: ViewportSize): void
Parameters
- size: ViewportSize
Returns void

Implementation of GraphRenderer.resize

setInvalidationHandler

setInvalidationHandler(handler: (() => void) | null): void
Engine-owned redraw scheduling for renderer extensions.
Parameters
- handler: (() => void) | null
Returns void

Implementation of GraphRenderer.setInvalidationHandler

unmount

unmount(): void

Returns void

Implementation of GraphRenderer.unmount