gchartrb 0.4.1 → 0.5

data/History.txt

@@ -1,3 +1,8 @@
+== 0.5
+
+* Added Scatter Chart Support
+* Documentation Updates
+
 == 0.4.1
 
 * Removed some spurious debug statements

data/Manifest.txt

@@ -9,5 +9,6 @@ lib/google_chart/bar_chart.rb
 lib/google_chart/base.rb
 lib/google_chart/line_chart.rb
 lib/google_chart/pie_chart.rb
+lib/google_chart/scatter_chart.rb
 lib/google_chart/venn_diagram.rb
 lib/test.rb

data/README.txt

@@ -95,7 +95,15 @@ However, you can still make use of the API to insert arbitrary parameters
     vd.data "Red",   60, 'ff0000'
     vd.intersections 30,30,30,10
     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.point_sizes [10,15,30,55] # Optional
+    puts sc.to_url
+    
     # Solid fill
     lc.fill(:background, :solid, {:color => 'fff2cc'})
     lc.fill(:chart, :solid, {:color => 'ffcccc'})

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.4.1") do |p|
+Hoe.new('gchartrb', "0.5") do |p|
   p.rubyforge_name  = 'gchartrb'
   p.author          = 'Deepak Jois'
   p.email           = 'deepak.jois@gmail.com'

data/TODO

@@ -4,7 +4,6 @@ TODO List (Features)
 * Line Styles
 * Fill Area
 * Handle Missing Values (?)
-* Other charts (Scatter)
 * Download image
 * Friendly color values
 * Helper methods for standard chart types like Sparklines etc.

data/lib/google_chart/base.rb

@@ -127,7 +127,7 @@ module GoogleChart
           @axis << [type, options]
         end
         
-        # Adds a grid to the graph. Applicable only for Line Chart (GoogleChart::LineChart) and Scatter Chart (available soon)
+        # Adds a grid to the graph. Applicable only for Line Chart (GoogleChart::LineChart) and Scatter Chart (GoogleChart::ScatterChart)
         #
         # [+options+] is a hash containing the options (see below) 
         #
@@ -330,5 +330,27 @@ module GoogleChart
         def join_encoded_data(encoded_data)
             encoded_data.join((self.data_encoding == :simple) ? "," : "|")
         end
+        
+        ## Applicable to Line Charts and Scatter Charts only
+        
+        def max_x_value
+          x_data.flatten.max
+        end
+
+        def max_y_value
+          y_data.flatten.max
+        end
+
+        def x_data
+          @data.collect do |series|
+            series.collect { |val| val.first }
+          end
+        end
+
+        def y_data
+          @data.collect do |series|
+            series.collect { |val| val.last }
+          end
+        end        
     end
 end

data/lib/google_chart/line_chart.rb

@@ -1,13 +1,38 @@
 require File.dirname(__FILE__) + '/base'
 module GoogleChart
+  
+  # Generates a Line chart. An option can be passed that allows you to create a Line XY Chart
+  #
+  # ==== Examples
+  #
+  #     # Line Chart
+  #     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'
+  #     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
+  #
+  #     # 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 lcxy.to_url 
   class LineChart < Base
     attr_accessor :is_xy
 
+    # Specify the 
+    # * +chart_size+ in WIDTHxHEIGHT format
+    # * +chart_title+ as a string
+    # * +is_xy+ is <tt>false</tt> by default. Set it to <tt>true</tt> if you want to plot a Line XY chart
     def initialize(chart_size='300x200', chart_title=nil, is_xy=false)
       super(chart_size, chart_title)
       self.is_xy = is_xy
     end
 
+    # Pass in <tt>true</tt> here to create a Line XY.
+    #
+    # Note: This must be done before passing in any data to the chart
     def is_xy=(value)
       @is_xy = value
       if value
@@ -17,26 +42,6 @@ module GoogleChart
       end
     end
 
-    def max_x_value
-      x_data.flatten.max
-    end
-
-    def max_y_value
-      y_data.flatten.max
-    end
-
-    def x_data
-      @data.collect do |series|
-        series.collect { |val| val.first }
-      end
-    end
-
-    def y_data
-      @data.collect do |series|
-        series.collect { |val| val.last }
-      end
-    end
-
     def process_data
       if self.is_xy or @data.size > 1
         if self.is_xy # XY Line graph data series

data/lib/google_chart/scatter_chart.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/base'
+module GoogleChart
+  
+  # Generates a Scatter chart.
+  # 
+  # ==== Example
+  #      sc = GoogleChart::ScatterChart.new('320x200',"Scatter Chart")
+  #      sc.data "Scatter Set", [[1,1,], [2,2], [3,3], [4,4]]
+  #      sc.point_sizes [10,15,30,55]
+  #      puts sc.to_url  
+  class ScatterChart < Base
+    
+    # Initializes the Venn Diagram 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
+      self.show_legend = false
+      @point_sizes = []
+    end
+    
+    def process_data
+      # Interleave X and Y co-ordinate data
+      encoded_data = join_encoded_data([encode_data(x_data[0],max_x_value), encode_data(y_data[0],max_y_value)])
+      # Add point sizes data if it exists
+      unless @point_sizes.empty?
+        encoded_data = join_encoded_data([encoded_data, encode_data(@point_sizes)])
+      end
+      return encoded_data
+    end
+    
+    # Specify the data point sizes of the Scatter chart (optional). The data point sizes are scaled with this data set.
+    def point_sizes(values)            
+      @point_sizes = values
+    end
+    
+  end
+end

data/lib/google_chart/venn_diagram.rb

@@ -16,7 +16,7 @@ module GoogleChart
     #      puts vd.to_url  
     class VennDiagram < Base
       
-        # Initializes the Venn Diagram with a +chart_size+ and a +chart_title+
+        # Initializes the Venn Diagram 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 = :v

data/lib/google_chart.rb

@@ -3,7 +3,8 @@
     pie_chart
     line_chart
     bar_chart
-    venn_diagram    
+    venn_diagram
+    scatter_chart    
 ).each do |filename|
     require File.dirname(__FILE__) + "/google_chart/#{filename}"
 end

data/lib/test.rb

@@ -6,6 +6,7 @@ pc.data "Apples", 40
 pc.data "Banana", 20
 pc.data "Peach", 30
 pc.data "Orange", 60
+puts "Pie Chart"
 puts pc.to_url
 
 # Line Chart
@@ -18,6 +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 lc.to_url
 
 # Bar Chart
@@ -25,12 +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 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 lcxy.to_url 
 
 # Venn Diagram
@@ -45,8 +49,18 @@ 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 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.point_sizes [10,15,30,55] # Optional
+puts "Scatter Chart"
+puts sc.to_url
+
 # Solid fill
 lc.fill(:background, :solid, {:color => 'fff2cc'})
 lc.fill(:chart, :solid, {:color => 'ffcccc'})

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: gchartrb
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
+  version: "0.5"
 date: 2007-12-12 00:00:00 +08:00
 summary: Ruby Wrapper for the Google Chart API
 require_paths: 
@@ -40,6 +40,7 @@ files:
 - lib/google_chart/base.rb
 - lib/google_chart/line_chart.rb
 - lib/google_chart/pie_chart.rb
+- lib/google_chart/scatter_chart.rb
 - lib/google_chart/venn_diagram.rb
 - lib/test.rb
 test_files: []