@@ -17,6 +17,6 @@ Rake::RDocTask.new(:rdoc) do |rdoc| rdoc.rdoc_dir = 'rdoc' rdoc.title = 'Html5jpGraphs' rdoc.options << '--line-numbers' << '--inline-source' - rdoc.rdoc_files.include('README') + rdoc.rdoc_files.include('README.rdoc') rdoc.rdoc_files.include('lib/**/*.rb') end Rakefile @@ -86,8 +86,10 @@ <h3 class="section-bar">Methods</h3> <div class="name-list"> - <a href="#M000001">pie_chart</a>   + <a href="#M000003">line_chart</a>   + <a href="#M000004">pie_chart</a>   <a href="#M000002">radar_chart</a>   + <a href="#M000001">vertical_bar_chart</a>   </div> </div> @@ -109,11 +111,121 @@ <div id="methods"> <h3 class="section-bar">Public Instance methods</h3> - <div id="method-M000001" class="method-detail"> - <a name="M000001"></a> + <div id="method-M000003" class="method-detail"> + <a name="M000003"></a> <div class="method-heading"> - <a href="#M000001" class="method-signature"> + <a href="#M000003" class="method-signature"> + line_chart(resource, options = {}, html_options = {}) + </a> + </div> + + <div class="method-description"> + +Draw a line chart using Html5jp radar chart (<a +href="http://www.html5.jp/library/graph_line.html">www.html5.jp/library/graph_line.html</a>). + + +ex. + +<pre> + <%= line_chart [['accesses', 520, 340, 804, 602], ['clicks', 101, 76, 239, 321]] %> +</pre> + +The first argument ‘resource’ can be one of the following +forms. + +<ul> +<li>[‘accesses’, 520, 340, 804, 602] + +</li> +<li>[[‘accesses’, 520, 340, 804, 602], [‘clicks’, 101, +76, 239, 321]] + +</li> +<li>Any other object which has required methods as follows; + +<ul> +<li>each - to supply record objects. + +</li> +<li>items - If :x option does not exist and your resource object has items +method, it is called to get :x. You can change the method name by +:items_method option. + +</li> +<li>scales - If :y option does not exist and your resource object has scales +method, it is called to get :y. You can change the method name by +:scales_method option + +</li> +<li>max_scale - Would be used as :yMax option if it exists. + +</li> +<li>min_scale - Would be used as :yMin option if it exists. + +</li> +<li>The record object shoud have methods as follows. + +<ul> +<li>label - Like ‘accesses’ in the example. You can use other +method if you specify :label_method option. + +</li> +<li>values - Like [520, 340, 804, 602] in the example. You can use other method +if you specify :values_method option. + +</li> +</ul> +</li> +</ul> +</li> +</ul> + +Additionaly, the following options are available. + +<ul> +<li>:canvas_id - element id of the canvas. Default is ‘<a +href="Html5jpGraphsHelper.html#M000003">line_chart</a>’. Note that +all rader charts in one page sould have unique canvas_ids. + +</li> +<li>:width - The width of the canvas. Default is 400. + +</li> +<li>:height - The height of the canvas. Default is 300. + +</li> +<li>All options in <a +href="http://www.html5.jp/library/graph_line.html">www.html5.jp/library/graph_line.html</a>. +ex. ‘yMax’ or :yMax. + +</li> +</ul> + +And you can use html_options for the top level div. + + <a class="source-toggle" href="#" + onclick="toggleCode('M000003-source');return false;">[Source]</a> + <div class="method-source-code" id="M000003-source"> +<pre> + # File lib/html5jp_graphs_helper.rb, line 86 +86: def line_chart(resource, options = {}, html_options = {}) +87: options = {:width => 400, :height => 300, :canvas_id => 'line_chart'}.merge(options.symbolize_keys) +88: output = canvas(options, html_options) +89: output << "\n" +90: output << line_chart_js(resource, options) +91: end +</pre> + </div> + </div> + </div> + + <div id="method-M000004" class="method-detail"> + <a name="M000004"></a> + + <div class="method-heading"> + <a href="#M000004" class="method-signature"> pie_chart(resource, options = {}, html_options = {}) </a> </div> @@ -168,9 +280,9 @@ you specify :color_method option. This is optional. Additionaly, the following options are available. <ul> -<li>:canvas_id - element id of the canvas. Default is -‘rader_chart’. Note that all rader charts in one page sould -have unique canvas_ids. +<li>:canvas_id - element id of the canvas. Default is ‘<a +href="Html5jpGraphsHelper.html#M000004">pie_chart</a>’. Note that all +rader charts in one page sould have unique canvas_ids. </li> <li>:width - The width of the canvas. Default is 400. @@ -192,16 +304,16 @@ ex. ‘startAngle’ or :startAngle. And you can use html_options for the top level div. <a class="source-toggle" href="#" - onclick="toggleCode('M000001-source');return false;">[Source]</a> - <div class="method-source-code" id="M000001-source"> + onclick="toggleCode('M000004-source');return false;">[Source]</a> + <div class="method-source-code" id="M000004-source"> <pre> - # File lib/html5jp_graphs_helper.rb, line 25 -25: def pie_chart(resource, options = {}, html_options = {}) -26: options = {:width => 400, :height => 300, :canvas_id => 'pie_chart'}.merge(options.symbolize_keys) -27: output = canvas(options, html_options) -28: output << "\n" -29: output << pie_chart_js(resource, options) -30: end + # File lib/html5jp_graphs_helper.rb, line 113 +113: def pie_chart(resource, options = {}, html_options = {}) +114: options = {:width => 400, :height => 300, :canvas_id => 'pie_chart', :sort => false}.merge(options.symbolize_keys) +115: output = canvas(options, html_options) +116: output << "\n" +117: output << pie_chart_js(resource, options) +118: end </pre> </div> </div> @@ -263,7 +375,7 @@ specify :values_method option. </li> <li>color - If :faceColors option does not exist and your record object has color method, it is used for :faceColors. You can change the method name by -:colors_method option. +:color_method option. </li> </ul> @@ -299,13 +411,125 @@ And you can use html_options for the top level div. onclick="toggleCode('M000002-source');return false;">[Source]</a> <div class="method-source-code" id="M000002-source"> <pre> - # File lib/html5jp_graphs_helper.rb, line 53 -53: def radar_chart(resource, options = {}, html_options = {}) -54: options = {:width => 400, :height => 300, :canvas_id => 'reader_chart'}.merge(options.symbolize_keys) -55: output = canvas(options, html_options) -56: output << "\n" -57: output << rader_chart_js(resource, options) -58: end + # File lib/html5jp_graphs_helper.rb, line 56 +56: def radar_chart(resource, options = {}, html_options = {}) +57: options = {:width => 400, :height => 300, :canvas_id => 'reader_chart'}.merge(options.symbolize_keys) +58: output = canvas(options, html_options) +59: output << "\n" +60: output << rader_chart_js(resource, options) +61: end +</pre> + </div> + </div> + </div> + + <div id="method-M000001" class="method-detail"> + <a name="M000001"></a> + + <div class="method-heading"> + <a href="#M000001" class="method-signature"> + vertical_bar_chart(resource, options = {}, html_options = {}) + </a> + </div> + + <div class="method-description"> + +Draw a vertical bar chart using Html5jp vertical bar chart (<a +href="http://www.html5.jp/library/graph_vbar.html">www.html5.jp/library/graph_vbar.html</a>). + + +ex. + +<pre> + <%= vertical_bar_chart [['accesses', 520, 340, 804, 602], ['clicks', 101, 76, 239, 321]] %> +</pre> + +The first argument ‘resource’ can be one of the following +forms. + +<ul> +<li>[‘accesses’, 520, 340, 804, 602] + +</li> +<li>[[‘accesses’, 520, 340, 804, 602], [‘clicks’, 101, +76, 239, 321]] + +</li> +<li>Any other object which has required methods as follows; + +<ul> +<li>each - to supply record objects. + +</li> +<li>items - If :x option does not exist and your resource object has items +method, it is called to get :x. You can change the method name by +:items_method option. + +</li> +<li>scales - If :y option does not exist and your resource object has scales +method, it is called to get :y. You can change the method name by +:scales_method option + +</li> +<li>max_scale - Would be used as :yMax option if it exists. + +</li> +<li>The record object shoud have methods as follows. + +<ul> +<li>label - Like ‘accesses’ in the example. You can use other +method if you specify :label_method option. + +</li> +<li>values - Like [520, 340, 804, 602] in the example. You can use other method +if you specify :values_method option. + +</li> +<li>color - If :barColors option does not exist and your record object has +color method, it is used for :barColors. You can change the method name by +:color_method option. + +</li> +</ul> +</li> +</ul> +</li> +</ul> + +Additionaly, the following options are available. + +<ul> +<li>:canvas_id - element id of the canvas. Default is ‘<a +href="Html5jpGraphsHelper.html#M000003">line_chart</a>’. Note that +all rader charts in one page sould have unique canvas_ids. + +</li> +<li>:width - The width of the canvas. Default is 400. + +</li> +<li>:height - The height of the canvas. Default is 300. + +</li> +<li>All options in <a +href="http://www.html5.jp/library/graph_vbar.html">www.html5.jp/library/graph_vbar.html</a>. +ex. ‘backgroundColor’ or :backgroundColor. + +</li> +</ul> + +And you can use html_options for the top level div. + + <a class="source-toggle" href="#" + onclick="toggleCode('M000001-source');return false;">[Source]</a> + <div class="method-source-code" id="M000001-source"> +<pre> + # File lib/html5jp_graphs_helper.rb, line 27 +27: def vertical_bar_chart(resource, options = {}, html_options = {}) +28: options = {:width => 400, :height => 300, :canvas_id => 'vertical_bar_chart'}.merge(options.symbolize_keys) +29: output = canvas(options, html_options) +30: output << "\n" +31: output << vertical_bar_chart_js(resource, options) +32: end </pre> </div> </div> rdoc/classes/Html5jpGraphsHelper.html @@ -1 +1 @@ -Mon, 16 Jun 2008 17:14:58 +0900 +Mon, 23 Jun 2008 18:14:11 +0900 rdoc/created.rid @@ -56,7 +56,7 @@ </tr> <tr class="top-aligned-row"> <td>Last Update:</td> - <td>Mon Jun 16 17:14:43 +0900 2008</td> + <td>Mon Jun 23 12:36:07 +0900 2008</td> </tr> </table> </div> rdoc/files/lib/html5jp_graphs_helper_rb.html @@ -20,7 +20,7 @@ <div id="index"> <h1 class="section-bar">Files</h1> <div id="index-entries"> - <a href="files/README.html">README</a> + <a href="files/README_rdoc.html">README.rdoc</a> <a href="files/lib/html5jp_graphs_helper_rb.html">lib/html5jp_graphs_helper.rb</a> </div> </div> rdoc/fr_file_index.html @@ -20,8 +20,10 @@ <div id="index"> <h1 class="section-bar">Methods</h1> <div id="index-entries"> - <a href="classes/Html5jpGraphsHelper.html#M000001">pie_chart (Html5jpGraphsHelper)</a> + <a href="classes/Html5jpGraphsHelper.html#M000003">line_chart (Html5jpGraphsHelper)</a> + <a href="classes/Html5jpGraphsHelper.html#M000004">pie_chart (Html5jpGraphsHelper)</a> <a href="classes/Html5jpGraphsHelper.html#M000002">radar_chart (Html5jpGraphsHelper)</a> + <a href="classes/Html5jpGraphsHelper.html#M000001">vertical_bar_chart (Html5jpGraphsHelper)</a> </div> </div> </body> rdoc/fr_method_index.html @@ -19,6 +19,6 @@ <frame src="fr_class_index.html" name="Classes" /> <frame src="fr_method_index.html" name="Methods" /> </frameset> - <frame src="files/README.html" name="docwin" /> + <frame src="files/README_rdoc.html" name="docwin" /> </frameset> </html> \ No newline at end of file rdoc/index.html rdoc/files/README.html 28fcbb44229b862686dbf097938840d9b179be53 Yasuko Ohba y.ohba@everyleaf.com http://github.com/nay/html5jp_graphs/commit/ca2f18c469c4fb6960ffe5754245b8e89443bc4f ca2f18c469c4fb6960ffe5754245b8e89443bc4f

2008-06-23T02:15:15-07:00

Updated rdoc f44176c350465fe9a7b6c3d0ec81aa598e6795b9 Yasuko Ohba y.ohba@everyleaf.com