# @vhult/graph

> WebGPU graph rendering engine. Millions of nodes and edges

Version 0.2.0. Install: `npm install @vhult/graph`. Source: https://github.com/vhult/graph. Package: https://www.npmjs.com/package/@vhult/graph.

The whole documentation, guides and API reference, is in one Markdown file. Fetch it for any question about the library.

## Docs

- [Full documentation](/llms-full.txt): every guide and the whole API reference, with signatures and examples

## Contents of the full documentation

- Guide, Getting started: Install the package, draw a first graph and clean up after it.
- Guide, Nodes and edges: Load, add, change and remove nodes and edges with typed arrays.
- Guide, Styling: Colors, shapes, labels, icons and the look of highlighted nodes.
- Guide, Camera: Frame the graph, move and turn the view, and convert between screen and world.
- Guide, Interaction: Pan, zoom, drag, select, listen to events and ask what is under a point.
- Guide, Performance: Cross-origin isolation, frame numbers and the debug overlay.
- API, Start: Graph, GraphOptions, GraphCaps, GraphError, GraphErrorCode, UnsupportedError
- API, Nodes: GraphNodes, NodeData, NodeUpdate, NodeShape, NodeStream, NodeStreamChannels
- API, Edges: GraphEdges, EdgeData, EdgeUpdate
- API, Shared by nodes and edges: CopyOption, Flag, NO_INDEX
- API, Style: GraphStyleApi, GraphStyle, HighlightLook, OutlineLook, RGBA, packRgba, packEdgeStyle
- API, Icons: GraphIcons, IconSource, IconPath, IconSvg, NO_ICON
- API, Camera: GraphCamera, CameraView, CameraFitOptions, CameraAnimOptions, CameraEasing, CameraRotateOptions, CameraLimits, WorldBounds
- API, Input: GraphInputApi, GraphInput, Mode, SelectKey, SelectShape
- API, Events: GraphEvents, Hit, SelectEvent, DragStartEvent, DragMoveEvent, PanEvent, ZoomEvent, RotateEvent, GesturePhase
- API, Query: GraphQuery, Rect, Polygon
- API, Canvas and stats: GraphCanvas, GraphStats
- API, Debug: GraphDebug, DebugRecording, DebugSummary, DebugTotals, DebugTune, EdgeDebugMode, BenchmarkOptions, BenchmarkResult, CameraPathKey, LabelSnapshot