Skip to content
This repository has been archived by the owner on Aug 6, 2020. It is now read-only.

AngularJS wrapper for billboard.js

License

Notifications You must be signed in to change notification settings

fintechstudios/billboard-ng

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Archival notice

This is no longer maintained!

billboard-ng

A (very light) AngularJS wrapper for billboard.js

Dependencies

billboard.js is a charting library built on top of D3. Both are required for this library.

As well, AngularJS >=1.5 is required.

Installation

$ npm install --save @fintechstudios/billboard-ng

Setup

For most setups, just require the module:

require('@fintechstudios/billboard-ng');

Or, if you're using ESM:

import bbNg from '@fintechstudios/billboard-ng'

You will also need to include the billboard.js CSS files.

Depending on your build stack, you may also need to manually include billboard.js, d3, and angular.

Usage

Include the billboard-ng module in your angular module definition:

angular.module('my-awesome-module', ['billboard-ng']);

Then use the billboard component in your templates

<billboard options="$ctrl.chartConfig"></billboard>

billboard-ng accepts all options that the billboard.js API accepts. bindto will be automatically passed the <billboard> element from your template.