gchartrb 0.6 → 0.7

data/History.txt

@@ -1,3 +1,9 @@
+== 0.7 / 2008-02-04
+
+* Added fill area feature
+* Added to_escaped_url method for encoding the URLs properly
+* Fixed bug where wrong variable name was being used in method
+
 == 0.6 / 2008-01-27
 
 * Added experimental support for undocumented Financial Line Chart (lfi)

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

data/TODO

@@ -2,7 +2,7 @@ TODO List (Features)
 ====================
 * Line Styles DONE
 * Customisable Width for bar charts DONE
-* Fill Area
+* Fill Area DONE
 * Download Image
 
 * Friendly Color Values

data/lib/google_chart/bar_chart.rb

@@ -29,7 +29,7 @@ module GoogleChart
     end
     
     # If you want the bar chart to be stacked, set the value to <tt>true</tt>, otherwise set the value to <tt>false</tt> to group it.
-    def stacked=(stacked)
+    def stacked=(value)
       @stacked = value
       set_chart_type
     end

data/lib/google_chart/base.rb

@@ -74,25 +74,30 @@ module GoogleChart
     #      lc.data "Trend 3", [6,5,4,3,2,1], 'ff0000'
     #      puts lc.to_url({:chm => "000000,0,0.1,0.11"}) # Single black line as a horizontal marker        
     def to_url(extras={})
-      params.clear
-      set_size
-      set_type
-      set_colors
-      set_fill_options
-      add_axis unless @axis.empty?
-      add_grid  
-      add_data
-      add_line_styles unless @line_styles.empty?
-      set_bar_width_spacing_options if @bar_width_spacing_options
-      add_markers unless @markers.empty?
-      add_labels(@labels) if [:p, :p3].member?(self.chart_type)
-      add_legend(@labels) if show_legend
-      add_title  if chart_title.to_s.length > 0 
-      
+      prepare_params
       params.merge!(extras)
       query_string = params.map { |k,v| "#{k}=#{URI.escape(v.to_s).gsub(/%20/,'+').gsub(/%7C/,'|')}" }.join('&')
       BASE_URL + query_string
     end
+
+    # Generates a fully encoded URL string that can be used to retrieve the graph image in PNG format.
+    # For less verbose URLs, use the <tt>to_url</tt> method. Use this only if you are doing further
+    # processing with the URLs, like passing the URL to a method for downloading the images
+    #
+    # Use this after assigning all the properties to the graph
+    # You can pass in additional params as a hash for features that may not have been implemented
+    # For e.g
+    #      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_escaped_url({:chm => "000000,0,0.1,0.11"}) # Single black line as a horizontal marker            
+    def to_escaped_url(extras={})
+      prepare_params
+      params.merge!(extras)
+      query_string = params.map { |k,v| "#{k}=#{URI.escape(v.to_s)}" }.join('&')
+      BASE_URL + query_string
+    end
     
     # Adds the data to the chart, according to the type of the graph being generated.
     #
@@ -248,8 +253,63 @@ module GoogleChart
       shape_marker_str = "#{SHAPE_MARKERS[type]},#{options[:color]},#{options[:data_set_index]},#{options[:data_point_index]},#{options[:pixel_size]}"
       @markers << shape_marker_str
     end
+
+    # Defines a Fill area. Applicable for line charts only
+    #
+    # [+color+] is the color of the fill area
+    # [+start_index+] is the index of the line at which the fill starts. This is 0 for the first data set, 1 for the second and so on.
+    # [+end_index+] is the index of the line at which the fill ends.
+    #
+    # ==== Examples
+    #     # Fill Area (Multiple Datasets)
+    #       lc = GoogleChart::LineChart.new('320x200', "Line Chart", false) do |lc|
+    #       lc.show_legend = false
+    #       lc.data "Trend 1", [5,5,6,5,5], 'ff0000'
+    #       lc.data "Trend 2", [3,3,4,3,3], '00ff00'
+    #       lc.data "Trend 3", [1,1,2,1,1], '0000ff'
+    #       lc.data "Trend 4", [0,0,0,0,0], 'ffffff'
+    #       lc.fill_area '0000ff',2,3
+    #       lc.fill_area '00ff00',1,2
+    #       lc.fill_area 'ff0000',0,1
+    #     end
+    #     puts "\nFill Area (Multiple Datasets)"
+    #      puts lc.to_url
+    #
+    #     # Fill Area (Single Dataset)
+    #     lc = GoogleChart::LineChart.new('320x200', "Line Chart", false) do |lc|
+    #       lc.show_legend = false
+    #       lc.data "Trend 1", [5,5,6,5,5], 'ff0000'
+    #       lc.fill_area 'cc6633', 0, 0
+    #     end
+    #     puts "\nFill Area (Single Dataset)"
+    #     puts lc.to_url
+    #
+    def fill_area(color, start_index, end_index)
+      if (start_index == 0 and end_index == 0)
+        @markers << "B,#{color},0,0,0"
+      else
+        @markers << "b,#{color},#{start_index},#{end_index},0"
+      end
+    end
     
     protected
+
+    def prepare_params
+      params.clear
+      set_size
+      set_type
+      set_colors
+      set_fill_options
+      add_axis unless @axis.empty?
+      add_grid  
+      add_data
+      add_line_styles unless @line_styles.empty?
+      set_bar_width_spacing_options if @bar_width_spacing_options
+      add_markers unless @markers.empty?
+      add_labels(@labels) if [:p, :p3].member?(self.chart_type)
+      add_legend(@labels) if show_legend
+      add_title  if chart_title.to_s.length > 0
+    end
     
     def process_fill_options(type, options)
       case type

data/lib/test.rb

@@ -174,3 +174,29 @@ lc = GoogleChart::LineChart.new('320x200', "Line Chart", false) do |lc|
 end
 puts "\nLine Styles"
 puts lc.to_url
+
+puts "\nLine Styles (encoded URL)"
+puts lc.to_escaped_url
+
+# Fill Area (Multiple Datasets)
+lc = GoogleChart::LineChart.new('320x200', "Line Chart", false) do |lc|
+  lc.show_legend = false
+  lc.data "Trend 1", [5,5,6,5,5], 'ff0000'
+  lc.data "Trend 2", [3,3,4,3,3], '00ff00'
+  lc.data "Trend 3", [1,1,2,1,1], '0000ff'
+  lc.data "Trend 4", [0,0,0,0,0], 'ffffff'
+  lc.fill_area '0000ff',2,3
+  lc.fill_area '00ff00',1,2
+  lc.fill_area 'ff0000',0,1
+end
+puts "\nFill Area (Multiple Datasets)"
+puts lc.to_url
+
+# Fill Area (Single Datasets)
+lc = GoogleChart::LineChart.new('320x200', "Line Chart", false) do |lc|
+  lc.show_legend = false
+  lc.data "Trend 1", [5,5,6,5,5], 'ff0000'
+  lc.fill_area 'cc6633', 0, 0
+end
+puts "\nFill Area (Single Dataset)"
+puts lc.to_url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gchartrb
 version: !ruby/object:Gem::Version 
-  version: "0.6"
+  version: "0.7"
 platform: ruby
 authors: 
 - Deepak Jois
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-27 00:00:00 +08:00
+date: 2008-02-04 00:00:00 +08:00
 default_executable: 
 dependencies: []