https://github.com/clemsos/graph-events

Manipulate and store states of your graphs over time.
https://github.com/clemsos/graph-events

Last synced: 5 days ago
JSON representation

Manipulate and store states of your graphs over time.

• Host: GitHub
• URL: https://github.com/clemsos/graph-events
• Owner: clemsos
• Created: 2017-07-26T12:32:18.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-27T07:57:16.000Z (over 7 years ago)
• Last Synced: 2024-12-14T04:18:38.910Z (9 days ago)
• Language: JavaScript
• Homepage: http://clemsos.github.io/graph-events/
• Size: 1020 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Graph Events

[![Build Status](https://travis-ci.org/clemsos/graph-events.svg?branch=master)](https://travis-ci.org/clemsos/graph-events)

[![NPM](https://nodei.co/npm/graph-events.png?compact=true)](https://npmjs.org/package/graph-events)

**Graph Events** is a storage system to create and manipulate states of networks and graphs based on the evolution of their properties over time.

## How it Works

* Graph are stored using **events**, so you can easily maintain states and do / undo / moderate changes.

* Everything is serializable in **JSON**, so all data can be stored in databases, plain files or just plain arrays.

See a [live demo](http://clemsos.github.io/graph-events/).

```js

// example without browser

// use `node graph-events-demo.js` to test

const {GraphEvent, Graph} = require('../lib/index.js')

const nodes = [

  { id : 1, label : "Node A", type : "node" },

  { id : 2, label : "Node B", type : "node" },

  { id : 3, label : "Node C", type : "node" }

]

const edges = [

  { source : 1, target : 2, label : "Edge A -> B", type : "edge" },

  { source : 2, target : 3, label : "Edge B -> C", type : "edge" }

]

// create nodes and edges

const eventCreateNodes = new GraphEvent({

  action : "create",

  data : nodes

})

const eventCreateEdges = new GraphEvent({

  action : "create",

  data : edges

})

// make some changes

const eventDeleteNodeA = new GraphEvent({

  action : "delete",

  selector : { id : 1, type : "node" }

})

const graphInit = new Graph([eventCreateNodes, eventCreateEdges ])

console.log( graphInit.nodes().length + " nodes" )

const graphFinal = new Graph([eventCreateNodes, eventCreateEdges, eventUpdateNodeA])

console.log( graphFinal.nodes().length + " nodes" )

/*

* Results in the console :

*

* $ node graph-events-demo.js       

*   3 nodes

*   2 nodes

*

*/

```

Check the [examples folder](./examples) to see how it is used.

### Commands

| Command | Description | Options |

|------|------|------|

| `create` | create new node(s) | Object data |

| `update` | update elements with new properties | Object selector, Object data |

| `delete` | delete nodes | Object selector |

### Publish

    npm run prepublish

    npm publish

### Test

    gulp test

### Docs

    gulp doc

then navigate to the `/docs` folder to see the documentation.