# @graph-viz/core

> > TODO: description

Latest version **2.2.4** (published 2020-08-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install @graph-viz/core
pnpm add @graph-viz/core
yarn add @graph-viz/core
bun add @graph-viz/core
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.4 |
| Published | 2020-08-14 |
| First published | 2019-08-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 398 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | sagar-sm |
| Maintainers | ssm |

## Links

- npm: https://www.npmjs.com/package/@graph-viz/core
- Repository: https://github.com/uplevel-technology/graph-viz
- Homepage: https://github.com/uplevel-technology/graph-viz#readme
- Issues: https://github.com/uplevel-technology/graph-viz/issues
- npm.io page: https://npm.io/package/@graph-viz/core

## Dependencies (3)

- [three](https://npm.io/package/three.md) ^0.116.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13

## Recent versions

- 2.2.4 (latest) — 2020-08-14
- 2.2.3 — 2020-08-14
- 2.2.2 — 2020-08-14
- 2.2.1 — 2020-08-14
- 2.2.0 — 2020-08-14
- 2.1.2 — 2020-06-15
- 2.1.1 — 2020-06-15
- 2.1.0 — 2020-06-15
- 2.0.0 — 2020-06-14
- 1.2.3 — 2020-05-27
- 1.2.2 — 2020-05-21
- 1.2.1 — 2020-05-21
- 1.2.0 — 2020-05-21
- 1.1.2 — 2020-05-19
- 1.1.1 — 2020-05-19
- … 10 more at https://npm.io/package/@graph-viz/core/versions

## README

GraphViz library is a high-performance WebGL based library for drawing graph visualizations.

------------------------------------------------------------------------


# @graph-viz/core

> WebGL based core drawing utility for graph visualizations

The `@graph-viz/core` package takes graph data as input and draws it on a canvas using WebGL.
Input data is treated as an immutable entity by this package and it only exposes interaction events that
can be used by callers to update the data and re-render the visualization.  

## Installation
`npm i @graph-viz/core --save`

## Usage

```typescript
import {GraphVisualization} from '@graph-viz/core'

// See docs for argument structures
const visualization = new GraphVisualization(
  vizData, // visualization input data
  canvas,  // dom element
  width,   // number
  height,  // number
  config,  // config
);
```

-----------------------------------------------------------------

# @graph-viz/layouts

> Layout algorithms for graphs.

Implemented:
* Force Simulation (uses d3-force)

In Progress:
* Temporal Graph Layout

This packages exposes stateful (force simulations) as well as stateless plug-n-play 
layout generation functions that can be used to seed nodes and links data with positions 
on the canvas. 

## Installation
`npm install @graph-viz/layouts --save`

## Usage

```typescript
import {ForceSimulation} from '@graph-viz/layouts'

const simulation = new ForceSimulation();

simulation.init(data);

simulation.onTick(callback);
```

-----------------------------------------------------------------

# @graph-viz/react


A zero-config plug and play React component to draw a force directed graph visualization.
Depends on `@graph-viz/core` and `@graph-viz/layouts`

## Installation
`npm install @graph-viz/react --save`

## Usage

```typescript
import {GraphVizComponent} from '@graph-viz/react'

...
  <GraphVizComponent
    editMode
    nodes={[]}
    links={[]]}
    tooltips={[]}
  />
```

---
_Source: https://npm.io/package/@graph-viz/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._