README.md
IGS Pie Chart
=============
[](https://codeclimate.com/github/lucasmartins/igs_pie_chart)
[](http://travis-ci.org/lucasmartins/igs_pie_chart) [](https://gemnasium.com/lucasmartins/igs_pie_chart)
Pie Chart is a gem for pizza/donut (charts) making. It uses D3 (Data Driven Documents) to aggregate the data and render SVG awesomeness into an HTML element of your choosing.
Pie Chart is the first piece of the Innovative Graph Suite, different ways to visualize your data will be available in the near future.
Pie Chart is not production ready yet, although it works fine.
The RDoc is not available yet, but there are few files to peek and the [test](https://github.com/lucasmartins/igs_pie_chart/blob/master/test/test_igs_pie_chart.rb) shows how it works.
Requirements
------------
### Ruby and Rails
This gem is tested against the latest version of RoR, other versions are not our focus now.
Rails is not really needed, but apparently our main dependency 'd3_rails' requires you to install all Rails gems, we will work on that in the future.
### D3 (Data Driven Documents)
This gem uses the awesomeness of [D3](https://github.com/mbostock/d3), a great way to work with data, and data visualization too. So, remember you need the D3 js file available.
### SVG
The graphics generated to bring pies to life are based on SVG, all browsers should fully support SVG and its transitions but some do not, be aware of that.
Installation
------------
IGS Pie Chart is distributed as a gem, which is how it should be used in your app.
Include the gem in your Gemfile:
```ruby
gem "igs_pie_chart"
```
Or, if you want to get the bleeding edge, you can get master from the main repository:
```ruby
gem "igs_pie_chart", :git => "git://github.com/lucasmartins/igs_pie_chart.git"
```
Usage (Rails)
-------------------
Add D3 to your Rails javascript manifest (application.js):
```javascript
//= require d3
```
Make your pie (controller):
```ruby
@pie = Igs::PieChart.new('The Favorite Pizzas Chart',200,0.4,'body',{'Mussarela'=>25,'Brocolli'=>25,'Pepperoni'=>50})
```
Savor it raw (view):
```erb
<%= raw @pie.render %>
```
Done!
You can also render specific parts of the @pie, like in:
```ruby
<%= raw @pie.style #css %>
<%= raw @pie.script #javascript %>
<%= raw @pie.labels #ul+li %>
```
Breakdown
---------
```ruby
Igs::PieChart.new(size,endomargin=0,target_element='body',data)
size => "Integer, Your X and Y measures"
endomargin => "Float, from 0 to 1, represents the internal margin, 0 for Pizza Pie, 0.5 for a nice Donut."
target_element => "String, the target HTML element where the chart will be rendered."
data => "Hash with the labels and floats which represents each slice of the Pizza/Donut."
```
Contributors
-------
IGS Pie Chart was bootstrapped inside [Innovit LTDA](http://innovit.com.br)
Special thanks to [Andrik](https://github.com/andrik), for pushing the company to a more open perspective.
The names and logos for Innovit are trademarks of Innovit LTDA.
Contributing
------------
This gem is in a very early stage.
If you'd like to contribute a feature or bugfix: Thanks! To make sure your
fix/feature has a high chance of being included, please post a new [GitHub Issue](http://github.com/lucasmartins/igs_pie_chart/issues)
License
-------
IGS Pie Chart is free software under the [MIT license](http://lucasmartins.mit-license.org).