gchartrb 0.5 → 0.5.1

data/History.txt

@@ -1,13 +1,17 @@
-== 0.5
+== 0.5.1 / 2007-12-12
+
+* Added support for max_value method to specify maximum values to plot against
+
+== 0.5 / 2007-12-12
 
 * Added Scatter Chart Support
 * Documentation Updates
 
-== 0.4.1
+== 0.4.1 / 2007-12-12
 
 * Removed some spurious debug statements
 
-== 0.4
+== 0.4 / 2007-12-12
 
 * Fixed issue when all data points are 0 in Line XY Chart (Thanks Cedric)
 * Proper calculation of max values for Line XY chart (Thanks Bryan Donovan)

data/Manifest.txt

@@ -4,6 +4,7 @@ Manifest.txt
 README.txt
 Rakefile
 TODO
+lib/example.rb
 lib/google_chart.rb
 lib/google_chart/bar_chart.rb
 lib/google_chart/base.rb

data/README.txt

@@ -29,7 +29,6 @@ Download the latest release from http://code.google.com/p/gchartrb/downloads/lis
 == Problems/TODO
 The following features are pending :
 
-* Scatter Charts
 * Horizontal and Vertical range Markers
 * Line Styles
 * Shape Markers

data/Rakefile

@@ -8,7 +8,7 @@ class Hoe
   def extra_deps; @extra_deps.reject { |x| Array(x).first == "hoe" } end
 end # copied from the Rakefile of the sup project
 
-Hoe.new('gchartrb', "0.5") do |p|
+Hoe.new('gchartrb', "0.5.1") do |p|
   p.rubyforge_name  = 'gchartrb'
   p.author          = 'Deepak Jois'
   p.email           = 'deepak.jois@gmail.com'

data/lib/example.rb

@@ -0,0 +1,70 @@
+require 'google_chart'
+
+# Some examples from http://24ways.org/2007/tracking-christmas-cheer-with-google-charts
+
+# Pie Chart
+pc = GoogleChart::PieChart.new("600x300", "Food and Drinks Consumed Christmas 2007")
+pc.data "Egg nog", 10, '00AF33' 
+pc.data "Christmas Ham", 20, '4BB74C'
+pc.data "Milk (not including egg nog)",	8, 'EE2C2C'
+pc.data "Cookies", 25, 'CC3232'
+pc.data "Roasted Chestnuts", 5, '33FF33'
+pc.data "Chocolate", 3, '66FF66'
+pc.data "Various Other Beverages", 15, '9AFF9A'
+pc.data "Various Other Foods", 9, 'C1FFC1'
+pc.data "Snacks",	5, 'CCFFCC'
+puts pc.to_url
+
+#  Line Chart
+x_axis_labels = (1..31).to_a.collect do |v|    
+  if [1,6,25,26,31].member?(v)
+    if v == 1
+      "Dec 1st"
+    elsif v == 31
+      "Dec 31st"
+    elsif v 
+      "#{v}th" 
+    end    
+  else
+    nil
+  end  
+end 
+
+y_axis_labels = (0..10).to_a.collect do |v|
+  val = 10 * v
+  if val ==50 or val == 100
+    val.to_s
+  else
+    nil
+  end
+end
+
+series_1_y = [30,45,20,50,15,80,60,70,40,55,80]
+series_2_y = [50,10,30,55,60]
+
+series_1_x = [1,6,8,10,18,23,25,26,28,29,31]
+series_2_x = [1,4,6,9,11]
+
+series_1_xy = []
+series_2_xy = []
+
+series_1_x.each_with_index do |v,i|
+  series_1_xy[i] = [v-1, series_1_y[i] ]
+end
+
+series_2_x.each_with_index do |v,i|
+  series_2_xy[i] = [v-1, series_2_y[i ] ]
+end
+
+puts series_1_xy.inspect
+puts series_2_xy.inspect
+
+lcxy = GoogleChart::LineChart.new('800x300', "Projected Christmas Cheer for 2007", true)
+lcxy.data "2006", series_1_xy, '458B00'
+lcxy.data "2007", series_2_xy, 'CD2626'
+lcxy.max_value [30,100]
+lcxy.data_encoding = :text
+lcxy.axis :x, :labels => x_axis_labels
+lcxy.axis :y, :labels => y_axis_labels
+lcxy.grid :x_step => 3.333, :y_step => 10, :length_segment => 1, :length_blank => 3
+puts lcxy.to_url

data/lib/google_chart/bar_chart.rb

@@ -35,13 +35,12 @@ module GoogleChart
       end
 
       def process_data
-          if @data.size > 1
-              max_value = @data.flatten.max
+          if @data.size > 1              
                 join_encoded_data(@data.collect { |series|
-                  encode_data(series, max_value)
+                  encode_data(series, max_data_value)
                 })
           else
-              encode_data(@data.flatten)
+              encode_data(@data.flatten,max_data_value)
           end
       end
       

data/lib/google_chart/base.rb

@@ -51,7 +51,7 @@ module GoogleChart
             add_title  if chart_title.to_s.length > 0 
             
             params.merge!(extras)
-            query_string = params.map { |k,v| "#{k}=#{URI.escape(v.to_s)}" }.join('&')
+            query_string = params.map { |k,v| "#{k}=#{URI.escape(v.to_s).gsub(/%20/,'+').gsub(/%7C/,'|')}" }.join('&')
             BASE_URL + query_string
         end
         
@@ -78,6 +78,29 @@ module GoogleChart
             @colors << color if color
         end
         
+        # Allows (optional) setting of a max value for the chart, which will be used for data encoding and axis plotting.
+        # The value to pass depends on the type of chart
+        # * For Line Chart and Bar Charts it should be a single integer or float value
+        # * For Scatter Charts and Line XY Charts, you MUST pass an array containing the maximum values for X and Y
+        # 
+        # ==== Examples
+        # For bar charts
+        #    bc.max_value 5 # 5 will be used to calculate the relative encoding values
+        # For scatter chart
+        #    sc.max_value [5,6] # 5 is the max x value and 6 is the max y value
+        #
+        # Note : MAKE SURE you are passing the right values otherwise an exception will be raised
+        def max_value(value)
+          if [:lxy, :s].member?(self.chart_type) and value.is_a?(Array)
+            @max_x = value.first
+            @max_y = value.last
+          elsif [:lc,:bhg,:bhs,:bvg,:bvs] and (value.is_a?(Integer) or value.is_a?(Float))
+            @max_data = value
+          else
+            raise "Invalid max value for this chart type"
+          end
+        end
+        
         # Adds a background or chart fill. Call this option twice if you want both a background and a chart fill
         # [+bg_or_c+] Can be one of <tt>:background</tt> or <tt>:chart</tt> depending on the kind of fill requested
         # [+type+] Can be one of <tt>:solid</tt>, <tt>:gradient</tt> or <tt>:stripes</tt>
@@ -331,14 +354,18 @@ module GoogleChart
             encoded_data.join((self.data_encoding == :simple) ? "," : "|")
         end
         
+        def max_data_value
+          @max_data or @data.flatten.max
+        end
+        
         ## Applicable to Line Charts and Scatter Charts only
         
         def max_x_value
-          x_data.flatten.max
+          @max_x or x_data.flatten.max
         end
 
         def max_y_value
-          y_data.flatten.max
+          @max_y or y_data.flatten.max
         end
 
         def x_data

data/lib/google_chart/line_chart.rb

@@ -51,14 +51,13 @@ module GoogleChart
             encoded_data << join_encoded_data([encode_data(x_data[i],max_x_value), encode_data(y_data[i],max_y_value)])
           }
           join_encoded_data(encoded_data)
-        else # Line graph multiple data series
-          max_value = @data.flatten.max
+        else # Line graph multiple data series          
           join_encoded_data(@data.collect { |series|
-            encode_data(series, max_value)
+            encode_data(series, max_data_value)
           })
         end
       else
-        encode_data(@data.flatten)
+        encode_data(@data.flatten, max_data_value)
       end
     end
   end

data/lib/google_chart/pie_chart.rb

@@ -22,7 +22,7 @@ module GoogleChart
         end
 
         def process_data
-            encode_data(@data)
+            encode_data(@data, max_data_value)
         end
     end
 end

data/lib/google_chart/scatter_chart.rb

@@ -10,7 +10,7 @@ module GoogleChart
   #      puts sc.to_url  
   class ScatterChart < Base
     
-    # Initializes the Venn Diagram with a +chart_size+ (in WIDTHxHEIGHT format) and a +chart_title+
+    # Initializes the Scatter Chart with a +chart_size+ (in WIDTHxHEIGHT format) and a +chart_title+
     def initialize(chart_size='300x200', chart_title=nil)
       super(chart_size, chart_title)
       self.chart_type = :s

data/lib/test.rb

@@ -6,7 +6,7 @@ pc.data "Apples", 40
 pc.data "Banana", 20
 pc.data "Peach", 30
 pc.data "Orange", 60
-puts "Pie Chart"
+puts "\nPie Chart"
 puts pc.to_url
 
 # Line Chart
@@ -19,7 +19,7 @@ lc.data "Trend 3", [6,5,4,3,2,1], 'ff0000'
 lc.axis :y, :range => [0,6], :color => 'ff00ff', :font_size => 16, :alignment => :center
 lc.axis :x, :range => [0,6], :color => '00ffff', :font_size => 16, :alignment => :center
 lc.grid :x_step => 100.0/6.0, :y_step => 100.0/6.0, :length_segment => 1, :length_blank => 0
-puts "Line Chart"
+puts "\nLine Chart"
 puts lc.to_url
 
 # Bar Chart
@@ -27,14 +27,14 @@ bc = GoogleChart::BarChart.new('800x200', "Bar Chart", :vertical, false)
 bc.data "Trend 1", [5,4,3,1,3,5], '0000ff' 
 bc.data "Trend 2", [1,2,3,4,5,6], 'ff0000'
 bc.data "Trend 3", [6,5,4,4,5,6], '00ff00'
-puts "Bar Chart"
+puts "\nBar Chart"
 puts bc.to_url
 
 # Line XY Chart
 lcxy =  GoogleChart::LineChart.new('320x200', "Line XY Chart", true)
 lcxy.data "Trend 1", [[1,1], [2,2], [3,3], [4,4]], '0000ff'
 lcxy.data "Trend 2", [[4,5], [2,2], [1,1], [3,4]], '00ff00'
-puts "Line XY Chart"
+puts "\nLine XY Chart"
 puts lcxy.to_url 
 
 # Venn Diagram
@@ -49,32 +49,36 @@ vd.data "Blue", 100, '0000ff'
 vd.data "Green", 80, '00ff00'
 vd.data "Red",   60, 'ff0000'
 vd.intersections 30,30,30,10
-puts "Venn Diagram"
+puts "\nVenn Diagram"
 puts vd.to_url
 
 # Scatter Chart
 sc = GoogleChart::ScatterChart.new('320x200',"Scatter Chart")
 sc.data "Scatter Set", [[1,1,], [2,2], [3,3], [4,4]]
-sc.axis :x, :range => [0,4]
-sc.axis :y, :range => [0,4]
+sc.max_value [5,5] # Setting the max value
+sc.axis :x, :range => [0,5]
+sc.axis :y, :range => [0,5], :labels => [0,1,2,3,4,5]
 sc.point_sizes [10,15,30,55] # Optional
-puts "Scatter Chart"
+puts "\nScatter Chart"
 puts sc.to_url
 
 # Solid fill
 lc.fill(:background, :solid, {:color => 'fff2cc'})
 lc.fill(:chart, :solid, {:color => 'ffcccc'})
+puts "\nLine Chart with Solid Fill"
 puts lc.to_url
 
 # Gradient fill
 lc.fill :background, :gradient, :angle => 0,  :color => [['76A4FB',1],['ffffff',0]]
 lc.fill :chart, :gradient, :angle => 0, :color => [['76A4FB',1],
                                                    ['ffffff',0]]
+puts "\nLine Chart with Gradient Fill"
 puts lc.to_url
 
 # Stripes Fill
 lc.fill :chart, :stripes, :angle => 90, :color => [['76A4FB',0.2],
                                                    ['ffffff',0.2]]
+puts "\nLine Chart with Stripes Fill"
 puts lc.to_url
 
 # Adding Extra params
@@ -82,7 +86,9 @@ lc = GoogleChart::LineChart.new('320x200', "Line Chart", false)
 lc.data "Trend 1", [5,4,3,1,3,5,6], '0000ff'
 lc.data "Trend 2", [1,2,3,4,5,6], '00ff00'
 lc.data "Trend 3", [6,5,4,3,2,1], 'ff0000'
-puts lc.to_url({:chm => "r,000000,0,0.1,0.5"}) # Single black line as a horizontal marker
+lc.max_value 10 # Setting max value for simple line chart
+puts "\nLine Chart with Horizontal range marker using extra params"
+puts lc.to_url({:chm => "r,000000,0,0.1,0.5"}) # Single black region as a horizontal range marker
 
 # Bryan Error condition
 lcxy =  GoogleChart::LineChart.new('320x200', "Line XY Chart", true)
@@ -90,5 +96,6 @@ lcxy.data 'A', [[0, 32], [1, 15], [2, 23], [3, 18], [4, 41],  [5, 53]],'0000ff'
 lcxy.data 'B', [[0, 73], [1, 0],  [2, 28], [3, 0],  [4, 333], [5, 0]], '00ff00'
 lcxy.data 'C', [[0, 22], [1, 26], [2, 14], [3, 33], [4, 17],  [5, 7]], 'ff0000'
 lcxy.data 'D', [[0, 4],  [1, 39], [2, 0],  [3, 5],  [4, 11],  [5, 14]], 'cc00ff'
+puts "\nBryan Error Condition"
 puts lcxy.to_url
 

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: gchartrb
 version: !ruby/object:Gem::Version 
-  version: "0.5"
+  version: 0.5.1
 date: 2007-12-12 00:00:00 +08:00
 summary: Ruby Wrapper for the Google Chart API
 require_paths: 
@@ -35,6 +35,7 @@ files:
 - README.txt
 - Rakefile
 - TODO
+- lib/example.rb
 - lib/google_chart.rb
 - lib/google_chart/bar_chart.rb
 - lib/google_chart/base.rb