Contents

• Installation
• Usage
• Contribute
• License

Installation

Via NPM

Install via npm:

$ npm install clairview-charts

and include in your project:

import { Chart } from "clairview-charts"

Or include following for es-modules(eg:vuejs):

import { Chart } from 'clairview-charts/dist/clairview-charts.esm.js'
// import css
import 'clairview-charts/dist/clairview-charts.min.css'

or include within your HTML

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/clairview-charts.min.umd.js"></script>
<!-- or -->
<script src="https://unpkg.com/[email protected]/dist/clairview-charts.min.umd.js"></script>

Usage

const data = {
    labels: ["12am-3am", "3am-6pm", "6am-9am", "9am-12am",
        "12pm-3pm", "3pm-6pm", "6pm-9pm", "9am-12am"
    ],
    datasets: [
        {
            name: "Some Data", chartType: "bar",
            values: [25, 40, 30, 35, 8, 52, 17, -4]
        },
        {
            name: "Another Set", chartType: "line",
            values: [25, 50, -10, 15, 18, 32, 27, 14]
        }
    ]
}

const chart = new clairview.Chart("#chart", {  // or a DOM element,
                                            // new Chart() in case of ES6 module with above usage
    title: "My Awesome Chart",
    data: data,
    type: 'axis-mixed', // or 'bar', 'line', 'scatter', 'pie', 'percentage'
    height: 250,
    colors: ['#7cd6fd', '#743ee2']
})

Or for es-modules (replace new clairview.Chart() with new Chart()):

- const chart = new clairview.Chart("#chart", {
+ const chart = new Chart("#chart", {  // or a DOM element,
                                    // new Chart() in case of ES6 module with above usage
    title: "My Awesome Chart",
    data: data,
    type: 'axis-mixed', // or 'bar', 'line', 'scatter', 'pie', 'percentage'
    height: 250,
    colors: ['#7cd6fd', '#743ee2']
})

If you want to contribute:

1. Clone this repo.
2. cd into project directory
3. npm install
4. npm i npm-run-all -D (optional --> might be required for some developers)
5. npm run dev