Skip to content

Latest commit

 

History

History
223 lines (171 loc) · 4.97 KB

README.md

File metadata and controls

223 lines (171 loc) · 4.97 KB
Raw

vue-visjs

Vue2 component that helps with Visjs interaction. This is a fork of the vis2vue project to update to the latest split component Visjs structure.

Build Status Software License Latest Version Issues

Installation

npm install --save vue-visjs

or

yarn add vue-visjs

Usage

Declare the component

import { Timeline } from 'vue-visjs'
Vue.component('timeline', Timeline)

Add the component in the template.

<body>
  <div id="app">
    <timeline ref="timeline" :items="items" :groups="groups" :options="options"> </timeline>
  </div>
</body>

Add groups, items and options in your observed data or computed.

new Vue({
  el: '#app',
  data() {
    return {
      groups: [
        {
          id: 0,
          content: 'Group 1'
        }
      ],
      items: [
        {
          id: 0,
          group: 0,
          start: new Date(),
          content: 'Item 1'
        }
      ],
      options: {
        editable: true
      }
    }
  }
})

Events

Component Events

By default all Vis events are emitted by your component. You can subscribe to a subset by passing an array in the prop events Visjs event.

<body>
  <div id="app">
    <timeline
      ref="timeline"
      :items="items"
      :groups="groups"
      :options="options"
      :events="['drop', 'changed']"
      @drop="myDropCallback"
      @changed="myChangedCallback"
    >
    </timeline>
  </div>
</body>

Data Events

When you pass an Array of data object, it is converted internally as a DataSet. An event with the DataSet object will be fired at mounted. It's name will be prepend with the prop name (Ex: items-mounted, groups-mounted). You could use it to interact with the DataSet.

All the Visjs DataSet event will be prepened the same fashion (items-add, items-remove, items-update). For example, pushing a new object to the items prop will fire a items-add event with the following payload:

{
  event: 'add',
  properties: {
    items: [7],
  },
  senderId: null,
}

Advanced

You can also manage your own data bindings by passing your own DataSet or DataView instead of an Array.

import { DataSet } from 'vue2vis'

new Vue({
  el: '#app',
  data() {
    return {
      groups: new DataSet([
        {
          id: 0,
          content: 'Group 1'
        }
      ]),
      items: new DataSet([
        {
          id: 0,
          group: 0,
          start: new Date(),
          content: 'Item 1'
        }
      ]),
      options: {
        editable: true
      }
    }
  }
})

Visjs documentation

Full reference of Item and Group formats, options properties and events: Timeline, Network, Graph2d, DataSet / DataView

List of currently implemented modules

  • Timeline
  • Graph2d
  • Graph3d
  • Network

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ npm run test

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Build Setup

# Once you have cloned this repo, install dependencies
$ npm install

# build for development and production with minification
$ npm run build

Run demo locally

# Run demo at localhost:8080
$ npm link
$ cd examples
$ npm install
$ npm link vue-visjs
# serve with hot reload at localhost:8080
$ npm run serve

Go to http://localhost:8080/ to see running examples

NOTE: If you make changes to the library you should run 'npm run build' again in the root folder. The dev server should detect modification and reload the demo

Security

If you discover any security related issues, please email public.sjmallon@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.