gensen / highcharts-rails

Simple gem to include Highcharts in a Rails 3.1 (or above) app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Highcharts-Rails

This gem just includes Highcharts as an asset in the Rails 3.1 (or newer) asset pipeline. Highcharts is not free for commercial use, so make sure you have a valid license to use Highcharts.

Installation

Add the gem to the Gemfile

gem "highcharts-rails", "~> 2.3.0"
# The gem version mirrors the included version of Highcharts

Changes

We have a tiny changelog for this gem, but since it's just a tiny wrapper gem, refer to the Highcharts changelog for the important things.

Usage

In your JavaScript manifest (e.g. application.js)

//= require highcharts
//= require highcharts/highcharts-more # to get the new features in 2.3.0

To include one of the other adapters

//= require highcharts/adapters/mootools
//= require highcharts/adapters/prototype

Or the modules

//= require highcharts/modules/canvas-tools
//= require highcharts/modules/data
//= require highcharts/modules/exporting

Or one of the themes

//= require highcharts/themes/dark-blue
//= require highcharts/themes/dark-green
//= require highcharts/themes/gray
//= require highcharts/themes/grid
//= require highcharts/themes/skies

Other than that, refer to the Highcharts documentation

Licensing

Highcharts, which makes up the majority of this gem, has its own, separate licensing.

The gem itself is released under the MIT license

About

Simple gem to include Highcharts in a Rails 3.1 (or above) app

License:MIT License


Languages

Language:Ruby 100.0%