billboard.js

Re-usable, easy interface JavaScript chart library based on D3.js

ChartingD3SVG
naver/billboard.jsnaver.github.io/billboard.js/billboard.js

README

billboard.js
 [![Latest Version][badge-latest]][link-version] [![Next version][badge-next]][link-version] [![bb][badge-@billboard.js/react]][link-@billboard.js/react]
[![semantic-release][badge-semantic-release]][link-semantic-release] ![React][badge-react]

![CI Status][badge-ci-status] [![Coverage Status][badge-coverage]][link-coverage] [![Known Vulnerabilities][badge-snyk]][link-snyk]  [![download][badge-download]][link-download] [![jsDelivr][badge-jsDelivr]][link-jsDelivr] [![gzip size][badge-gzip-size]][link-gzip-size]

billboard.js is a re-usable, easy interface JavaScript chart library, based on D3.js.

The name "billboard" comes from the famous billboard chart which everybody knows.<br>

- Why we decided to start billboard.js?


Documents

- API Documentation
- Examples
- Roadmap
- Contribution Guide
- Development Guide
- Comparison table with other libraries
- Migration guide from C3.js
- Third Party Applications
- Who's using billboard.js
- Benchmark
- Technicals:
  - How to bundle for legacy browsers?
  - How to generate chart image in Node.js environment?
  - find out more at Wiki page.
- v2 updates:
  - v2 CHANGELOG
  - Migration Guide to v2
- v3 updates:
  - billboard.js 3.0 release: D3.js v6 support & new candlestick type!

Questions?

If you have any questions, checkout the previous posts or create a new one at:
- Stack Overflow: billboard.js tagged posts
- Issue with 'question' label

Supported chart types


Download and Installation


Download dist files from the repo directly or install it via npm.

Dist file list from the repo. (click to expand)

For development (Uncompressed)


You can download the uncompressed files for development

Latest

  - https://naver.github.io/billboard.js/release/latest/dist/billboard.js
  - https://naver.github.io/billboard.js/release/latest/dist/billboard.css

Specific version

  - https://naver.github.io/billboard.js/release/[VERSION]/dist/billboard.js
  - https://naver.github.io/billboard.js/release/[VERSION]/dist/billboard.css

For production (Compressed)


You can download the compressed files for production

Latest

  - https://naver.github.io/billboard.js/release/latest/dist/billboard.min.js
  - https://naver.github.io/billboard.js/release/latest/dist/billboard.min.css

Specific version

  - https://naver.github.io/billboard.js/release/[VERSION]/dist/billboard.min.js
  - https://naver.github.io/billboard.js/release/[VERSION]/dist/billboard.min.css

Packaged version (with D3.js inclusion)

Packaged version is not an official distribution.

It's to provide an easy way to load 'billboard.js' with dependency.


- Latest
    - https://naver.github.io/billboard.js/release/latest/dist/billboard.pkgd.js
    - https://naver.github.io/billboard.js/release/latest/dist/billboard.pkgd.min.js
- Specific version
    - https://naver.github.io/billboard.js/release/[VERSION]/dist/billboard.pkgd.js
    - https://naver.github.io/billboard.js/release/[VERSION]/dist/billboard.pkgd.min.js


Themes

If you want apply themes, simply load one of the theme css file provided instead of the default css file.

- Screenshot Preview



Dist theme file list from the repo. (click to expand)

datalab

- https://naver.github.io/billboard.js/release/latest/dist/theme/datalab.css
- https://naver.github.io/billboard.js/release/latest/dist/theme/datalab.min.css


insight

- https://naver.github.io/billboard.js/release/latest/dist/theme/insight.css
- https://naver.github.io/billboard.js/release/latest/dist/theme/insight.min.css

graph

- https://naver.github.io/billboard.js/release/latest/dist/theme/graph.css
- https://naver.github.io/billboard.js/release/latest/dist/theme/graph.min.css


Nightly version


Nightly version is the latest build from the master branch.
With nightly, you can try upcoming changes prior the official release.

- https://github.com/naver/billboard.js/tree/nightly/dist

The version info will be given as the build datetime: x.x.x-nightly-yyyymmddhhmmss


There're two ways to install from nightly branch directly.
  1. ``` js
  2. // Specify on 'package.json' file
  3. "dependencies": {
  4.       ...
  5.       "billboard.js": "naver/billboard.js#nightly"
  6. },
  7. ```

  1. ```sh
  2. # Run install command from shell
  3. $ npm install git+https://github.com/naver/billboard.js.git#nightly --save
  4. ```

Next(Release Canditate) version


Next version is the 'release candidate' build, prior the latest official release.

  1. ```sh
  2. # Run install command from shell
  3. $ npm install billboard.js@next --save
  4. ```

Installation with npm


  1. ``` sh
  2. $ npm install billboard.js
  3. ```

Packages


Name | For | Description
:---: | :---:| :---: [![bb][badge-@billboard.js/react]][link-@billboard.js/react] | ![React][badge-react] | React component for billboard.js

Using CDN


If you want to use 'billboard.js' without installation, load files directly from one of the CDN providers.

- cdnjs: https://cdnjs.com/libraries/billboard.js
- jsDelivr: https://cdn.jsdelivr.net/npm/billboard.js/dist/
- PageCDN: https://pagecdn.com/lib/billboardjs
- unpkg: https://unpkg.com/billboard.js/dist/

Supported Browsers


- Basically will work on all SVG supported browsers.

- <sup>*</sup>Notes for legacy browsers:

- Recommended to use packaged build or construct your own build following [How to bundle for legacy browsers?](https://github.com/naver/billboard.js/wiki/How-to-bundle-for-legacy-browsers%3F) instruction.

- D3.js dropped the support of legacy browsers since v6.

- The support isn't fully guaranteed.


|Internet|Chrome|Firefox|Safari|iOS|Android|
|---|---|---|---|---|---|
|9+*|Latest|Latest|Latest|8+|4+|


Dependency by version


D3.js (required)| billboard.js
:---: | :---:
4.x 5.x | 1.x 2.x
6.x+ | 3.x+

Load billboard.js after D3.js.

  1. ``` html
  3.     
  4.     <script src="https://d3js.org/d3.v6.min.js"></script>
  5. <link rel="stylesheet" href="$YOUR_PATH/billboard.css">
  6.     <script src="$YOUR_PATH/billboard.js"></script>
  7. <link rel="stylesheet" href="$YOUR_PATH/billboard.css">
  8.     <script src="$YOUR_PATH/billboard.pkgd.js"></script>
  9. ```

or use importing ESM.

📌 Also check: How to load as ESM directly from the browser?


  1. ``` js
  2. // 1) import billboard.js
  3. // as named import with desired shapes and interaction modules
  4. // https://github.com/naver/billboard.js/wiki/CHANGELOG-v2#modularization-by-its-functionality
  5. import {bb, area, bar, zoom} from "billboard.js";

  7. // or as importing default
  8. import bb, {area, bar, zoom} from "billboard.js";

  10. // 2) import css if your dev-env supports. If don't, include them via
  11. import "billboard.js/dist/billboard.css";

  13. // or theme style. Find more themes from 'theme' folder
  14. import "billboard.js/dist/theme/insight.css"
  15. ```

Note

- For migration from C3.js, checkout the migration guide.

- If has an issue bundling for legacy browsers, checkout "How to bundle for legacy browsers?".


Basic usage example


1) Create chart holder element

  1. ``` html
  2. <div id="chart"></div>
  3. ```

2) Generate a chart with options

  1. ``` js
  2. // generate the chart
  3. var chart = bb.generate({
  4.     bindto: "#chart",
  5.     data: {
  6.       // for ESM import usage, import 'line' module and execute it as
  7.       // type: line(),
  8.       type: "line",
  9.       columns: [
  10.           ["data1", 30, 200, 100, 400, 150, 250]
  11.       ]
  12.     },
  13.     zoom: {
  14.       // for ESM import usage, import 'zoom' module and execute it as
  15.       // enabled: zoom()
  16.       enabled: true
  17.     }
  18. });

  20. // call some API
  21. chart.load( ... );
  22. ```

License

billboard.js is released under the MIT license.

  1. ```
  2. Copyright (c) 2017 ~ present NAVER Corp.

  4. Permission is hereby granted, free of charge, to any person obtaining a copy
  5. of this software and associated documentation files (the "Software"), to deal
  6. in the Software without restriction, including without limitation the rights
  7. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. copies of the Software, and to permit persons to whom the Software is
  9. furnished to do so, subject to the following conditions:

  11. The above copyright notice and this permission notice shall be included in
  12. all copies or substantial portions of the Software.

  14. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
  17. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. THE SOFTWARE.
  21. ```


[badge-download]: https://img.shields.io/npm/dm/billboard.js.svg?style=flat
[badge-jsDelivr]: https://data.jsdelivr.com/v1/package/npm/billboard.js/badge?style=rounded
[badge-ci-status]: https://github.com/naver/billboard.js/workflows/CI/badge.svg
[badge-coverage]: https://coveralls.io/repos/github/naver/billboard.js/badge.svg
[badge-snyk]: https://snyk.io/test/github/naver/billboard.js/badge.svg?targetFile=package.json
[badge-gzip-size]: https://img.badgesize.io/https://unpkg.com/billboard.js/dist/billboard.min.js?compression=gzip
[badge-latest]: https://img.shields.io/npm/v/billboard.js/latest.svg
[badge-next]: https://img.shields.io/npm/v/billboard.js/next.svg
[badge-semantic-release]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[badge-react]: https://img.shields.io/badge/React-20232A?style=flat&logo=react&logoColor=fff&labelColor=grey&color=62d9fb
[badge-@billboard.js/react]: https://img.shields.io/npm/v/@billboard.js/react?style=flat&labelColor=grey&label=%40billboard.js%2Freact


[link-download]: https://npm-stat.com/charts.html?package=billboard.js&from=2017-06-08
[link-jsDelivr]: https://www.jsdelivr.com/package/npm/billboard.js
[link-version]: https://www.npmjs.com/package/billboard.js
[link-coverage]: https://coveralls.io/github/naver/billboard.js
[link-snyk]: https://snyk.io/test/github/naver/billboard.js?targetFile=package.json
[link-gzip-size]: https://unpkg.com/billboard.js/dist/billboard.min.js
[link-semantic-release]: https://github.com/semantic-release/semantic-release
[link-@billboard.js/react]: https://www.npmjs.com/package/@billboard.js/react
FOSSA Status