Skip to content

VizArtJS/vizart-basic

Repository files navigation

vizart-basic

Usage:

  1. Install
npm install vizart-basic --save
  1. ES6 Usage
import 'vizart-basic/dist/vizart-basic.css';
import { bar } from 'vizart-basic';

const chart = bar(_domId, options)....

Three steps to use a chart

  1. initialize a chart with domId and declarative options
const opt = {
  ...
};
const chart = chord('#chart', opt)

You only need to provide essential options. Demo is a good place to check essential options for all charts. You may check up Documentation of each component for full option spec so as to control more chart behaviours.

  1. Render a chart with data
chart.render(data) // this should be called only once
  1. Change a chart on the fly (with options in a minimum)
// copy and update full options
const opt = chart.options();
opt.plots.opacityArea = o.4

// or in minimum
const opt = { plots: {opacityArea: 0.2 }};

// update options and redraw chart
chart.options(opt);
chart.update();

Development

  1. Clone repository
  2. Run commands
npm install         // install dependencies
npm run dev         // view demos in web browser at localhost:3005
npm run build       // build
npm run test        // run tests only
npm run test:cover  // run tests and view coverage report

API

Credits

My work is based on or inspired by other people's works

License

This project is licensed under the MIT License - see the LICENSE file for details