Area Chart

Installation

Use the package manager NPM to install Area Chart.

npm install @impetusuxp/vizualy-area-chart

Sample Data (Chart's required data format)

const data = [
    { key: 'area-1', "date": new Date("2017-04-23 00:00:00"), "count": 10.78 },
    { key: 'area-1', "date": new Date("2017-04-24 00:00:00"), "count": 56.54 },
    { key: 'area-1', "date": new Date("2017-04-25 00:00:00"), "count": 23.85 },
    { key: 'area-1', "date": new Date("2017-04-26 00:00:00"), "count": 80 },
    { key: 'area-1', "date": new Date("2017-04-23 00:00:00"), "count": -15.78 },
    { key: 'area-1', "date": new Date("2017-04-24 00:00:00"), "count": 40.54 },
    { key: 'area-1', "date": new Date("2017-04-25 00:00:00"), "count": -23.85 },
    { key: 'area-1', "date": new Date("2017-04-26 00:00:00"), "count": 60 }
];

Usage

1.

import AreaChart from '@impetusuxp/vizualy-area-chart';

const areaChart = new AreaChart();

// Draw chart
areaChart
      .container('containerID')
      .x('x axis key in data') // Referred as "date" key in sample Data
      .y('y axis key in data') // Referred as "count" key in sample Data
      .area(key) // Referred as "key" key in sample Data
      .data(data object) // Referred to sample data
      .settings(chart configuration object)
      .draw();

// Update chart
areachart.data(updated data object).update();

2.

<script type="text/javascript" src="./libs/d3.v6.min.js"></script>
<script type="text/javascript" src="./vizualy-assistant/src/js/utility.js"></script>
<script type="text/javascript" src="./vizualy-assistant/src/js/assistant.js"></script>
<script type="text/javascript" src="./vizualy-assistant/src/js/observer.js"></script>
<script type="text/javascript" src="./vizualy-area-chart/vizualy-area-chart.js"></script>
<script>
const areachart = new vizualy.AreaChart();

// Draw chart
areaChart
      .container('containerID')
      .x('x axis key in data') // Referred as "date" key in sample Data
      .y('y axis key in data') // Referred as "count" key in sample Data
      .area(key) // Referred as "key" key in sample Data
      .data(data object) // Referred to sample data
      .settings(chart configuration object)
      .draw();

// Update chart
areaChart.data(updated data object).update();
</script>

Make sure to use/import vizualy-assistant/src/css/common.css in your code-base as per recommended by frontend framework being used

Configurations/Settings

1)

dimension: {
    width: 500,
    height: 500,
    margin: { top: 20, right: 20, bottom: 40, left: 40 }
}

2)

xAxis: {
    isVisible: true,
    isGridsVisible: true,
    tickFormat: (d) => d
}

3)

yAxis: {
    isVisible: true,
    isGridsVisible: true,
    tickFormat: (d) => d
}

4)

xAxisLabel: {
    value: '',
    margin: 40,
    isVisible: true
}

5)

yAxisLabel: {
    value: '',
    margin: 50,
    isVisible: true
}

6)

rotateXAxisTick: {
    value: [0, 0, 0],
    isVisible: false
}

7)

tooltip: {
    isVisible: true,
    content: (d, chartObject) => "Some html",
    placement: "top-right"
}

8)

animation: {
    isApplied: true,
    duration: 750,
    type: 'cubic'
}

9)

xScaleType: {
        type: "time"
    }

10)

yScaleType: {
        type: "linear"
    }

11)

yAxisTicksCount: {
    value: 3, 
    isApplied: false
},

12)

brush: {
        isVisible: false,
        limit: 30,
        offset: 0,
        height: 80,
        margin: 60
}

13)

xWordWrap: {
        isVisible: false,
        linesToAddEllipses: 1
}

14)

isResponsive: true

15)

colors: []

16)

emptyDataMessage: 'No Data Available'

17)

exceptionMessage: 'Something went wrong!! Please see logs.'

Chart's life cycle hooks:-

chartObject.on('beforeDraw', () => { // do something })
chartObject.on('completeDraw', () => { // do something })
chartObject.on('beforeUpdate', () => { // do something })
chartObject.on('completeUpdate, () => { // do something })
chartObject.on('beforeResize', () => { // do something })
chartObject.on('completeResize', () => { // do something })

Event subscription

areachart.getElement("area").on('mouseMove', [(d, element, event) => { }], removePreviousHandlers: boolean);

We can attaché multiple handlers(Array of functions) on events(mouseMove) to exposed element(area). We have below events to subscribe -> mouseMove, mouseEnter, mouseOut, mouseOver, click

Contriubutor

Impetus Technologies

License

MIT