# simple-dag-editor

> A Simple Web DAG-Editor

Latest version **1.1.14** (published 2020-11-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-dag-editor
pnpm add simple-dag-editor
yarn add simple-dag-editor
bun add simple-dag-editor
```

## 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 | 1.1.14 |
| Published | 2020-11-12 |
| First published | 2020-10-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 579.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Author | hustliu |
| Maintainers | hustliu |

## Links

- npm: https://www.npmjs.com/package/simple-dag-editor
- Repository: git@github.com:HustLiuCN/dag-editor
- npm.io page: https://npm.io/package/simple-dag-editor

## Dependencies (2)

- [typescript](https://npm.io/package/typescript.md) ^4.0.3
- [@types/node](https://npm.io/package/@types/node.md) ^14.14.6

## Recent versions

- 1.1.14 (latest) — 2020-11-12
- 1.1.13 — 2020-11-12
- 1.1.12 — 2020-11-12
- 1.1.11 — 2020-11-06
- 1.1.10 — 2020-11-06
- 1.1.9 — 2020-11-03
- 1.1.8 — 2020-11-03
- 1.1.7 — 2020-11-02
- 1.1.6 — 2020-11-02
- 1.1.5 — 2020-11-02
- 1.1.4 — 2020-11-02
- 1.1.3 — 2020-10-30
- 1.1.2 — 2020-10-30
- 1.1.1 — 2020-10-30
- 1.1.0 — 2020-10-29
- … 1 more at https://npm.io/package/simple-dag-editor/versions

## README

a simple dag editor tool for web

[Demo](https://stillbold.com/demos/dag-editor/demos/editor.html)

[GitHub](https://github.com/HustLiuCN/dag-editor)

# usage

## install

``yarn add simple-dag-editor``

## init

```javascript
import { Editor } from 'simple-dag-editor'

const editor = new Editor({
  container: string, // editor container dom selector
  page: string,  // editor canvas page container dom selector
  itempanel: string,  // editor items panel container dom selector
})
```

## register shape

`` editor.registerShape(shapeName, shape) ``

```javascript
interface IShape {
  shape: string,  // shape name
  w: number,  // width
  h: number,  // height
  name: string, // node-item shown text
  anchors: IAnchor,
  [customProp: string]: any,  // any custom define property
}
interface IAnchor {
  input?: number,     // input count
  output?: number,    // output count
}
```

## callback

```javascript
interface INode extends IShape {
  x: number,  // canvas position
  y: number,  // canvas postion
}

interface IEdge {
  id: string,
  source: string,   // source node id
  sourceAnchorIndex: number,    // source node output anchor index
  target: string,   // target node id
  targetAnchorIndex: number,    // target node input anchor index
}
```

```javascript
interface callback {
  selectedNodeChange: (node: INode) => void,
  nodeAdded: (node: INode) => void,
  nodeDeleted: (nodeId: string) => void,
  edgeAdded: (edge: IEdge) => void,
  edgeDeleted: (edge: IEdge) => void,
}
```

**`` editor.on(`${callbackEventName}`, callback) ``**

### TODO
- ~~`nodeDeleted`~~
- ~~`nodeAdded`~~
- ~~**select edge**~~
- ~~**delete edge**~~
- ~~`edgeAdded` & `edgeDeleted` callback~~
- ~~**drag canvas**~~
- **scale**
- `editor.update()`

---
_Source: https://npm.io/package/simple-dag-editor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
