gchartrb 0.5.1 → 0.5.2

data/History.txt

@@ -1,3 +1,9 @@
+== 0.5.2 / 2007-12-14
+
+* Added support for title color via title_color attribute
+* Added support for vertical and horizontal range markers using the range_marker method
+* Removed show_labels from base.rb and added it only for pie charts
+
 == 0.5.1 / 2007-12-12
 
 * Added support for max_value method to specify maximum values to plot against

data/README.txt

@@ -36,12 +36,13 @@ The following features are pending :
 
 However, you can still make use of the API to insert arbitrary parameters
 
-    # Adding Extra params
-    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 by inserting arbitrary param
+    # Plotting a sparklines chart (using extra params)
+    sparklines = GoogleChart::LineChart.new('100x50', nil, false)
+    sparklines.data "Test", [4,3,2,4,6,8,10]
+    sparklines.show_legend = false
+    sparklines.axis :x, :labels => [] # Empty labels
+    sparklines.axis :y, :labels => [] # Empty labels
+    puts sparklines.to_url(:chxs => "0,000000,10,0,_|1,000000,10,0,_")
 
 == SYNOPSIS:
 

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.1") do |p|
+Hoe.new('gchartrb', "0.5.2") do |p|
   p.rubyforge_name  = 'gchartrb'
   p.author          = 'Deepak Jois'
   p.email           = 'deepak.jois@gmail.com'
@@ -19,4 +19,25 @@ Hoe.new('gchartrb', "0.5.1") do |p|
   p.remote_rdoc_dir = ''
 end
 
+
+RDOC_OPTS         = [
+	'--quiet',
+	'--title', 'gchartrb API',
+	'--main',  'README.txt',
+	'--charset', 'utf-8',
+	'--inline-source',
+	'--tab-width', '2',
+	'--line-numbers',
+]
+
+Rake::RDocTask.new do |rdoc|
+    rdoc.rdoc_dir  = 'doc/'
+    rdoc.options   = RDOC_OPTS
+    rdoc.main      = "README.txt"
+    rdoc.rdoc_files.add [
+    	'README.txt',
+    	'History.txt',
+    	'lib/**/*.rb'
+    ]
+end
 # vim: syntax=Ruby

data/lib/example.rb

@@ -56,9 +56,6 @@ 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'
@@ -68,3 +65,14 @@ 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
+
+
+# Plotting a sparklines chart
+sparklines = GoogleChart::LineChart.new('100x40', nil, false)
+sparklines.data "Test", [4,3,2,4,6,8,10]
+sparklines.show_legend = false
+sparklines.axis :x, :labels => []
+sparklines.axis :y, :labels => []
+puts sparklines.to_url(:chxs => "0,000000,10,0,_|1,000000,10,0,_")
+
+

data/lib/google_chart/bar_chart.rb

@@ -18,7 +18,6 @@ module GoogleChart
           @alignment = alignment
           @stacked = stacked
           set_chart_type
-          self.show_labels = false
           self.show_legend = true
       end
       

data/lib/google_chart/base.rb

@@ -13,19 +13,41 @@ module GoogleChart
             end
         end
 
-        attr_accessor :chart_size, :chart_type, :chart_title, :data_encoding, :params, :show_legend, :show_labels 
-    
+        # Size of the chart in WIDTHxHEIGHT format
+        attr_accessor :chart_size 
+        
+        # Type of the chart. Usually, you do not need to set this yourself
+        attr_accessor :chart_type 
+        
+        # Chart title
+        attr_accessor :chart_title
+        
+        # RRGGBB hex value for the color of the title
+        attr_accessor :title_color
+        
+        # Font size of the title
+        attr_accessor :title_font_size
+         
+        # Data encoding to use. Can be one of <tt>:simple</tt>, <tt>:text</tt> or <tt>:extended</tt> (see http://code.google.com/apis/chart/#chart_data)
+        attr_accessor :data_encoding
+        
+        # A hash of the params used to construct the URL        
+        attr_accessor :params
+        
+        # Set to <tt>true</tt> or <tt>false</tt> to show or hide the chart legend. Not applicable for Scatter Chart.
+        attr_accessor :show_legend
+        
         def initialize(chart_size, chart_title)
             self.params = Hash.new
             @labels = []
             @data   = []
             @colors = []
             @axis   = []
+            @range_markers = []
             self.chart_size    = chart_size
             self.chart_title   = chart_title
             self.data_encoding = :simple
             self.show_legend   = true
-            self.show_labels   = false
         end
         
         # Generates the URL string that can be used to retrieve the graph image in PNG format.
@@ -43,10 +65,11 @@ module GoogleChart
             set_type
             set_colors
             set_fill_options
-            add_axis
+            add_axis unless @axis.empty?
             add_grid  
             add_data
-            add_labels(@labels) if show_labels
+            add_range_markers unless @range_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 
             
@@ -111,11 +134,11 @@ module GoogleChart
         # * A <tt>:color</tt> option which specifies the RGB hex value of the color to be used as a fill. For e.g <tt>lc.fill(:chart, :solid, {:color => 'ffcccc'})</tt>
         #
         # For <tt>:gradient</tt> type
-        # * An <tt>:angle</p>, which is the angle of the gradient between 0(horizontal) and 90(vertical)
+        # * An <tt>:angle</tt>, which is the angle of the gradient between 0(horizontal) and 90(vertical)
         # * A <tt>:color</tt> option which is a 2D array containing the colors and an offset each, which specifies at what point the color is pure where: 0 specifies the right-most chart position and 1 the left-most. e,g <tt>lc.fill :background, :gradient, :angle => 0,  :color => [['76A4FB',1],['ffffff',0]]</tt>
         # 
         # For <tt>:stripes</tt> type
-        # * An <tt>:angle</p>, which is the angle of the stripe between 0(horizontal) and 90(vertical)
+        # * An <tt>:angle</tt>, which is the angle of the stripe between 0(horizontal) and 90(vertical)
         # * A <tt>:color</tt> option which is a 2D array containing the colors and width value each, which must be between 0 and 1 where 1 is the full width of the chart. for e.g <tt>lc.fill :chart, :stripes, :angle => 90, :color => [ ['76A4FB',0.2], ['ffffff',0.2] ]</tt>
         def fill(bg_or_c, type, options = {})
             case bg_or_c
@@ -162,13 +185,32 @@ module GoogleChart
         # 
         # === Examples
         #     lc.grid :x_step => 5, :y_step => 5, :length_segment => 1, :length_blank => 0
-        #
-        
+        #        
         def grid(options={})
           @grid_str = "#{options[:x_step].to_f},#{options[:y_step].to_f}"
           if options[:length_segment] or options[:length_blank]
              @grid_str += ",#{options[:length_segment].to_f},#{options[:length_blank].to_f}"
           end
+        end
+        
+        # Defines a horizontal or vertical range marker. Applicable for line charts and vertical charts
+        #
+        # [+alignment+] can be <tt>:horizontal</tt> or <tt>:vertical</tt>
+        # [+options+] specifies the color, start point and end point
+        # 
+        # ==== Options
+        # [<tt>:color</tt>] RRGGBB hex value for the color of the range marker
+        # [<tt>:start_point</tt>]  position on the x-axis/y-axis at which the range starts where 0.00 is the left/bottom and 1.00 is the right/top
+        # [<tt>:end_point</tt>]  position on the x-axis/y-axis at which the range ends where 0.00 is the left/bottom and 1.00 is the right/top
+        #
+        # ==== Examples
+        #     lc.range_marker :horizontal, :color => 'E5ECF9', :start_point => 0.1, :end_point => 0.5
+        #     lc.range_marker :vertical, :color => 'a0bae9', :start_point => 0.1, :end_point => 0.5
+        def range_marker(alignment, options={}) 
+          raise "Invalid alignment specified" unless [:horizontal, :vertical].member?(alignment)
+          str = (alignment == :horizontal ) ? "r" : "R"
+          str += ",#{options[:color]},0,#{options[:start_point]},#{options[:end_point]}"
+          @range_markers << str 
         end    
         
         protected
@@ -203,7 +245,7 @@ module GoogleChart
         end
         
         def add_labels(labels)
-            params.merge!({:chl => labels.collect{|l| l.to_s}.join("|") }) 
+            params.merge!({:chl => labels.collect{|l| l.to_s}.join("|") }) if self.show_labels 
         end                
     
         def add_legend(labels)
@@ -212,6 +254,7 @@ module GoogleChart
         
         def add_title
             params.merge!({:chtt => chart_title})
+            params.merge!({:chts => title_color}) if title_color
         end
         
         def add_axis          
@@ -281,6 +324,10 @@ module GoogleChart
           params.merge!({ :chg => @grid_str }) if @grid_str
         end
         
+        def add_range_markers
+          params.merge!({:chm => @range_markers.join("|")})
+        end
+        
         def add_data
             converted_data = process_data
             case data_encoding
@@ -357,9 +404,7 @@ module GoogleChart
         def max_data_value
           @max_data or @data.flatten.max
         end
-        
-        ## Applicable to Line Charts and Scatter Charts only
-        
+                
         def max_x_value
           @max_x or x_data.flatten.max
         end

data/lib/google_chart/pie_chart.rb

@@ -1,15 +1,19 @@
 require File.dirname(__FILE__) + '/base'
 module GoogleChart
     class PieChart < Base
-
+        
+        # set to <tt>true</tt> or <tt>false</tt> to indicate if this is a 3d chart
         attr_accessor :is_3d
+        
+        # set to <tt>true</tt> or <tt>false</tt> to show or hide pie chart labels
+        attr_accessor :show_labels
 
         # Initializes a Pie Chart object with a +chart_size+ and +chart_title+. Specify <tt>is_3d</tt> as +true+ to generate a 3D Pie chart
         def initialize(chart_size='300x200', chart_title=nil, is_3d = false)
             super(chart_size, chart_title)
             self.is_3d = is_3d
-            self.show_labels = true
             self.show_legend = false
+            self.show_labels = true
         end
 
         # Set this value to <tt>true</tt> if you want the Pie Chart to be rendered as a 3D image

data/lib/test.rb

@@ -9,11 +9,15 @@ pc.data "Orange", 60
 puts "\nPie Chart"
 puts pc.to_url
 
+# Pie Chart with no labels
+pc.show_labels = false
+puts "\nPie Chart (with no labels)"
+puts pc.to_url
+
 # Line Chart
 lc = GoogleChart::LineChart.new('320x200', "Line Chart", false)
 lc.data "Trend 1", [5,4,3,1,3,5,6], '0000ff'
-lc.show_legend = true 
-lc.show_labels = false
+lc.show_legend = true
 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
@@ -83,12 +87,15 @@ puts lc.to_url
 
 # Adding Extra params
 lc = GoogleChart::LineChart.new('320x200', "Line Chart", false)
+lc.title_color = 'ff00ff'
 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.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
+lc.max_value 10 # Setting max value for simple line chart 
+lc.range_marker :horizontal, :color => 'E5ECF9', :start_point => 0.1, :end_point => 0.5
+lc.range_marker :vertical, :color => 'a0bae9', :start_point => 0.1, :end_point => 0.5
+puts "\nLine Chart with range markers"
+puts lc.to_url
 
 # Bryan Error condition
 lcxy =  GoogleChart::LineChart.new('320x200', "Line XY Chart", true)

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: gchartrb
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
-date: 2007-12-12 00:00:00 +08:00
+  version: 0.5.2
+date: 2007-12-14 00:00:00 +08:00
 summary: Ruby Wrapper for the Google Chart API
 require_paths: 
 - lib