Horizontal Bullet Chart

Installation

Use the package manager NPM to install Horizontal Bullet Chart.

npm install @impetusuxp/vizualy-horizontal-bullet-chart

Sample Data (Chart's required data format)

const data = [
    {
        "sales": 52,
        "marketing": 110,
        "hr": 250,
        "salesperson": "A salesperson"
    },
    {
        "sales": 600,
        "marketing": 1200,
        "salesperson": "B salesperson"
    },
    {
        "sales": 850,
        "marketing": 300,
        "salesperson": "C salesperson"
    },
    {
        "sales": 3052,
        "marketing": 2300,
        "salesperson": "D salesperson"
    },
    {
        "sales": 55,
        "marketing": 200,
        "salesperson": "E salesperson"
    },
    {
        "sales": 100,
        "marketing": 242,
        "salesperson": "F salesperson"
    },
    {
        "sales": 12,
        "marketing": 140,
        "salesperson": "G salesperson"
    }
];

Usage

1.

import HorizontalBulletChart from '@impetusuxp/vizualy-horizontal-bullet-chart';

const horizontalBulletChart = new HorizontalBulletChart();

// Draw chart
horizontalBulletChart
      .container('containerID')
      .x('x axis key in data') // Referred as "sales, hr, marketing" in sample data
      .y('y axis key in data') // Referred as "salesperson" in sample data
      .data(data object) // Referred to sample data
      .settings(chart configuration object)
      .draw();

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

<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-horizontal-bullet-chart/vizualy-horizontal-bullet-chart.js"></script>
<script>
const horizontalBulletChart = new vizualy.HorizontalBulletChart();

// Draw chart
horizontalBulletChart
      .container('containerID')
      .x('x axis key in data') // Referred as "sales, hr, marketing" in sample data
      .y('y axis key in data') // Referred as "salesperson" in sample data
      .data(data object) // Referred to sample data
      .settings(chart configuration object)
      .draw();

// Update chart
horizontalBulletChart.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

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

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

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

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

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

barLabel: {
        isVisible: true,
        labelFormat: (d) => d
}

barSpace : {
    type: 'perc',
    value: 0.1 
},

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

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

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

legend: {
          isVisible: true,
          placement: 'right',
          margin: { top: 10, right: 10, bottom: 10, left: 10 },
          rectWidth: 10,
          rectHeight: 10,
          textKey: null,
          textFormat: (d) => d,
}

showLabel: {
        isVisible: false,
        key: "",
        format: (d) => {}
}

xScaleType: {
        type: "time"
    }

yScaleType: {
        type: "linear"
    }

xAxisTicksCount: {
    isApplied: false,
    value: ''
}

xWordWrap: {
    isVisible: false,
    linesToAddEllipses: 1
},

yWordWrap: {
    isVisible: false,
    linesToAddEllipses: 1
},

rotateYAxisTick: {
    isVisible: false,
    value: [-10, 10, 10]
}

rotateXAxisTick: {
    isVisible: false,
    value: [-10, 10, 10]
}

isResponsive: true

emptyDataMessage: 'No Data Available'

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

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

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

Contriubutor

Impetus Technologies

License

MIT