[![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]

[![download][badge-download]][link-download] [![download][badge-download-weekly]][link-download] [![jsDelivr][badge-jsDelivr]][link-jsDelivr] [![jsDelivr][badge-jsDelivr-weekly]][link-jsDelivr]

![CI Status][badge-ci-status] [![Coverage Status][badge-coverage]][link-coverage] [![Known Vulnerabilities][badge-snyk]][link-snyk] [![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.

> - 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, check out 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)

$3

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

$3

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

$3

> ⚠️ Packaged version is not an official distribution.
> It's to provide an easy way to load 'billboard.js' with dependencies.

- 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

$3

> [!NOTE]
> If you want to apply themes, simply load one of the theme css files 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

#### dark
- https://naver.github.io/billboard.js/release/latest/dist/theme/dark.css
- https://naver.github.io/billboard.js/release/latest/dist/theme/dark.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

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

$3

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

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

> [!NOTE]
> The version info will be given as the build datetime: x.x.x-nightly-yyyymmddhhmmss

There are two ways to install from the nightly branch directly.
``js // Specify on 'package.json' file "dependencies": { ... "billboard.js": "naver/billboard.js#nightly" },`

`sh

`Run install command from shell`


$ npm install git+https://github.com/naver/billboard.js.git#nightly --save


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

`sh

`Run install command from shell`


$ npm install billboard.js@next --save

$3

`bash $ npm install billboard.js`

`$3`

`$3`

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/

`Supported Browsers`

> [!IMPORTANT] > - Basically will work on all SVG and ES6+ supported browsers. > - ^*Notes for legacy browsers: > - Recommended to use thepackaged build or construct your own build following How to bundle for legacy browsers?instructions. > - D3.js has dropped support for legacy browsers since v6. > - Support isn't fully guaranteed.

`Dependency by version`

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

`Getting Started`

Load billboard.js after D3.js.

`html

or by importing ESM. > [!TIP] > 📌 Also check: How to load as ESM directly from the browser?

`js // 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 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, check out the migration guide. > - If you have an issue bundling for legacy browsers, check out "How to bundle for legacy browsers?".

`Basic usage example`

#### 1) Create chart holder element`html

#### 2) Generate a chart with options`js // 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( ... );`

`License`


billboard.js is released under the MIT license.

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.``

[badge-download]: https://img.shields.io/npm/dm/billboard.js.svg?style=flat
[badge-download-weekly]: https://img.shields.io/npm/dw/billboard.js
[badge-jsDelivr]: https://data.jsdelivr.com/v1/package/npm/billboard.js/badge?style=rounded
[badge-jsDelivr-weekly]: https://img.shields.io/jsdelivr/npm/hw/billboard.js
[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?branch=master&v1
[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?branch=master
[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](https://app.fossa.io/projects/git%2Bgithub.com%2Fnaver%2Fbillboard.js?ref=badge_large)

Documents

Questions?

If you have any questions, check out 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)

$3

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

$3

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

$3

> ⚠️ Packaged version is not an official distribution.
> It's to provide an easy way to load 'billboard.js' with dependencies.

$3

> [!NOTE]
> If you want to apply themes, simply load one of the theme css files 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

#### dark
- https://naver.github.io/billboard.js/release/latest/dist/theme/dark.css
- https://naver.github.io/billboard.js/release/latest/dist/theme/dark.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

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

$3

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

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

> [!NOTE]
> The version info will be given as the build datetime: x.x.x-nightly-yyyymmddhhmmss

There are two ways to install from the nightly branch directly.
``js // Specify on 'package.json' file "dependencies": { ... "billboard.js": "naver/billboard.js#nightly" },`

`sh

`Run install command from shell`


$ npm install git+https://github.com/naver/billboard.js.git#nightly --save


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

`sh

`Run install command from shell`


$ npm install billboard.js@next --save

$3

`bash $ npm install billboard.js`

`$3`

`$3`

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/

`Supported Browsers`

`Dependency by version`

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

`Getting Started`

Load billboard.js after D3.js.

`html

or by importing ESM. > [!TIP] > 📌 Also check: How to load as ESM directly from the browser?

// 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 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, check out the migration guide. > - If you have an issue bundling for legacy browsers, check out "How to bundle for legacy browsers?".

`Basic usage example`

#### 1) Create chart holder element`html

// call some API chart.load( ... );`

`License`


billboard.js is released under the MIT license.

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

![FOSSA Status](https://app.fossa.io/projects/git%2Bgithub.com%2Fnaver%2Fbillboard.js?ref=badge_large)

billboard.js

Documents

Questions?

Supported chart types

Download and Installation

$3

$3

$3

$3

$3

Run install command from shell

$3

Run install command from shell

$3

$3

$3

Supported Browsers

Dependency by version

Getting Started

Basic usage example

License

billboard.js

Documents

Questions?

Supported chart types

Download and Installation

$3

$3

$3

$3

$3

Run install command from shell

$3

Run install command from shell

$3

$3

$3

Supported Browsers

Dependency by version

Getting Started

Basic usage example

License

Dist Tags

`Run install command from shell`

`Run install command from shell`

`$3`

`$3`

`Supported Browsers`

`Dependency by version`

`Getting Started`

`Basic usage example`

`License`

`Run install command from shell`

`Run install command from shell`

`$3`

`$3`

`Supported Browsers`

`Dependency by version`

`Getting Started`

`Basic usage example`

`License`