Create beautiful charts with one line of JavaScript
Supports Chart.js, Google Charts, and Highcharts
Also available for React, Vue.js, Ruby, Python, Elixir, and Clojure
Run
npm install chartkick chart.jsAnd add
import Chartkick from "chartkick"
import Chart from "chart.js"
Chartkick.use(Chart)This sets up Chartkick with Chart.js. For other charting libraries, see detailed instructions.
Create a div for the chart
<div id="chart-1" style="height: 300px;"></div>Line chart
new Chartkick.LineChart("chart-1", {"2017-01-01": 11, "2017-01-02": 6})Pie chart
new Chartkick.PieChart("chart-1", [["Blueberry", 44], ["Strawberry", 23]])Column chart
new Chartkick.ColumnChart("chart-1", [["Sun", 32], ["Mon", 46], ["Tue", 28]])Bar chart
new Chartkick.BarChart("chart-1", [["Work", 32], ["Play", 1492]])Area chart
new Chartkick.AreaChart("chart-1", {"2017-01-01": 11, "2017-01-02": 6})Scatter chart
new Chartkick.ScatterChart("chart-1", [[174.0, 80.0], [176.5, 82.3], [180.3, 73.6]])Geo chart - Google Charts
new Chartkick.GeoChart("chart-1", [["United States", 44], ["Germany", 23], ["Brazil", 22]])Timeline - Google Charts
new Chartkick.Timeline("chart-1", [["Washington", "1789-04-29", "1797-03-03"], ["Adams", "1797-03-03", "1801-03-03"]])Multiple series
data = [
{name: "Workout", data: {"2017-01-01": 3, "2017-01-02": 4}},
{name: "Call parents", data: {"2017-01-01": 5, "2017-01-02": 3}}
]
new Chartkick.LineChart("chart-1", data)Multiple series stacked and grouped - Chart.js 2.5+ or Highcharts
data = [
{name: "Apple", data: {"Tuesday": 3, "Friday": 4}, stack: "fruit"},
{name: "Pear", data: {"Tuesday": 1, "Friday": 8}, stack: "fruit"},
{name: "Carrot", data: {"Tuesday": 3, "Friday": 4}, stack: "vegetable"},
{name: "Beet", data: {"Tuesday": 1, "Friday": 8}, stack: "vegetable"}
]
new Chartkick.BarChart("chart-1", data, {stacked: true})Make your pages load super fast and stop worrying about timeouts. Give each chart its own endpoint.
new Chartkick.LineChart("chart-1", "/stocks")Min and max for y-axis
new Chartkick.LineChart("chart-1", data, {min: 1000, max: 5000})min defaults to 0 for charts with non-negative values. Use null to let the charting library decide.
Min and max for x-axis - Chart.js
new Chartkick.LineChart("chart-1", data, {xmin: "2018-01-01", xmax: "2019-01-01"})Colors
new Chartkick.LineChart("chart-1", data, {colors: ["#b00", "#666"]})Stacked columns or bars
new Chartkick.ColumnChart("chart-1", data, {stacked: true})You can also set
stackedtopercentorrelativefor Google Charts andpercentfor Highcharts
Discrete axis
new Chartkick.LineChart("chart-1", data, {discrete: true})Label (for single series)
new Chartkick.LineChart("chart-1", data, {label: "Value"})Axis titles
new Chartkick.LineChart("chart-1", data, {xtitle: "Time", ytitle: "Population"})Straight lines between points instead of a curve
new Chartkick.LineChart("chart-1", data, {curve: false})Hide points
new Chartkick.LineChart("chart-1", data, {points: false})Show or hide legend
new Chartkick.LineChart("chart-1", data, {legend: true})Specify legend position
new Chartkick.LineChart("chart-1", data, {legend: "bottom"})Donut chart
new Chartkick.PieChart("chart-1", data, {donut: true})Prefix, useful for currency - Chart.js, Highcharts
new Chartkick.LineChart("chart-1", data, {prefix: "$"})Suffix, useful for percentages - Chart.js, Highcharts
new Chartkick.LineChart("chart-1", data, {suffix: "%"})Set a thousands separator - Chart.js, Highcharts
new Chartkick.LineChart("chart-1", data, {thousands: ","})Set a decimal separator - Chart.js, Highcharts
new Chartkick.LineChart("chart-1", data, {decimal: ","})Set significant digits - Chart.js, Highcharts
new Chartkick.LineChart("chart-1", data, {precision: 3})Set rounding - Chart.js, Highcharts
new Chartkick.LineChart("chart-1", data, {round: 2})Show insignificant zeros, useful for currency - Chart.js, Highcharts
new Chartkick.LineChart("chart-1", data, {round: 2, zeros: true})Friendly byte sizes - Chart.js 2.8+
new Chartkick.LineChart("chart-1", data, {bytes: true})Show a message when data is empty
new Chartkick.LineChart("chart-1", data, {messages: {empty: "No data"}})Refresh data from a remote source every n seconds
new Chartkick.LineChart("chart-1", url, {refresh: 60})You can pass options directly to the charting library with:
new Chartkick.LineChart("chart-1", data, {library: {backgroundColor: "pink"}})See the documentation for Chart.js, Google Charts, and Highcharts for more info.
To customize datasets in Chart.js, use:
new Chartkick.LineChart("chart-1", data, {dataset: {borderWidth: 10}})You can pass this option to individual series as well.
To set options for all of your charts, use:
Chartkick.options = {
colors: ["#b00", "#666"]
}Pass data as an array or object
new Chartkick.PieChart("chart-1", {"Blueberry": 44, "Strawberry": 23})
new Chartkick.PieChart("chart-1", [["Blueberry", 44], ["Strawberry", 23]])Times can be a Date or a string (strings are parsed)
new Chartkick.LineChart("chart-1", [[new Date(), 5], ["2017-01-01 00:00:00 UTC", 7]])Data can also be a callback
function fetchData(success, fail) {
success({"Blueberry": 44, "Strawberry": 23})
// or fail("Data not available")
}
new Chartkick.LineChart("chart-1", fetchData)You can pass a few options with a series:
namedatacolordataset- Chart.js onlypoints- Chart.js onlycurve- Chart.js only
If you want to use the charting library directly, get the code with:
new Chartkick.LineChart("chart-1", data, {code: true})The code will be logged to the JavaScript console.
Note: 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.
new Chartkick.LineChart("chart-1", data, {download: true})Set the filename
new Chartkick.LineChart("chart-1", data, {download: {filename: "boom"}})Note: Safari will open the image in a new window instead of downloading.
Set the background color
new Chartkick.LineChart("chart-1", data, {download: {background: "#fff"}})Run
npm install chartkick chart.jsAnd add
import Chartkick from "chartkick"
import Chart from "chart.js"
Chartkick.use(Chart)Run
npm install chartkickAnd add
import Chartkick from "chartkick"And include on the page
<script src="https://www.gstatic.com/charts/loader.js"></script>To specify a language or Google Maps API key, use:
Chartkick.configure({language: "de", mapsApiKey: "..."})before your charts.
Run
npm install chartkick highchartsAnd add
import Chartkick from "chartkick"
import Highcharts from "highcharts"
Chartkick.use(Highcharts)Download chartkick.js directly.
For Chart.js (works with 2.1+), download the bundle and use:
<script src="/path/to/Chart.bundle.js"></script>
<script src="chartkick.js"></script>For Google Charts, use:
<script src="https://www.gstatic.com/charts/loader.js"></script>
<script src="chartkick.js"></script>For Highcharts (works with 2.1+), download it and use:
<script src="/path/to/highcharts.js"></script>
<script src="chartkick.js"></script>If more than one charting library is loaded, choose between them with:
new Chartkick.LineChart("chart-1", data, {adapter: "google"}) // or highcharts or chartjsAccess 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()Loop over charts with:
Chartkick.eachChart( function(chart) {
// do something
})Note: This feature is experimental.
Add your own custom adapter with:
var CustomAdapter = {
name: "custom",
renderLineChart: function (chart) {
chart.getElement().innerHTML = "Hi";
}
};
Chartkick.adapters.unshift(CustomAdapter);To run the files in the examples directory, you’ll need a web server. Run:
npm install -g serve
serveand visit http://localhost:5000/examples/
Breaking changes
- Removed
xtypeoption - numeric axes are automatically detected - Removed
window.Chartkick = {...}way to set config - useChartkick.configureinstead - Removed support for the Google Charts jsapi loader - use loader.js instead
Breaking changes
- Chart.js is now the default adapter if multiple are loaded - yay open source!
- Axis types are automatically detected - no need for
discrete: true - Better date support - dates are no longer treated as UTC
Chartkick uses iso8601.js to parse dates and times.
View the changelog
Chartkick.js follows Semantic Versioning
Everyone is encouraged to help improve this project. Here are a few ways you can help:
- Report bugs
- Fix bugs and submit pull requests
- Write, clarify, or fix documentation
- Suggest or add new features
See the Contributing Guide for more info.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent