gchartrb 0.5.5 → 0.6

data/CREDITS

@@ -1,3 +1,4 @@
 Will Fitzgerald - http://www.entish.org/willwhim
 Bryan Donovan
-Aseem Tandon
+Aseem Tandon
+Diomedes <alakazoom@gmail.com>

data/History.txt

@@ -1,3 +1,9 @@
+== 0.6 / 2008-01-27
+
+* Added experimental support for undocumented Financial Line Chart (lfi)
+* Added line style support (thanks diomedes)
+* Added support for customisable width and spacing in bar charts
+
 == 0.5.5 / 2008-01-23
 
 * Fixed a bug related to multiple datasets using extended encoding

data/Manifest.txt

@@ -12,4 +12,5 @@ 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/google_chart/financial_line_chart.rb
 lib/test.rb

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

data/TODO

@@ -1,11 +1,12 @@
 TODO List (Features)
 ====================
-* Line Styles
+* Line Styles DONE
+* Customisable Width for bar charts DONE
 * Fill Area
-* Handle Missing Values (?)
-* Download image
-* Friendly color values
-* Helper methods for standard chart types like Sparklines etc.
+* Download Image
+
+* Friendly Color Values
+* Easy calculations for Stuff that is needed
 
 TODO List (Other)
 =================

data/lib/google_chart.rb

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

data/lib/google_chart/bar_chart.rb

@@ -1,76 +1,90 @@
 require File.dirname(__FILE__) + '/base'
 module GoogleChart
-    # Generates a Bar Chart. You can specify the alignment(horizontal or vertical) and whether you want the bars to be grouped or stacked
-    # ==== Examples
-    #     bc = GoogleChart::BarChart.new('800x200', "Bar Chart", :vertical, false)
-    #     bc.data "Trend 1", [5,4,3,1,3,5], '0000ff'     
-    class BarChart < Base
-      
-      attr_accessor :alignment, :stacked
-      
-      # Specify the 
-      # * +chart_size+ in WIDTHxHEIGHT format
-      # * +chart_title+ as a string
-      # * +alignment+ as either <tt>:vertical</tt> or <tt>:horizontal</tt>
-      # * +stacked+ should be +true+ if you want the bars to be stacked, false otherwise
-      def initialize(chart_size='300x200', chart_title=nil, alignment=:vertical, stacked=false) # :yield: self
-          super(chart_size, chart_title)
-          @alignment = alignment
-          @stacked = stacked
-          set_chart_type
-          self.show_legend = true
-          yield self if block_given?
-      end
-      
-      # Set the alignment to either <tt>:vertical</tt> or <tt>:horizontal</tt>
-      def alignment=(value)
-          @alignment = value
-          set_chart_type
-      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)
-          @stacked = value
-          set_chart_type
-      end
+  # Generates a Bar Chart. You can specify the alignment(horizontal or vertical) and whether you want the bars to be grouped or stacked
+  # ==== Examples
+  #     bc = GoogleChart::BarChart.new('800x200', "Bar Chart", :vertical, false)
+  #     bc.data "Trend 1", [5,4,3,1,3,5], '0000ff'     
+  class BarChart < Base
+    
+    attr_accessor :alignment, :stacked
+    
+    # Specify the 
+    # * +chart_size+ in WIDTHxHEIGHT format
+    # * +chart_title+ as a string
+    # * +alignment+ as either <tt>:vertical</tt> or <tt>:horizontal</tt>
+    # * +stacked+ should be +true+ if you want the bars to be stacked, false otherwise
+    def initialize(chart_size='300x200', chart_title=nil, alignment=:vertical, stacked=false) # :yield: self
+      super(chart_size, chart_title)
+      @alignment = alignment
+      @stacked = stacked
+      set_chart_type
+      self.show_legend = true
+      yield self if block_given?
+    end
+    
+    # Set the alignment to either <tt>:vertical</tt> or <tt>:horizontal</tt>
+    def alignment=(value)
+      @alignment = value
+      set_chart_type
+    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)
+      @stacked = value
+      set_chart_type
+    end
 
-      def process_data
-          if @stacked # Special handling of max value for stacked
-            unless @max_data # Unless max_data is explicitly set
-              @max_data = @data.inject([]) do |sum_arr, series| 
-                series.each_with_index do |v,i| 
-                  if sum_arr[i] == nil
-                    sum_arr[i] = v
-                  else
-                    sum_arr[i] += v
-                  end
-                end
-                sum_arr
-              end.max
-            end
-          end
+    # Defines options for bar width, spacing between bars and between groups of bars. Applicable for bar charts.
+    # [+options+] : Options for the style, specifying things like line thickness and lengths of the line segment and blank portions
+    #
+    # ==== Options
+    # * <tt>:bar_width</tt>, Bar width in pixels
+    # * <tt>:bar_spacing</tt> (optional), space between bars in a group
+    # * <tt>:group_spacing</tt> (optional), space between groups
+    def width_spacing_options(options={})
+      options_str = "#{options[:bar_width]}"
+      options_str += ",#{options[:bar_spacing]}" if options[:bar_spacing]
+      options_str += ",#{options[:group_spacing]}" if options[:bar_spacing] and options[:group_spacing]
+      @bar_width_spacing_options = options_str
+    end
 
-          if @data.size > 1              
-                join_encoded_data(@data.collect { |series|
-                  encode_data(series, max_data_value)
-                })
-          else
-              encode_data(@data.flatten,max_data_value)
-          end
+    def process_data
+      if @stacked # Special handling of max value for stacked
+        unless @max_data # Unless max_data is explicitly set
+          @max_data = @data.inject([]) do |sum_arr, series| 
+            series.each_with_index do |v,i| 
+              if sum_arr[i] == nil
+                sum_arr[i] = v
+              else
+                sum_arr[i] += v
+              end
+            end
+            sum_arr
+          end.max
+        end
       end
-      
-      private
-      def set_chart_type
-          # Set chart type
-          if alignment == :vertical and stacked == false
-              self.chart_type = :bvg
-          elsif alignment == :vertical and stacked == true
-              self.chart_type = :bvs
-          elsif alignment == :horizontal and stacked == false
-              self.chart_type = :bhg
-          elsif alignment == :horizontal and stacked == true
-              self.chart_type = :bhs
-          end          
+
+      if @data.size > 1              
+        join_encoded_data(@data.collect { |series|
+                            encode_data(series, max_data_value)
+                          })
+      else
+        encode_data(@data.flatten,max_data_value)
       end
     end
-end
+    
+    private
+    def set_chart_type
+      # Set chart type
+      if alignment == :vertical and stacked == false
+        self.chart_type = :bvg
+      elsif alignment == :vertical and stacked == true
+        self.chart_type = :bvs
+      elsif alignment == :horizontal and stacked == false
+        self.chart_type = :bhg
+      elsif alignment == :horizontal and stacked == true
+        self.chart_type = :bhs
+      end          
+    end
+  end
+end

data/lib/google_chart/base.rb

@@ -24,6 +24,8 @@ module GoogleChart
       :x => "x"
     }
 
+    DEFAULT_LINE_STYLE = '1'
+
     # Size of the chart in WIDTHxHEIGHT format
     attr_accessor :chart_size 
     
@@ -55,6 +57,7 @@ module GoogleChart
       @colors = []
       @axis   = []
       @markers = []
+      @line_styles = []
       self.chart_size    = chart_size
       self.chart_title   = chart_title
       self.data_encoding = :simple
@@ -79,6 +82,8 @@ module GoogleChart
       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
@@ -355,6 +360,17 @@ module GoogleChart
     def add_grid
       params.merge!({ :chg => @grid_str }) if @grid_str
     end
+
+    def add_line_styles
+      0.upto(@line_styles.length - 1) { |i|
+        @line_styles[i] = DEFAULT_LINE_STYLE unless @line_styles[i]
+      }
+      params.merge!({:chls => @line_styles.join("|")})
+    end
+
+    def set_bar_width_spacing_options
+      params.merge!({:chbh => @bar_width_spacing_options})
+    end
     
     def add_markers
       params.merge!({:chm => @markers.join("|")})

data/lib/google_chart/financial_line_chart.rb

@@ -0,0 +1,31 @@
+require File.dirname(__FILE__) + '/base'
+module GoogleChart
+
+  # Generates a Financial Line Chart. This feature is UNDOCUMENTED and EXPERIMENTAL.
+  # For a sample usage, visit (right at the bottom) http://24ways.org/2007/tracking-christmas-cheer-with-google-charts
+  #
+  # ==== Examples
+  #    flc = GoogleChart::FinancialLineChart.new do |chart|
+  #       chart.data "", [3,10,20,37,40,25,68,75,89,99], "ff0000"
+  #    end
+  #    puts flc.to_url
+  #
+  class FinancialLineChart < Base
+    
+    # Specify the 
+    # * +chart_size+ in WIDTHxHEIGHT format
+    # * +chart_title+ as a string
+    def initialize(chart_size='100x15', chart_title=nil) # :yield: self
+      super(chart_size, chart_title)
+      self.chart_type = :lfi
+      self.show_legend = false
+      yield self if block_given?
+    end
+
+    def process_data
+      join_encoded_data(@data.collect { |series|
+            encode_data(series, max_data_value)
+          })
+    end
+  end
+end

data/lib/google_chart/line_chart.rb

@@ -28,6 +28,7 @@ module GoogleChart
     def initialize(chart_size='300x200', chart_title=nil, is_xy=false) # :yield: self
       super(chart_size, chart_title)
       self.is_xy = is_xy
+      @line_styles = []
       yield self if block_given?
     end
 
@@ -43,6 +44,19 @@ module GoogleChart
       end
     end
 
+    # Defines a line style. Applicable for line charts.
+    # [+data_set_index+] Can be one of <tt>:background</tt> or <tt>:chart</tt> depending on the kind of fill requested
+    # [+options+] : Options for the style, specifying things like line thickness and lengths of the line segment and blank portions
+    #
+    # ==== Options
+    # * <tt>:line_thickness</tt> (mandatory) option which specifies the thickness of the line segment in pixels
+    # * <tt>:length_segment</tt>, which specifies the length of the line segment
+    # * <tt>:length_blank</tt>, which specifies the lenght of the blank segment
+    def line_style(data_set_index, options={})
+      @line_styles[data_set_index] = "#{options[:line_thickness]}"
+      @line_styles[data_set_index] += ",#{options[:length_segment]},#{options[:length_blank]}" if options[:length_segment]
+    end
+
     def process_data
       if self.is_xy or @data.size > 1
         if self.is_xy # XY Line graph data series
@@ -54,8 +68,8 @@ module GoogleChart
           join_encoded_data(encoded_data)
         else # Line graph multiple data series          
           join_encoded_data(@data.collect { |series|
-            encode_data(series, max_data_value)
-          })
+                              encode_data(series, max_data_value)
+                            })
         end
       else
         encode_data(@data.flatten, max_data_value)

data/lib/test.rb

@@ -34,6 +34,7 @@ GoogleChart::BarChart.new('800x200', "Bar Chart", :vertical, false) do |bc|
   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'
+  bc.width_spacing_options :bar_width => 5, :bar_spacing => 2, :group_spacing => 10
   puts "\nBar Chart"
   puts bc.to_url
 end
@@ -155,3 +156,21 @@ end
 puts "\nBar chart encoding error test"
 puts bc.to_url
 
+# Financial Line Chart (Experimental)
+flc = GoogleChart::FinancialLineChart.new do |chart|
+  chart.data "", [3,10,20,37,40,25,68,75,89,99], "ff0000"
+end
+puts "\nFinancial Line Chart or Sparklines (EXPERIMENTAL)"
+puts flc.to_url
+
+# Line Style
+lc = GoogleChart::LineChart.new('320x200', "Line Chart", false) do |lc|
+  lc.data "Trend 1", [5,4,3,1,3,5], '0000ff'
+  lc.data "Trend 2", [1,2,3,4,5,6], '00ff00'
+  lc.data "Trend 3", [6,5,4,3,2,1], 'ff0000'
+  lc.line_style 0, :length_segment => 3, :length_blank => 2, :line_thickness => 3
+  lc.line_style 1, :length_segment => 1, :length_blank => 2, :line_thickness => 1
+  lc.line_style 2, :length_segment => 2, :length_blank => 1, :line_thickness => 5
+end
+puts "\nLine Styles"
+puts lc.to_url

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gchartrb
 version: !ruby/object:Gem::Version 
-  version: 0.5.5
+  version: "0.6"
 platform: ruby
 authors: 
 - Deepak Jois
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-01-23 00:00:00 +08:00
+date: 2008-01-27 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -38,6 +38,7 @@ files:
 - lib/google_chart/pie_chart.rb
 - lib/google_chart/scatter_chart.rb
 - lib/google_chart/venn_diagram.rb
+- lib/google_chart/financial_line_chart.rb
 - lib/test.rb
 has_rdoc: true
 homepage: "    by Deepak Jois"