Interface CanvasGraphLayer<NodeData, EdgeData>

interface CanvasGraphLayer<NodeData = unknown, EdgeData = unknown> {
    coordinates?: GraphLayerCoordinates;
    id: string;
    order?: CanvasLayerOrder;
    type: "canvas";
    dispose?(): void;
    draw(
        context: CanvasRenderingContext2D,
        layer: GraphLayerContext<NodeData, EdgeData>,
    ): void;
    mount?(
        context: GraphLayerMountContext<NodeData, EdgeData>,
    ): void | (() => void);
}

Type Parameters

NodeData = unknown
EdgeData = unknown

Hierarchy

LayerBase
- CanvasGraphLayer

Index

Properties

coordinates? id order? type

Methods

dispose? draw mount?

Properties

`Optional` `Readonly`coordinates

coordinates?: GraphLayerCoordinates

`Readonly`id

id: string

`Optional` `Readonly`order

order?: CanvasLayerOrder

`Readonly`type

type: "canvas"

Methods

`Optional`dispose

dispose?(): void

Returns void

Inherited from LayerBase.dispose

draw

draw(
context: CanvasRenderingContext2D,
layer: GraphLayerContext<NodeData, EdgeData>,
): void
Parameters
- context: CanvasRenderingContext2D
- layer: GraphLayerContext<NodeData, EdgeData>
Returns void

`Optional`mount

mount?(context: GraphLayerMountContext<NodeData, EdgeData>): void | (() => void)
Parameters
- context: GraphLayerMountContext<NodeData, EdgeData>
Returns void | (() => void)