A web library for data visualization and exploration
Version 0.3.2
##External Dependencies The following tools need to be installed separately (e.g., with Homebrew) before Iris and its dependencies can be installed:
##Overview Iris is a browser-side library for data visualization widgets written in JavaScript. In addition to a set of widgets, it also includes an API for extending them or building new ones.
The Iris module is equipped with several directives:
-
Ensure Iris dependencies are installed:
make init -
Run the Iris unit-test suite:
make test -
To run Iris:
node app
The JavaScript libraries are managed in separate module files using RequireJS, but they can be packaged into a single library that can be dropped into any page. To build that library, run
make dist
Which will, by default, create a minified library as 'dist/iris.js'. To specify a different output file for the library, use the DISTLIB=/path/to/target.js.
The client-side library can be used on the browser as in the following example:
<!DOCTYPE html>
<head>
<link rel="stylesheet" href="iris.css" type="text/css">
<script src="iris.js" type="text/javascript"></script>
<script>
iris.require(['charts/bar'], function (Chart) {
var chart = new Chart({
element: "body",
// other options
});
chart.setData([ /* Data here */ ]);
chart.render();
});
</script>
</head>
<body>
</body>##Coding Style and Conventions TODO