billboard.js is a re-usable, easy interface JavaScript chart library, based on D3 v4+.
The name “billboard” comes from the famous billboard chart
which everybody knows.
Play with the diverse options generating on the fly!
If you have any questions, checkout the previous posts or create a new one at:
Download dist files from the repo directly or install it via npm.
You can download the uncompressed files for development
You can download the compressed files for production
Packaged version is not an official distribution. It’s to provide an easy way to load ‘billboard.js’ with dependency.
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:
x.x.x-nightly-yyyymmddhhmmss
There’re two ways to install from nightly
branch directly.
// Specify on 'package.json' file
"dependencies": {
...
"billboard.js": "git://github.com/naver/billboard.js.git#nightly"
},
# Run install command from shell
$ npm install git+https://github.com/naver/billboard.js.git#nightly --save
Next version is the ‘release candidate’ build, prior the latest official release.
# Run install command from shell
$ npm install billboard.js@next --save
$ npm install billboard.js
If you want to use ‘billboard.js’ without installation, load files directly from one of the CDN providers.
Basically will work on all SVG supported browsers.
Internet Explorer | Chrome | Firefox | Safari | iOS | Android |
---|---|---|---|---|---|
9+ | Latest | Latest | Latest | 8+ | 4+ |
D3 (required) |
---|
4+ |
Load billboard.js after D3.js.
<!-- 1) Load D3.js and billboard.js separately -->
<!-- Load D3 -->
<script src="https://d3js.org/d3.v5.min.js"></script>
<!-- Load billboard.js with base(or theme) style -->
<link rel="stylesheet" href="$YOUR_PATH/billboard.css">
<script src="$YOUR_PATH/billboard.js"></script>
<!-- 2) or Load billboard.js packaged with D3.js -->
<link rel="stylesheet" href="$YOUR_PATH/billboard.css">
<script src="$YOUR_PATH/billboard.pkgd.js"></script>
or use importing ESM.
// 1) import billboard.js
// as named import with desired shapes and interaction modules
// https://github.com/naver/billboard.js/wiki/CHANGELOG-v2#modularization-by-its-functionality
import {bb, area, bar, zoom} from "billboard.js";
// or as importing default
import bb, {area, bar, zoom} from "billboard.js";
// 2) import css if your dev-env supports. If don't, include them via <link>
import "billboard.js/dist/billboard.css";
// or theme style. Find more themes from 'theme' folder
import "billboard.js/dist/theme/insight.css"
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?”.
<div id="chart"></div>
// generate the chart
var chart = bb.generate({
bindto: "#chart",
data: {
// for ESM import usage, import 'line' module and execute it as
// type: line(),
type: "line",
columns: [
["data1", 30, 200, 100, 400, 150, 250]
]
},
zoom: {
// for ESM import usage, import 'zoom' module and execute it as
// enabled: zoom()
enabled: true
}
});
// call some API
chart.load( ... );
For anyone interested in developing billboard.js, follow the instructions below.
Required Node.js version:
10.10.0+
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
npm
and 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.
To maintain the same code style and quality, we adopted ESLint. The rules are based on the Airbnb JavaScript Style Guide with some modifications. Setup your editor for check or run the below command for linting.
$ 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
Running the npm test
command will start Mocha tests via Karma-runner.
If you find a bug, please report to us by posting issues on GitHub.
Author: naver
Demo: https://naver.github.io/billboard.js/
Source Code: https://github.com/naver/billboard.js
#javascript