Ruby wrapper for Highcharts.js and Highstock.js charting libraries
The goal of this project is to wrap the Highcharts and Highstock APIs in Opal, providing a simple Ruby interface to Highcharts' functionality.
To find out more about Highcharts, check out these links:
- Highcharts: http://www.highcharts.com/products/highcharts
- Highcharts Demos: http://www.highcharts.com/demo
- Highstock Demos: http://www.highcharts.com/stock/demo
To find out more about Opal, go to http://opalrb.org
Installation
Install opal-highcharts from RubyGems:
$ gem install opal-highcharts
Or include it in your Gemfile for Bundler:
gem 'opal-highcharts'
Cloning this repository
$ git clone https://github.com/balmoral/opal-highcharts
Getting Started
Usage
opal-highcharts
can be added to your opal application sources using a standard require:
# app/application.rb
require 'opal'
require 'opal/highcharts'
You need to bring your own
highcharts.js
orhighstock.js
file. If you require Highstock functionality usehighstock.js
, which includes Highcharts. If you only require Highcharts functionality usehighcharts.js
. Download from http://code.highcharts.com/highcharts.js or http://code.highcharts.com/stock/highstock.js and put the file inapp/
or whichever directory you are compiling assets from.
To do
- Implement Highstock features
- Documentation
- Testing
Getting involved
To contribute to this project, follow the steps below.
- Fork the repo ( https://github.com/balmoral/opal-highcharts/fork )
- Create your feature branch (
git checkout -b new-branch
) - Commit your changes (
git commit -am 'description of commit'
) - Push to the branch (
git push origin new-branch
) - Create a Pull Request
Contributions welcome.
Licenses
Highcharts
Free for non-commercial use. See http://www.highcharts.com/ for details.
###opal-highcharts MIT Licence. See LICENSE.txt