Gem Version Dependency Status Build Status Code Climate

Rbplotly

Plot.ly API client and Interface to plotly.js.

Installation

Add this line to your application's Gemfile:

gem 'rbplotly'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rbplotly

Usage

require 'rbplotly'

x = [0, 1, 2, 3, 4]
trace0 = { x: x, y: [0, 2, 1, 4, 3], type: :scatter, mode: :lines }
trace1 = { x: x, y: [4, 1, 3, 0, 2], type: :scatter, mode: 'markers+lines' }
data = [trace0, trace1] # data must be Array

layout = { width: 500, height: 500 }

plot = Plotly::Plot.new(data: data, layout: layout)

plot.layout.height = 300 # You can change plot's attributes.

plot.generate_html(path: './line_chart.html')

Use #download_image if you want to get an image by using Plot.ly API. You can get your API KEY here.

Plotly.auth(<YOUR_USERNAME>, <YOUR_API_KEY>)
plot.download_image(path: './line_chart.png')

Or use #show on IRuby notebooks.

plot.show

Examples

Visit nbviewer.jupyter.org/github/y4ashida/rbplotly to see more examples.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/y4ashida/rbplotly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Thanks

rbplotly is based on plotly/plotly.py, so there are a lot of code coming from it.

License

Copyright (c) 2016 Yoshihiro Ashida. See LICENSE.txt for further details.