Skip to content
📊 Re-usable, easy interface JavaScript chart library based on D3 v4+📈
JavaScript CSS Shell
Branch: master
Clone or download
michkami and netil feat(line): Intent to ship bubble/line/scatter zerobased
Implementation for bubble/line/scatter types zerobased option.

Fix #1149
Close #1150
Latest commit e45fb33 Dec 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github docs(gh-template): Remove 'preferred reviewers' clause Jul 18, 2017
config chore(build): Fix the build for IE9 Aug 30, 2019
demo chore(demo): Update lazy render demo Dec 3, 2019
spec feat(line): Intent to ship bubble/line/scatter zerobased Dec 5, 2019
src feat(line): Intent to ship bubble/line/scatter zerobased Dec 5, 2019
types feat(line): Intent to ship bubble/line/scatter zerobased Dec 5, 2019
.editorconfig the birth Jun 8, 2017
.eslintrc feat(plugin): Add support for Stanford Diagrams Apr 29, 2019
.gitignore chore(release): Integrate semantic-release Jun 18, 2019
.releaserc.json chore(release): Update on release Jul 2, 2019
.travis.yml chore(release): Update on release Jul 2, 2019
AUTHORS.txt feat(line): Intent to ship bubble/line/scatter zerobased Dec 5, 2019
CHANGELOG.md skip: update version & changelog Nov 27, 2019
CODE_OF_CONDUCT.md skip: update contact info Aug 11, 2017
CONTRIBUTING.md chore(release): Update release branch workflow Jun 25, 2019
LICENSE refactor(all): Update on info Dec 13, 2018
README.md docs(readme): Add note for legacy browser build Dec 3, 2019
babel.config.js chore(dev-env): Update babel config Dec 4, 2019
jsdoc.json chore(release): Update release configuration Aug 7, 2019
karma.conf.js chore(dev-env): move css import to webpack config Jun 25, 2019
mocha.opts chore(CI): Modify travis config (#3) Jun 12, 2017
package.json chore(dev-env): Update dependency Dec 3, 2019
webpack.config.js chore(build): build optimization Oct 30, 2019
yarn.lock chore(dev-env): Update dependency Dec 3, 2019

README.md

billboard.js

Latest Version Next version semantic-release

Build Status Coverage Status download jsDelivr gzip size Greenkeeper

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.

Documents

Playground

Play with the diverse options generating on the fly!

Questions?

If you have any questions, checkout the previous posts or create a new one at:

Supported chart types

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

Latest

Specific version

For production (Compressed)

You can download the compressed files for production

Latest

Specific version

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.

Themes

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

insight

graph

Nightly version

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(Release Canditate) version

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

# Run install command from shell
$ npm install billboard.js@next --save

Installation with npm

$ npm install billboard.js

Using CDN

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

Supported Browsers

Basically will work on all SVG supported browsers.

Internet Explorer Chrome Firefox Safari iOS Android
9+ Latest Latest Latest 8+ 4+

Dependency

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
import {bb} from "billboard.js";

// or as importing default
import bb 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

Basic usage example

1) Create chart holder element

<div id="chart"></div>

2) Generate a chart with options

// generate the chart
var chart = bb.generate({
    bindto: "#chart",
    data: {
      type: "line",
        columns: [
            ["data1", 30, 200, 100, 400, 150, 250]
        ]
    }
});

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

How to start developing billboard.js?

For anyone interested in developing billboard.js, follow the instructions below.

Required Node.js version: 10.10.0+

Development Environment

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

npm and Yarn are supported.

# Install the dependency modules.
$ npm install

# or
$ yarn

3. Build

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.

Linting

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

Test

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.

Bug Report

If you find a bug, please report to us by posting issues on GitHub.

License

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.

FOSSA Status

You can’t perform that action at this time.