├── .gitignore ├── CHANGELOG.md ├── LICENSE ├── README.md ├── doc └── intro.md ├── project.clj ├── src └── chartkick │ └── core.clj └── test └── chartkick └── core_test.clj /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | pom.xml 5 | pom.xml.asc 6 | *.jar 7 | *.class 8 | /.lein-* 9 | /.nrepl-port 10 | .hgignore 11 | .hg/ 12 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 0.1.0 - 2017-06-10 2 | - Support all charts with options. 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC 2 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM 3 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 4 | 5 | 1. DEFINITIONS 6 | 7 | "Contribution" means: 8 | 9 | a) in the case of the initial Contributor, the initial code and 10 | documentation distributed under this Agreement, and 11 | 12 | b) in the case of each subsequent Contributor: 13 | 14 | i) changes to the Program, and 15 | 16 | ii) additions to the Program; 17 | 18 | where such changes and/or additions to the Program originate from and are 19 | distributed by that particular Contributor. A Contribution 'originates' from 20 | a Contributor if it was added to the Program by such Contributor itself or 21 | anyone acting on such Contributor's behalf. Contributions do not include 22 | additions to the Program which: (i) are separate modules of software 23 | distributed in conjunction with the Program under their own license 24 | agreement, and (ii) are not derivative works of the Program. 25 | 26 | "Contributor" means any person or entity that distributes the Program. 27 | 28 | "Licensed Patents" mean patent claims licensable by a Contributor which are 29 | necessarily infringed by the use or sale of its Contribution alone or when 30 | combined with the Program. 31 | 32 | "Program" means the Contributions distributed in accordance with this 33 | Agreement. 34 | 35 | "Recipient" means anyone who receives the Program under this Agreement, 36 | including all Contributors. 37 | 38 | 2. GRANT OF RIGHTS 39 | 40 | a) Subject to the terms of this Agreement, each Contributor hereby grants 41 | Recipient a non-exclusive, worldwide, royalty-free copyright license to 42 | reproduce, prepare derivative works of, publicly display, publicly perform, 43 | distribute and sublicense the Contribution of such Contributor, if any, and 44 | such derivative works, in source code and object code form. 45 | 46 | b) Subject to the terms of this Agreement, each Contributor hereby grants 47 | Recipient a non-exclusive, worldwide, royalty-free patent license under 48 | Licensed Patents to make, use, sell, offer to sell, import and otherwise 49 | transfer the Contribution of such Contributor, if any, in source code and 50 | object code form. This patent license shall apply to the combination of the 51 | Contribution and the Program if, at the time the Contribution is added by the 52 | Contributor, such addition of the Contribution causes such combination to be 53 | covered by the Licensed Patents. The patent license shall not apply to any 54 | other combinations which include the Contribution. No hardware per se is 55 | licensed hereunder. 56 | 57 | c) Recipient understands that although each Contributor grants the licenses 58 | to its Contributions set forth herein, no assurances are provided by any 59 | Contributor that the Program does not infringe the patent or other 60 | intellectual property rights of any other entity. Each Contributor disclaims 61 | any liability to Recipient for claims brought by any other entity based on 62 | infringement of intellectual property rights or otherwise. As a condition to 63 | exercising the rights and licenses granted hereunder, each Recipient hereby 64 | assumes sole responsibility to secure any other intellectual property rights 65 | needed, if any. For example, if a third party patent license is required to 66 | allow Recipient to distribute the Program, it is Recipient's responsibility 67 | to acquire that license before distributing the Program. 68 | 69 | d) Each Contributor represents that to its knowledge it has sufficient 70 | copyright rights in its Contribution, if any, to grant the copyright license 71 | set forth in this Agreement. 72 | 73 | 3. REQUIREMENTS 74 | 75 | A Contributor may choose to distribute the Program in object code form under 76 | its own license agreement, provided that: 77 | 78 | a) it complies with the terms and conditions of this Agreement; and 79 | 80 | b) its license agreement: 81 | 82 | i) effectively disclaims on behalf of all Contributors all warranties and 83 | conditions, express and implied, including warranties or conditions of title 84 | and non-infringement, and implied warranties or conditions of merchantability 85 | and fitness for a particular purpose; 86 | 87 | ii) effectively excludes on behalf of all Contributors all liability for 88 | damages, including direct, indirect, special, incidental and consequential 89 | damages, such as lost profits; 90 | 91 | iii) states that any provisions which differ from this Agreement are offered 92 | by that Contributor alone and not by any other party; and 93 | 94 | iv) states that source code for the Program is available from such 95 | Contributor, and informs licensees how to obtain it in a reasonable manner on 96 | or through a medium customarily used for software exchange. 97 | 98 | When the Program is made available in source code form: 99 | 100 | a) it must be made available under this Agreement; and 101 | 102 | b) a copy of this Agreement must be included with each copy of the Program. 103 | 104 | Contributors may not remove or alter any copyright notices contained within 105 | the Program. 106 | 107 | Each Contributor must identify itself as the originator of its Contribution, 108 | if any, in a manner that reasonably allows subsequent Recipients to identify 109 | the originator of the Contribution. 110 | 111 | 4. COMMERCIAL DISTRIBUTION 112 | 113 | Commercial distributors of software may accept certain responsibilities with 114 | respect to end users, business partners and the like. While this license is 115 | intended to facilitate the commercial use of the Program, the Contributor who 116 | includes the Program in a commercial product offering should do so in a 117 | manner which does not create potential liability for other Contributors. 118 | Therefore, if a Contributor includes the Program in a commercial product 119 | offering, such Contributor ("Commercial Contributor") hereby agrees to defend 120 | and indemnify every other Contributor ("Indemnified Contributor") against any 121 | losses, damages and costs (collectively "Losses") arising from claims, 122 | lawsuits and other legal actions brought by a third party against the 123 | Indemnified Contributor to the extent caused by the acts or omissions of such 124 | Commercial Contributor in connection with its distribution of the Program in 125 | a commercial product offering. The obligations in this section do not apply 126 | to any claims or Losses relating to any actual or alleged intellectual 127 | property infringement. In order to qualify, an Indemnified Contributor must: 128 | a) promptly notify the Commercial Contributor in writing of such claim, and 129 | b) allow the Commercial Contributor tocontrol, and cooperate with the 130 | Commercial Contributor in, the defense and any related settlement 131 | negotiations. The Indemnified Contributor may participate in any such claim 132 | at its own expense. 133 | 134 | For example, a Contributor might include the Program in a commercial product 135 | offering, Product X. That Contributor is then a Commercial Contributor. If 136 | that Commercial Contributor then makes performance claims, or offers 137 | warranties related to Product X, those performance claims and warranties are 138 | such Commercial Contributor's responsibility alone. Under this section, the 139 | Commercial Contributor would have to defend claims against the other 140 | Contributors related to those performance claims and warranties, and if a 141 | court requires any other Contributor to pay any damages as a result, the 142 | Commercial Contributor must pay those damages. 143 | 144 | 5. NO WARRANTY 145 | 146 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON 147 | AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER 148 | EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR 149 | CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A 150 | PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the 151 | appropriateness of using and distributing the Program and assumes all risks 152 | associated with its exercise of rights under this Agreement , including but 153 | not limited to the risks and costs of program errors, compliance with 154 | applicable laws, damage to or loss of data, programs or equipment, and 155 | unavailability or interruption of operations. 156 | 157 | 6. DISCLAIMER OF LIABILITY 158 | 159 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY 160 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, 161 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION 162 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 163 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 164 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 165 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY 166 | OF SUCH DAMAGES. 167 | 168 | 7. GENERAL 169 | 170 | If any provision of this Agreement is invalid or unenforceable under 171 | applicable law, it shall not affect the validity or enforceability of the 172 | remainder of the terms of this Agreement, and without further action by the 173 | parties hereto, such provision shall be reformed to the minimum extent 174 | necessary to make such provision valid and enforceable. 175 | 176 | If Recipient institutes patent litigation against any entity (including a 177 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself 178 | (excluding combinations of the Program with other software or hardware) 179 | infringes such Recipient's patent(s), then such Recipient's rights granted 180 | under Section 2(b) shall terminate as of the date such litigation is filed. 181 | 182 | All Recipient's rights under this Agreement shall terminate if it fails to 183 | comply with any of the material terms or conditions of this Agreement and 184 | does not cure such failure in a reasonable period of time after becoming 185 | aware of such noncompliance. If all Recipient's rights under this Agreement 186 | terminate, Recipient agrees to cease use and distribution of the Program as 187 | soon as reasonably practicable. However, Recipient's obligations under this 188 | Agreement and any licenses granted by Recipient relating to the Program shall 189 | continue and survive. 190 | 191 | Everyone is permitted to copy and distribute copies of this Agreement, but in 192 | order to avoid inconsistency the Agreement is copyrighted and may only be 193 | modified in the following manner. The Agreement Steward reserves the right to 194 | publish new versions (including revisions) of this Agreement from time to 195 | time. No one other than the Agreement Steward has the right to modify this 196 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The 197 | Eclipse Foundation may assign the responsibility to serve as the Agreement 198 | Steward to a suitable separate entity. Each new version of the Agreement will 199 | be given a distinguishing version number. The Program (including 200 | Contributions) may always be distributed subject to the version of the 201 | Agreement under which it was received. In addition, after a new version of 202 | the Agreement is published, Contributor may elect to distribute the Program 203 | (including its Contributions) under the new version. Except as expressly 204 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or 205 | licenses to the intellectual property of any Contributor under this 206 | Agreement, whether expressly, by implication, estoppel or otherwise. All 207 | rights in the Program not expressly granted under this Agreement are 208 | reserved. 209 | 210 | This Agreement is governed by the laws of the State of New York and the 211 | intellectual property laws of the United States of America. No party to this 212 | Agreement will bring a legal action under this Agreement more than one year 213 | after the cause of action arose. Each party waives its rights to a jury trial 214 | in any resulting litigation. 215 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Chartkick 2 | 3 | ![Chartkick example](https://user-images.githubusercontent.com/3775525/26999689-645cdad8-4dd2-11e7-9cfa-cc971633c454.png) 4 | 5 | Create beautiful Javascript charts with one line of Clojure. No more fighting with charting libraries! 6 | 7 | [See it in action](http://chartkick.com/). 8 | 9 | Any feedback, suggestions, comments or PRs are welcome. 10 | 11 | ## Charts 12 | 13 | ```clojure 14 | (require '[chartkick.core :as chartkick]) 15 | 16 | (def data [[175 60] [190 80] [180 75]]) 17 | 18 | ``` 19 | 20 | Line chart 21 | 22 | ```clojure 23 | (chartkick/line-chart data) 24 | ``` 25 | 26 | Pie chart 27 | 28 | ```clojure 29 | (chartkick/pie-chart data) 30 | ``` 31 | 32 | Column chart 33 | 34 | ```clojure 35 | (chartkick/column-chart data) 36 | ``` 37 | 38 | Bar chart 39 | 40 | ```clojure 41 | (chartkick/bar-chart data) 42 | ``` 43 | 44 | Area chart 45 | 46 | ```clojure 47 | (chartkick/area-chart data) 48 | ``` 49 | 50 | Scatter chart 51 | 52 | ```clojure 53 | (chartkick/scatter-chart data) 54 | ``` 55 | 56 | Geo chart 57 | 58 | ```clojure 59 | (chartkick/geo-chart [["United States" 44] ["Germany"] 23]) 60 | ``` 61 | 62 | Timeline 63 | 64 | ```clojure 65 | (chartkick/timeline [["Washington" "1789-04-29" "1797-03-03"] 66 | ["Adams" "1797-03-03" "1801-03-03"] 67 | ["Jefferson" "1801-03-03" "1809-03-03"]]) 68 | ``` 69 | 70 | ### Options 71 | 72 | Id and height 73 | 74 | ```clojure 75 | (chartkick/line-chart data {:id "the-chart-id" :height "500px"}) 76 | ``` 77 | 78 | Min and max values 79 | 80 | ```clojure 81 | (chartkick/line-chart data {:min 1000 :max 5000}) 82 | 83 | ``` 84 | 85 | `min` defaults to 0 for charts with non-negative values. Use `nil` to let the charting library decide. 86 | 87 | Colors 88 | 89 | ```clojure 90 | (chartkick/line-chart data {:colors ["pink" "#999"]}) 91 | ``` 92 | 93 | Stacked columns or bars 94 | 95 | ```clojure 96 | (chartkick/column-chart data {:stacked true}) 97 | ``` 98 | 99 | Discrete axis 100 | 101 | ```clojure 102 | (chartkick/line-chart data {:discrete true}) 103 | ``` 104 | 105 | Axis titles 106 | 107 | ```clojure 108 | (chartkick/line-chart data {:xtitle "Time" :ytitle "Population"}) 109 | ``` 110 | 111 | The current implementation does unfortunately not allow you to pass options directly to the charting library yet.. PRs are welcome! 112 | 113 | See the documentation for [Google Charts](https://developers.google.com/chart/interactive/docs/gallery) and [Highcharts](http://api.highcharts.com/highcharts) for more info. 114 | 115 | ### Data 116 | 117 | Pass data as a Map or Array 118 | 119 | ```clojure 120 | (chartkick/pie-chart {:Football 10 :Basketball 5}) 121 | (chartkick/pie-chart [["Football" 10] ["Basketball" 5]]) 122 | ``` 123 | 124 | For multiple series, use the format 125 | 126 | ```clojure 127 | (chartkick/line-chart 128 | [{:name "Series A" :data [["Football" 10] ["Basketball" 5]] } 129 | {:name "Series B", :data [["Baseball" 2] ["Pingpong" 3]]}]) 130 | ``` 131 | 132 | Times can be a time, a timestamp, or a string (strings are parsed) 133 | 134 | ```clojure 135 | (chartkick/line-chart 136 | {1368174456 4, 137 | "2013-05-07 00:00:00 UTC" 7 138 | (new java.util.Date) 10}) 139 | ``` 140 | 141 | ## Installation 142 | 143 | Add the following to your project :deps list: 144 | 145 | ```clojure 146 | [chartkick "0.1.0"] 147 | ``` 148 | 149 | By default when you render a chart it will return both the HTML-element and JS that initializes the chart. 150 | This will only work if you load Chartkick in the `` tag. 151 | You can chose to render the JS & HTML separately using the `only: :html` or `only: :script` option. 152 | Note that if you use those options you need to pass `id` otherwise it wont work. 153 | 154 | ```clojure 155 | (chartkick/line-chart [] {:id "my-line-chart" :only :html}) 156 | (chartkick/line-chart [] {:id "my-line-chart" :only :script}) 157 | ``` 158 | 159 | For Google Charts, use: 160 | 161 | ```html 162 | 163 | 164 | ``` 165 | 166 | If you prefer Highcharts, download highcharts.js and use: 167 | 168 | ```html 169 | 170 | 171 | ``` 172 | 173 | ### Localization 174 | 175 | To specify a language for Google Charts, add: 176 | 177 | ```html 178 | 181 | ``` 182 | 183 | after the JavaScript files and before your charts. 184 | 185 | 186 | ## JavaScript API 187 | 188 | Access a chart with: 189 | 190 | ```javascript 191 | var chart = Chartkick.charts["chart-id"]; 192 | ``` 193 | 194 | Get the underlying chart object with: 195 | 196 | ```javascript 197 | chart.getChartObject(); 198 | ``` 199 | 200 | You can also use: 201 | 202 | ```javascript 203 | chart.getElement(); 204 | chart.getData(); 205 | chart.getOptions(); 206 | ``` 207 | 208 | ## No Clojure? No Problem 209 | 210 | Check out 211 | 212 | * JS [chartkick.js](https://github.com/ankane/chartkick.js) 213 | * Ruby [chartkick](https://github.com/ankane/chartkick) 214 | * Python [chartkick.py](https://github.com/mher/chartkick.py) 215 | 216 | ## History 217 | 218 | View the [changelog](https://github.com/yfractal/chartkick/blob/master/CHANGELOG.md) 219 | 220 | Chartkick follows [Semantic Versioning](http://semver.org/) 221 | 222 | ## Contributing 223 | 224 | Everyone is encouraged to help improve this project. Here are a few ways you can help: 225 | 226 | - [Report bugs](https://github.com/yfractal/chartkick/issues) 227 | - Fix bugs and [submit pull requests](https://github.com/yfractal/chartkick/pulls) 228 | - Write, clarify, or fix documentation 229 | - Suggest or add new features 230 | -------------------------------------------------------------------------------- /doc/intro.md: -------------------------------------------------------------------------------- 1 | # Introduction to chartkick 2 | 3 | TODO: write [great documentation](http://jacobian.org/writing/what-to-write/) 4 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject chartkick "0.1.0" 2 | :description "Create beautiful JavaScript charts with one line of Clojure" 3 | :url "http://example.com/FIXME" 4 | :license {:name "Eclipse Public License" 5 | :url "http://www.eclipse.org/legal/epl-v10.html"} 6 | :dependencies [[org.clojure/clojure "1.7.0"] 7 | [org.clojure/data.json "0.2.6"]]) 8 | -------------------------------------------------------------------------------- /src/chartkick/core.clj: -------------------------------------------------------------------------------- 1 | (ns chartkick.core 2 | (:require [clojure.data.json :as json])) 3 | 4 | (defn- chartkick-tag 5 | [id, height] 6 | (format "
Loading...
" 7 | id height height)) 8 | 9 | (defn- chartkick-script 10 | [class id data-source options-json] 11 | (format "" 12 | class, id, data-source, options-json)) 13 | 14 | (defn- generate-element-id 15 | [] 16 | (str (java.util.UUID/randomUUID))) 17 | 18 | (defn chartkick-chart 19 | ([class data-source] 20 | (chartkick-chart class data-source {})) 21 | ([class data-source options] 22 | (let [id (or (:id options) (generate-element-id)) 23 | height (or (:height options) "300px") 24 | only (:only options)] 25 | (str (if-not (= only :script) 26 | (chartkick-tag id, height)) 27 | (if-not (= only :html) 28 | (chartkick-script class, id, (json/write-str data-source), (json/write-str options))))))) 29 | 30 | (defn pie-chart 31 | [data-source & options] 32 | (apply chartkick-chart "PieChart" data-source options)) 33 | 34 | (defn column-chart 35 | [data-source & options] 36 | (apply chartkick-chart "ColumnChart" data-source options)) 37 | 38 | (defn bar-chart 39 | [data-source & options] 40 | (apply chartkick-chart "BarChart" data-source options)) 41 | 42 | (defn area-chart 43 | [data-source & options] 44 | (apply chartkick-chart "AreaChart" data-source options)) 45 | 46 | (defn combo-chart 47 | [data-source & options] 48 | (apply chartkick-chart "ComboChart" data-source options)) 49 | 50 | (defn geo-chart 51 | [data-source & options] 52 | (apply chartkick-chart "GeoChart" data-source options)) 53 | 54 | (defn scatter-chart 55 | [data-source & options] 56 | (apply chartkick-chart "ScatterChart" data-source options)) 57 | 58 | (defn timeline 59 | [data-source & options] 60 | (apply chartkick-chart "Timeline" data-source options)) 61 | 62 | (defn line-chart 63 | [data-source & options] 64 | (apply chartkick-chart "LineChart" data-source options)) 65 | -------------------------------------------------------------------------------- /test/chartkick/core_test.clj: -------------------------------------------------------------------------------- 1 | (ns chartkick.core-test 2 | (:require [clojure.test :refer :all] 3 | [chartkick.core :refer :all])) 4 | 5 | (deftest test-generate-right-script-function 6 | (doseq [[script expected] 7 | [[(pie-chart []) "new Chartkick.PieChart("] 8 | [(column-chart []) "new Chartkick.ColumnChart("] 9 | [(bar-chart []) "new Chartkick.BarChart("] 10 | [(area-chart []) "new Chartkick.AreaChart("] 11 | [(combo-chart []) "new Chartkick.ComboChart("] 12 | [(geo-chart []) "new Chartkick.GeoChart("] 13 | [(scatter-chart []) "new Chartkick.ScatterChart("] 14 | [(timeline []) "new Chartkick.Timeline("] 15 | [(line-chart []) "new Chartkick.LineChart("]]] 16 | (is (.contains script expected)))) 17 | 18 | (deftest test-html 19 | (testing "it contains HTML-tag styling" 20 | (let [height "42px" 21 | script (chartkick-chart "" "{}" {:height height}) 22 | expected "style=\"height: 42px; text-align: center; color: #999; line-height: 42px;"] 23 | (is (.contains script expected)))) 24 | (testing "it set default height" 25 | (let [script (chartkick-chart "" {}) 26 | expected "height: 300px"] 27 | (is (.contains script expected)))) 28 | (testing "it set height" 29 | (let [height "400px" 30 | script (chartkick-chart "" {} {:height height}) 31 | expected "height: 400px"] 32 | (is (.contains script expected)))) 33 | (testing "it can render script only" 34 | (let [script (chartkick-chart "" {} {:only true})] 35 | (is (not (.contains script "
"))))) 36 | (testing "it can custom id" 37 | (let [script (chartkick-chart "chart" {} {:id "the-chart-id"}) 38 | expected "new Chartkick.chart('the-chart-id"] 39 | (is (.contains script expected)))) 40 | (testing "it can set chart options" 41 | (let [script (chartkick-chart "chart" {} {:stacked true :min nil}) 42 | expected "{\"stacked\":true,\"min\":null}"] 43 | (is (.contains script expected))))) 44 | --------------------------------------------------------------------------------