Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A data-driven visualization toolkit

branch: master
README.md

Unveil.js

Unveil is a data exploration and visualization toolkit that utilizes data-driven software design.

Documentation is under construction but already available.

Features:

  • Data Abstractions
    • Collection (for simple collections of similar data items)
    • DataGraph (for linked data)
  • Scene API
    • SceneGraph implementation
    • Declarative syntax
    • Custom Actors (graphical objects)
    • Dynamic Actor Properties (you can assign functions instead of values)
    • Motion Tweening
    • Commands (e.g. save cpu cycles using event-based framerate determination)
    • Multiple Displays (the scene can be projected to one or more canvas elements)
    • Adjustable drawing order through Graph Traversers Choose from DepthFirst or BreadthFirst or implement your own Traverser
    • Mouse interaction support on Display level (picking, zooming, paning)

Getting started

Probably the easiest way to get started with Unveil.js is to install the Dejavis sandbox, and let it generate an example visualization, which you can use as a starting point.

Examples

New declarative Syntax

I took some inspiration from Scene.js's Scene Definition Format to give the whole thing an even more declarative feel.

Actors as well as the whole Scene can now be specified declaratively using a simple Specification Syntax.

var scene = new uv.Scene({
  actors: [
    {
      id: 'moving_rect',
      type: "rect",
      x: 50,
      y: 70,
      width: 200,
      height: 150,
      actors: [
        {
          type: "label",
          text: "I'm moving"
        }
      ]
    },
    {
      id: 'animated_circle',
      type: "circle",
      x: 50,
      y: 70,
      radius: 50,
      height: 150
    }
  ]
});

After you you've set up your Scene, you need to specify at least one display:

var display = scene.display({
  container: 'canvas',
  width: 500,
  height: 320,
  zooming: true,
  paning: true
});

You can attach actors to displays as well. Those objects are typically unaffected by view transformations, so they stick on their original display position. Display objects are meant as an overlay to be drawn after the scene objects.

display.add({
  {
    type: 'label',
    text: function() { return 'Frames per second: '+ this.scene.fps }
    x: 300,
    y: 20
  }
});

Since all actors have a unique id you can reference them programmatically and add special behavior (e.g. animation).

scene.get('moving_rect').bind('mouseover', function() {
  this.animate('x', 100, 2000, 'bounceEaseInOut');
  this.animate('y', 200, 2000);
});

scene.get('moving_rect').bind('click', function() {
  this.animate('rotation', Math.PI/2, 2000);
});

scene.get('animated_circle').bind('click', function() {
  this.animate('radius', 70, 2000);
});

Supported Browsers

  • Google Chrome 5+
  • Safari 4+
  • Firefox 3.5+
  • Internet Explorer 9+
  • Opera 10+

Roadmap

Unveil.js 0.1

  • Display actors (actors that stick on on a display rather than on the scene)
  • Add an API to get the top most active actor in case there is more than one object under the cursor.
  • API Docs

Unveil.js Stars

There should be a dedicated place for commonly used custom actors (stars). I could imagine putting them in a Github repo, ready for reuse, contributions, etc. Eventually, an online index for finding the right star for a certain job would also be nice.

Something went wrong with that request. Please try again.