Add this line to your application’s Gemfile:
gem "chartkick"
Then follow the instructions for your JavaScript setup:
This sets up Chartkick with Chart.js. For other charting libraries and frameworks, see these instructions.
In config/importmap.rb
, add:
pin "chartkick", to: "chartkick.js"
pin "Chart.bundle", to: "Chart.bundle.js"
And in app/javascript/application.js
, add:
import "chartkick"
import "Chart.bundle"
Run:
bun add chartkick chart.js
# or
yarn add chartkick chart.js
And in app/javascript/application.js
, add:
import "chartkick/chart.js"
Note: For rollup.js, this requires format: "iife"
in rollup.config.js
.
In app/assets/javascripts/application.js
, add:
//= require chartkick
//= require Chart.bundle
Line chart
<%= line_chart User.group_by_day(:created_at).count %>
Pie chart
<%= pie_chart Yogurt.group(:flavor).count %>
Column chart
<%= column_chart Order.group_by_day_of_week(:created_at, format: "%a").count %>
Bar chart
<%= bar_chart Shirt.group(:size).sum(:price) %>
Area chart
<%= area_chart Visit.group_by_minute(:created_at).maximum(:load_time) %>
Scatter chart
<%= scatter_chart City.pluck(:size, :population), xtitle: "Size", ytitle: "Population" %>
Multiple series
<%= line_chart @goals.map { |goal|
{name: goal.name, data: goal.feats.group_by_week(:created_at).count}
} %>
or
<%= line_chart Feat.group(:goal_id).group_by_week(:created_at).count %>
Data can be a hash, array, or URL.
<%= line_chart({"2021-01-01" => 2, "2021-01-02" => 3}) %>
<%= line_chart [["2021-01-01", 2], ["2021-01-02", 3]] %>
Make your pages load super fast and stop worrying about timeouts. Give each chart its own endpoint.
<%= line_chart completed_tasks_charts_path %>
And in your controller, pass the data as JSON.
class ChartsController < ApplicationController
def completed_tasks
render json: Task.group_by_day(:completed_at).count
end
end
For multiple series, add chart_json
at the end.
render json: Task.group(:goal_id).group_by_day(:completed_at).count.chart_json
Id, width, and height
<%= line_chart data, id: "users-chart", width: "800px", height: "500px" %>
Min and max values
<%= line_chart data, min: 1000, max: 5000 %>
min
defaults to 0 for charts with non-negative values. Use nil
to let the charting library decide.
Min and max for x-axis - Chart.js
<%= line_chart data, xmin: "2021-01-01", xmax: "2022-01-01" %>
Colors
<%= line_chart data, colors: ["#b00", "#666"] %>
Stacked columns or bars
<%= column_chart data, stacked: true %>
Discrete axis
<%= line_chart data, discrete: true %>
Label (for single series)
<%= line_chart data, label: "Value" %>
Axis titles
<%= line_chart data, xtitle: "Time", ytitle: "Population" %>
Straight lines between points instead of a curve
<%= line_chart data, curve: false %>
Hide points
<%= line_chart data, points: false %>
Show or hide legend
<%= line_chart data, legend: false %>
Specify legend position
<%= line_chart data, legend: "bottom" %>
Donut chart
<%= pie_chart data, donut: true %>
Prefix, useful for currency - Chart.js, Highcharts
<%= line_chart data, prefix: "$" %>
Suffix, useful for percentages - Chart.js, Highcharts
<%= line_chart data, suffix: "%" %>
Set a thousands separator - Chart.js, Highcharts
<%= line_chart data, thousands: "," %>
Set a decimal separator - Chart.js, Highcharts
<%= line_chart data, decimal: "," %>
Set significant digits - Chart.js, Highcharts
<%= line_chart data, precision: 3 %>
Set rounding - Chart.js, Highcharts
<%= line_chart data, round: 2 %>
Show insignificant zeros, useful for currency - Chart.js, Highcharts
<%= line_chart data, round: 2, zeros: true %>
Friendly byte sizes - Chart.js
<%= line_chart data, bytes: true %>
Specify the message when data is loading
<%= line_chart data, loading: "Loading..." %>
Specify the message when data is empty
<%= line_chart data, empty: "No data" %>
Refresh data from a remote source every n
seconds
<%= line_chart url, refresh: 60 %>
You can pass options directly to the charting library with:
<%= line_chart data, library: {backgroundColor: "#eee"} %>
See the documentation for Chart.js, Google Charts, and Highcharts for more info.
To customize datasets in Chart.js, use:
<%= line_chart data, dataset: {borderWidth: 10} %>
You can pass this option to individual series as well.
To set options for all of your charts, create an initializer config/initializers/chartkick.rb
with:
Chartkick.options = {
height: "400px",
colors: ["#b00", "#666"]
}
Customize the html
Chartkick.options[:html] = '<div id="%{id}" style="height: %{height};">%{loading}</div>'
You capture the JavaScript in a content block with:
Chartkick.options[:content_for] = :charts_js
Then, in your layout, use:
<%= yield :charts_js %>
For Padrino, use yield_content
instead of yield
.
This is great for including all of your JavaScript at the bottom of the page.
You can pass a few options with a series:
name
data
color
dataset
- Chart.js onlypoints
- Chart.js onlycurve
- Chart.js onlyIf you want to use the charting library directly, get the code with:
<%= line_chart data, code: true %>
The code will be logged to the JavaScript console. JavaScript functions cannot be logged, so it may not be identical.
Chart.js only
Give users the ability to download charts. It all happens in the browser - no server-side code needed.
<%= line_chart data, download: true %>
Safari will open the image in a new window instead of downloading.
Set the filename
<%= line_chart data, download: {filename: "boom"} %>
Set the background color
<%= line_chart data, download: {background: "#ffffff"} %>
Set title
<%= line_chart data, title: "Awesome chart" %>
In your layout or views, add:
<%= javascript_include_tag "https://www.gstatic.com/charts/loader.js" %>
For Importmap (Rails 7+ default), in config/importmap.rb
, add:
pin "chartkick", to: "chartkick.js"
And in app/javascript/application.js
, add:
import "chartkick"
For Bun, esbuild, rollup.js, or Webpack, run:
bun add chartkick
# or
yarn add chartkick
And in app/javascript/packs/application.js
, add:
import "chartkick"
For Sprockets, in app/assets/javascripts/application.js
, add:
//= require chartkick
To specify a language or Google Maps API key, use:
Chartkick.configure({language: "de", mapsApiKey: "..."})
before your charts.
For Importmap (Rails 7+ default), run:
bin/importmap pin highcharts --download
And in config/importmap.rb
, add:
pin "chartkick", to: "chartkick.js"
And in app/javascript/application.js
, add:
import "chartkick"
import Highcharts from "highcharts"
window.Highcharts = Highcharts
For Bun, esbuild, rollup.js, or Webpack, run:
bun add chartkick highcharts
# or
yarn add chartkick highcharts
And in app/javascript/packs/application.js
, add:
import "chartkick/highcharts"
For Sprockets, download highcharts.js into vendor/assets/javascripts
(or use yarn add highcharts
), and in app/assets/javascripts/application.js
, add:
//= require chartkick
//= require highcharts
If more than one charting library is loaded, choose between them with:
<%= line_chart data, adapter: "google" %> <!-- or highcharts or chartjs -->
Download chartkick.js and include it manually.
<script src="chartkick.js"></script>
Then include the charting library.
Chart.js - download Chart.js and the date-fns adapter bundle
<script src="chart.js"></script>
<script src="chartjs-adapter-date-fns.bundle.js"></script>
Google Charts
<script src="https://www.gstatic.com/charts/loader.js"></script>
Highcharts - download highcharts.js
<script src="highcharts.js"></script>
Access a chart with:
var chart = Chartkick.charts["chart-id"]
Get the underlying chart object with:
chart.getChartObject()
You can also use:
chart.getElement()
chart.getData()
chart.getOptions()
chart.getAdapter()
Update the data with:
chart.updateData(newData)
You can also specify new options:
chart.setOptions(newOptions)
// or
chart.updateData(newData, newOptions)
Refresh the data from a remote source:
chart.refreshData()
Redraw the chart with:
chart.redraw()
Destroy the chart with:
chart.destroy()
Loop over charts with:
Chartkick.eachChart(function(chart) {
// do something
})
Check out how to configure CSP
View the changelog
Everyone is encouraged to help improve this project. Here are a few ways you can help:
To get started with development:
git clone https://github.com/ankane/chartkick.git
cd chartkick
bundle install
bundle exec rake test