Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fibo/flow-view
is a visual editor for Dataflow programming
https://github.com/fibo/flow-view
data-flow dataflow-programming nodejs svg visual-editor
Last synced: 3 days ago
JSON representation
is a visual editor for Dataflow programming
- Host: GitHub
- URL: https://github.com/fibo/flow-view
- Owner: fibo
- License: mit
- Created: 2014-11-22T14:55:34.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2024-09-08T10:47:57.000Z (3 months ago)
- Last Synced: 2024-11-21T22:35:19.063Z (20 days ago)
- Topics: data-flow, dataflow-programming, nodejs, svg, visual-editor
- Language: JavaScript
- Homepage: http://fibo.github.io/flow-view
- Size: 12.6 MB
- Stars: 191
- Watchers: 14
- Forks: 23
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - fibo/flow-view - is a visual editor for Dataflow programming (nodejs)
README
# flow-view
> is a visual editor for [Dataflow programming][dataflow_wikipedia]
## Installation
### Using npm
With [npm](https://npmjs.org/) do
```bash
npm install flow-view
```
### Using a CDN
Try this in your HTML page
```html
import { FlowView } from "https://unpkg.com/flow-view"
const flowView = new FlowView(document.body)
```
## Usage
### GUI
Try [demo here](http://fibo.github.io/flow-view/)
- Drag on canvas to translate all items.
- Click on item to select it.
- Click while pressing SHIFT to enable multi selection.
- Drag selected items to translate them.
- Drag from a node output to a node input to create an edge.
- Press BACKSPACE to delete selected items.
- Double click on edge to delete it.
- Double click on canvas to open the selector.
- Type into the selector then press ENTER to create a new node.
### Constructor
Create a `FlowView` instance and pass it a container. It will create a
`flow-view` custom element and attach it to the _container_. Be aware that the
`flow-view` custom element will fit the whole height of its container, so make
sure to style properly to avoid a zero height container.
```html
import { FlowView } from "https://unpkg.com/flow-view"
const flowView = new FlowView(document.body)
```
If some `flow-view` custom element is already in the page, it can be passed to
the `FlowView` constructor. argument.
```html
import { FlowView } from "https://unpkg.com/flow-view"
const flowView = new FlowView(document.getElementById("my-view"))
```
### Color schemes
Optionally set _color scheme_. If not provided it defaults to both light and
dark according to system preferences.
Light scheme.
```html
```
Dark scheme.
```html
```
See also
[color schemes example](http://fibo.github.io/flow-view/examples/color-schemes/demo.html).
### `addNodeDefinitions({ nodes?, types? })`
Add a list to define which nodes are available. It is not required but it makes
sense to be provided in the majority of use cases.
```javascript
flowView.addNodeDefinitions({
nodes: [
{ name: "Marge", type: "parent" },
{ name: "Homer", type: "parent" },
{ name: "Bart", type: "child" },
{ name: "Lisa", type: "child" },
{ name: "Mr. Burns" }
],
types: {
parent: {
inputs: [],
outputs: [{ name: "out" }]
},
child: {
inputs: [{ name: "in1" }, { name: "in2" }],
outputs: []
}
}
})
```
### `node(id)`
Get _flow-view_ node by id.
```javascript
const node = flowView.node("abc")
```
### `edge(id)`
Get _flow-view_ edge by id.
```javascript
const edge = flowView.edge("abc")
```
### `graph`
Access current _flow-view_ graph.
```javascript
console.log(flowView.graph)
```
### `loadGraph({ nodes = [], edges = [] })`
Load a _flow-view_ graph.
```javascript
flowView.loadGraph({
nodes: [
{
id: "dad",
text: "Homer",
x: 60,
y: 70,
outs: [{ id: "children" }]
},
{
id: "mom",
text: "Marge",
x: 160,
y: 70,
outs: [{ id: "children" }]
},
{
id: "son",
text: "Bart",
x: 60,
y: 240,
ins: [{ id: "father" }, { id: "mother" }]
},
{
id: "daughter",
text: "Lisa",
x: 220,
y: 220,
ins: [{ id: "father" }, { id: "mother" }]
}
],
edges: [
{ from: ["dad", "children"], to: ["son", "father"] },
{ from: ["dad", "children"], to: ["daughter", "father"] },
{ from: ["mom", "children"], to: ["son", "mother"] },
{ from: ["mom", "children"], to: ["daughter", "mother"] }
]
})
```
### `clearGraph()`
Empty current graph.
```javascript
flowView.clearGraph()
```
### `destroy()`
Delete `flow-view` custom element.
```javascript
flowView.destroy()
```
An use case for `destroy()` is the following. Suppose you are using Next.js, you
need to load `flow-view` with an async import into a `useEffect` which needs to
return a callback to be called when component is unmounted.
This is a sample code.
```typescript
import type { FlowView } from "flow-view";
import { FC, useEffect, useRef } from "react";
const MyComponent: FC = () => {
const flowViewContainerRef = useRef(null);
const flowViewRef = useRef(null);
useEffect(() => {
let unmounted = false;
const importFlowView = async () => {
if (unmounted) return;
if (flowViewContainerRef.current === null) return;
if (flowViewRef.current !== null) return;
const { FlowView } = await import("flow-view");
const flowView = new FlowView({
container: flowViewContainerRef.current,
});
flowViewRef.current = flowView;
};
importFlowView();
return () => {
unmounted = true;
if (flowViewRef.current !== null) flowViewRef.current.destroy();
};
}, [flowViewRef, flowViewContainerRef]);
return
;};
```
### `newNode()` and `newEdge()`
Create nodes and edges programmatically. See
[programmatic example here](http://fibo.github.io/flow-view/examples/programmatic/demo.html).
```javascript
// Create two nodes.
const node1 = flowView.newNode({
text: "Hello",
ins: [{}, {}],
outs: [{ id: "output1" }],
x: 100,
y: 100,
width: 80
})
const node2 = flowView.newNode({
text: "World",
ins: [{ id: "input1" }],
width: 100,
x: 250,
y: 400
})
// Connect nodes with an edge.
flowView.newEdge({
from: [node1.id, "output1"],
to: [node2.id, "input1"]
})
```
### `deleteNode()` and `deleteEdge()`
Delete nodes and edges programmatically. Notice that when a node is deleted, all
its connected edges are deleted too.
```javascript
const nodeId = "abc"
const edgeId = "123"
flowView.deleteNode(nodeId)
flowView.deleteEdge(edgeId)
```
### `addNodeClass(nodeType, NodeClass)`
Can add custom node class. See
[custom node example here](http://fibo.github.io/flow-view/examples/custom-node/demo.html).
### `onChange(callback)`
Set callback to be invoked on every view change. See
[demo code here](https://github.com/fibo/flow-view/blob/main/index.html).
Callback signature is `({ action, data }, info) => void`, where
- **action** can be `CREATE_NODE`, `DELETE_NODE`, etc.
- **data** change based on action
- **info** can contain `{ isLoadGraph: true }` or other optional information.
### `nodeTextToType(func)`
Set a function that will be invoked on node creation to resolve node type from
node text.
## License
[MIT](http://fibo.github.io/mit-license)
[dataflow_wikipedia]: https://en.wikipedia.org/wiki/Dataflow_programming "Dataflow programming"