The name "billboard" comes from the famous
billboard chartwhich everybody knows.
This project was forked from C3.js v0.4.11.
- API Documentation
- Contribution Guide
- Comparison table with other libraries
- Migration guide from C3.js
- Third Party Applications
- Who's using billboard.js
Play with the diverse options generating on the fly!
- https://beta.observablehq.com/@idris-maps/billboard-js-playground (by @idris-maps)
If you have any questions, checkout the previous posts or create a new one at:
Supported chart types
Download and Installation
Download dist files from the repo directly or install it via npm.
For development (Uncompressed)
You can download the uncompressed files for development
For production (Compressed)
You can download the compressed files for production
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.
- Specific version
If you want apply themes, simply load one of the theme css file provided instead of the default css file.
Nightly version is the latest build from the master branch. With nightly, you can try upcoming changes prior the official release.
The version info will be given as the build datetime:
Installation with npm
$ npm install billboard.js
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/
- unpkg: https://unpkg.com/billboard.js/dist/
Basically will work on all SVG supported browsers.
Load billboard.js after D3.js.
<!-- 1) Load D3.js and billboard.js separately --><!-- Load D3 --><!-- Load billboard.js with base(or theme) style --><!-- 2) or Load billboard.js packaged with D3.js -->
or use importing ESM.
// 1) import billboard.js// as named import;// or as importing default;// 2) import css if your dev-env supports. If don't, include them via <link>;// or theme style. Find more themes from 'theme' folder
For migration from C3.js, checkout the migration guide
Basic usage example
1) Create chart holder element
2) Generate a chart with options
// generate the chartvar chart = bb;// call some APIchart;
How to start developing billboard.js?
For anyone interested in developing billboard.js, follow the instructions below.
1. Clone the repository
Clone the billboard.js repository and install the dependency modules.
# Create a folder and move.$ mkdir billboard.js && cd billboard.js# Clone the repository.$ git clone https://github.com/naver/billboard.js.git
2. Install dependencies
Yarn are supported.
# Install the dependency modules. $ npm install # or $ yarn
Use npm script to build billboard.js
# Run webpack-dev-server for development$ npm start# Build$ npm run build# Generate jsdoc$ npm run jsdoc
Two folders will be created after the build is completed.
- dist folder: Includes the billboard.js and billboard.min.js files.
- doc folder: Includes API documentation. The home page for the documentation is doc/index.html.
$ npm run lint
Once you created a branch and finished the development, you must perform a test with
npm test command before the push to a remote repository.
$ npm test
If you find a bug, please report to us by posting issues on GitHub.
billboard.js is released under the MIT license.
Copyright (c) 2017 ~ present NAVER Corp. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.