|
| 1 | +# Visualization Framework |
| 2 | +_[Demo/Test Page](http://rawgit.com/hpcc-systems/Visualization/master/demos/test.html)_ and its [source](https://github.com/hpcc-systems/Visualization/blob/master/demos/test.html) |
| 3 | + |
| 4 | +The goal of the visualization framework is to simplify the construction of visualizations and dashboards for Big Data on the HPCC Platform. This project consists of the following key parts: |
| 5 | + |
| 6 | +1. Provides a consistent interface to "off the shelf" and hand crafted visualizations. |
| 7 | +2. Simplifies visualization instantiation and composition within HTML DOM and SVG DOM nodes (One visualization can be a combination of several others). |
| 8 | +3. Provide connectors (marshallers) to the HPCC Platform. |
| 9 | + |
| 10 | +### The obligatory Hello World example |
| 11 | +```html |
| 12 | +<!doctype html> |
| 13 | +<html> |
| 14 | +<head> |
| 15 | + <meta charset="utf-8"> |
| 16 | + <script src="../widgets/lib/requirejs/require.js"></script> |
| 17 | + <script src="../widgets/config.js"></script> |
| 18 | + <script> |
| 19 | + requirejs.config({ |
| 20 | + baseUrl: "../widgets" |
| 21 | + }); |
| 22 | + </script> |
| 23 | +</head> |
| 24 | +<body> |
| 25 | + <div id="helloWorld" style="width:100%; height:100vh"> |
| 26 | + </div> |
| 27 | + <script> |
| 28 | + require(["src/common/TextBox"], function (TextBox) { |
| 29 | + var helloWorld = new TextBox() |
| 30 | + .target("helloWorld") |
| 31 | + .text("Hello\nWorld!") |
| 32 | + .render() |
| 33 | + ; |
| 34 | + }); |
| 35 | + </script> |
| 36 | +</body> |
| 37 | +</html> |
| 38 | +``` |
| 39 | +And how it [looks](http://rawgit.com/hpcc-systems/Visualization/master/demos/HelloWorld.html). |
| 40 | + |
| 41 | +###Standing on the back of giants |
| 42 | +None of this would would be possible without the great work of others. The widgets/lib folder includes the work from: |
| 43 | +* [requirejs](http://requirejs.org/) |
| 44 | +* [D3](http://d3js.org/) |
| 45 | +* [Topojson](https://github.com/mbostock/topojson) |
| 46 | +* [dagre](https://github.com/cpettitt/dagre) |
| 47 | +* [Font-Awesome](http://fortawesome.github.io/Font-Awesome/) |
| 48 | +* [ColorBrewer](http://colorbrewer2.org/) |
| 49 | +* [C3](http://c3js.org/) |
| 50 | +* [d3-cloud](https://github.com/jasondavies/d3-cloud) |
| 51 | + |
| 52 | +While widgets/src also includes wrappers for CDN hosted visualizations: |
| 53 | +* [Google Maps](https://developers.google.com/maps/) |
| 54 | +* [Google Charts](https://developers.google.com/chart/) |
| 55 | + |
| 56 | + |
0 commit comments