svg-graph 1.0.0

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+$:.unshift("./lib")
+require 'svggraph'
+Hoe.spec 'svg-graph' do |p|
+	p.version=SVG::Graph::VERSION
+	p.developer('Sean Russell', 'ser_AT_germane-software.com')
+	p.developer('Claudio Bustos', 'clbustos_AT_gmail.com')
+	p.rubyforge_name = 'ruby-statsample' # if different than 'svg_graph'
+        p.remote_rdoc_dir = 'svg-graph'
+end
+
+# vim: syntax=ruby

data/lib/SVG/Graph/Bar.rb

@@ -0,0 +1,148 @@
+require 'rexml/document'
+require 'SVG/Graph/Graph'
+require 'SVG/Graph/BarBase'
+
+module SVG
+  module Graph
+    # === Create presentation quality SVG bar graphs easily
+    #
+    # = Synopsis
+    #
+    #   require 'SVG/Graph/Bar'
+    #
+    #   fields = %w(Jan Feb Mar);
+    #   data_sales_02 = [12, 45, 21]
+    #
+    #   graph = SVG::Graph::Bar.new(
+    #     :height => 500,
+    #     :width => 300,
+    #     :fields => fields
+    #   )
+    #
+    #   graph.add_data(
+    #     :data => data_sales_02,
+    #     :title => 'Sales 2002'
+    #   )
+    #
+    #   print "Content-type: image/svg+xml\r\n\r\n"
+    #   print graph.burn
+    #
+    # = Description
+    #
+    # This object aims to allow you to easily create high quality
+    # SVG[http://www.w3c.org/tr/svg bar graphs. You can either use the default
+    # style sheet or supply your own. Either way there are many options which
+    # can be configured to give you control over how the graph is generated -
+    # with or without a key, data elements at each point, title, subtitle etc.
+    #
+    # = Notes
+    #
+    # The default stylesheet handles upto 12 data sets, if you
+    # use more you must create your own stylesheet and add the
+    # additional settings for the extra data sets. You will know
+    # if you go over 12 data sets as they will have no style and
+    # be in black.
+    #
+    # = Examples
+    #
+    # * http://germane-software.com/repositories/public/SVG/test/test.rb
+    #
+    # = See also
+    #
+    # * SVG::Graph::Graph
+    # * SVG::Graph::BarHorizontal
+    # * SVG::Graph::Line
+    # * SVG::Graph::Pie
+    # * SVG::Graph::Plot
+    # * SVG::Graph::TimeSeries
+    class Bar < BarBase
+      include REXML
+
+      # See Graph::initialize and BarBase::set_defaults
+      def set_defaults 
+        super
+        self.top_align = self.top_font = 1
+      end
+
+      protected
+
+      def get_x_labels
+        @config[:fields]
+      end
+
+      def get_y_labels
+        maxvalue = max_value
+        minvalue = min_value
+        range = maxvalue - minvalue
+
+        top_pad = range == 0 ? 10 : range / 20.0
+        scale_range = (maxvalue + top_pad) - minvalue
+
+        scale_division = scale_divisions || (scale_range / 10.0)
+
+        if scale_integers
+          scale_division = scale_division < 1 ? 1 : scale_division.round
+        end
+
+        rv = []
+        maxvalue = maxvalue%scale_division == 0 ? 
+          maxvalue : maxvalue + scale_division
+        minvalue.step( maxvalue, scale_division ) {|v| rv << v}
+        return rv
+      end
+
+      def x_label_offset( width )
+        width / 2.0
+      end
+
+      def draw_data
+        minvalue = min_value
+        fieldwidth = field_width
+
+        unit_size =  (@graph_height.to_f - font_size*2*top_font) / 
+                          (get_y_labels.max - get_y_labels.min)
+        bargap = bar_gap ? (fieldwidth < 10 ? fieldwidth / 2 : 10) : 0
+
+        bar_width = fieldwidth - bargap
+        bar_width /= @data.length if stack == :side
+        x_mod = (@graph_width-bargap)/2 - (stack==:side ? bar_width/2 : 0)
+ 
+        bottom = @graph_height
+
+        field_count = 0
+        @config[:fields].each_index { |i|
+          dataset_count = 0
+          for dataset in @data
+          
+            # cases (assume 0 = +ve):
+            #   value  min  length
+            #    +ve   +ve  value - min
+            #    +ve   -ve  value - 0
+            #    -ve   -ve  value.abs - 0
+          
+            value = dataset[:data][i]
+            
+            left = (fieldwidth * field_count)
+            
+            length = (value.abs - (minvalue > 0 ? minvalue : 0)) * unit_size
+            # top is 0 if value is negative
+            top = bottom - (((value < 0 ? 0 : value) - minvalue) * unit_size)
+            left += bar_width * dataset_count if stack == :side
+ 
+            @graph.add_element( "rect", {
+              "x" => left.to_s,
+              "y" => top.to_s,
+              "width" => bar_width.to_s,
+              "height" => length.to_s,
+              "class" => "fill#{dataset_count+1}"
+            })
+
+            make_datapoint_text(left + bar_width/2.0, top - 6, value.to_s)
+            dataset_count += 1
+          end
+          field_count += 1
+        }
+      end
+    end
+  end
+end

data/lib/SVG/Graph/BarBase.rb

@@ -0,0 +1,139 @@
+require 'rexml/document'
+require 'SVG/Graph/Graph'
+
+module SVG
+  module Graph
+		# = Synopsis
+		#
+		# A superclass for bar-style graphs.  Do not attempt to instantiate
+		# directly; use one of the subclasses instead.
+		#
+    # = Author
+    #
+    # Sean E. Russell <serATgermaneHYPHENsoftwareDOTcom>
+		#
+    # Copyright 2004 Sean E. Russell
+		# This software is available under the Ruby license[LICENSE.txt]
+    #
+    class BarBase < SVG::Graph::Graph
+			# Ensures that :fields are provided in the configuration.
+      def initialize config
+        raise "fields was not supplied or is empty" unless config[:fields] &&
+        config[:fields].kind_of?(Array) &&
+        config[:fields].length > 0
+				super
+			end
+
+			# In addition to the defaults set in Graph::initialize, sets
+			# [bar_gap] true
+			# [stack] :overlap
+			def set_defaults
+        init_with( :bar_gap => true, :stack => :overlap )
+      end
+
+      #   Whether to have a gap between the bars or not, default
+      #   is true, set to false if you don't want gaps.
+      attr_accessor :bar_gap
+      #   How to stack data sets.  :overlap overlaps bars with
+      #   transparent colors, :top stacks bars on top of one another,
+      #   :side stacks the bars side-by-side. Defaults to :overlap.
+      attr_accessor :stack
+
+
+			protected
+
+      def max_value
+        @data.collect{|x| x[:data].max}.max
+      end
+
+      def min_value
+        min = 0
+        if min_scale_value.nil? 
+          min = @data.collect{|x| x[:data].min}.min
+          min = min > 0 ? 0 : min
+        else
+          min = min_scale_value
+        end
+        return min
+      end
+
+      def get_css
+        return <<EOL
+/* default fill styles for multiple datasets (probably only use a single dataset on this graph though) */
+.key1,.fill1{
+	fill: #ff0000;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 0.5px;	
+}
+.key2,.fill2{
+	fill: #0000ff;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key3,.fill3{
+	fill: #00ff00;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key4,.fill4{
+	fill: #ffcc00;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key5,.fill5{
+	fill: #00ccff;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key6,.fill6{
+	fill: #ff00ff;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key7,.fill7{
+	fill: #00ffff;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key8,.fill8{
+	fill: #ffff00;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key9,.fill9{
+	fill: #cc6666;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key10,.fill10{
+	fill: #663399;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key11,.fill11{
+	fill: #339900;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+.key12,.fill12{
+	fill: #9966FF;
+	fill-opacity: 0.5;
+	stroke: none;
+	stroke-width: 1px;	
+}
+EOL
+      end
+    end
+  end
+end

data/lib/SVG/Graph/BarHorizontal.rb

@@ -0,0 +1,149 @@
+require 'rexml/document'
+require 'SVG/Graph/BarBase'
+
+module SVG
+  module Graph
+    # === Create presentation quality SVG horitonzal bar graphs easily
+    # 
+    # = Synopsis
+    # 
+    #   require 'SVG/Graph/BarHorizontal'
+    #   
+    #   fields = %w(Jan Feb Mar)
+    #   data_sales_02 = [12, 45, 21]
+    #   
+    #   graph = SVG::Graph::BarHorizontal.new({
+    #     :height => 500,
+    #     :width => 300,
+    #     :fields => fields,
+    #   })
+    #   
+    #   graph.add_data({
+    #     :data => data_sales_02,
+    #     :title => 'Sales 2002',
+    #   })
+    #   
+    #   print "Content-type: image/svg+xml\r\n\r\n"
+    #   print graph.burn
+    # 
+    # = Description
+    # 
+    # This object aims to allow you to easily create high quality
+    # SVG horitonzal bar graphs. You can either use the default style sheet
+    # or supply your own. Either way there are many options which can
+    # be configured to give you control over how the graph is
+    # generated - with or without a key, data elements at each point,
+    # title, subtitle etc.
+    # 
+    # = Examples
+    # 
+    # * http://germane-software.com/repositories/public/SVG/test/test.rb
+    # 
+    # = See also
+    # 
+    # * SVG::Graph::Graph
+    # * SVG::Graph::Bar
+    # * SVG::Graph::Line
+    # * SVG::Graph::Pie
+    # * SVG::Graph::Plot
+    # * SVG::Graph::TimeSeries
+    #
+    # == Author
+    #
+    # Sean E. Russell <serATgermaneHYPHENsoftwareDOTcom>
+    #
+    # Copyright 2004 Sean E. Russell
+    # This software is available under the Ruby license[LICENSE.txt]
+    #
+    class BarHorizontal < BarBase
+      # In addition to the defaults set in BarBase::set_defaults, sets
+      # [rotate_y_labels] true
+      # [show_x_guidelines] true
+      # [show_y_guidelines] false
+      def set_defaults
+        super
+        init_with( 
+          :rotate_y_labels    => true,
+          :show_x_guidelines  => true,
+          :show_y_guidelines  => false
+        )
+        self.right_align = self.right_font = 1
+      end
+  
+      protected
+
+      def get_x_labels
+        maxvalue = max_value
+        minvalue = min_value
+        range = maxvalue - minvalue
+        top_pad = range == 0 ? 10 : range / 20.0
+        scale_range = (maxvalue + top_pad) - minvalue
+
+        scale_division = scale_divisions || (scale_range / 10.0)
+
+        if scale_integers
+          scale_division = scale_division < 1 ? 1 : scale_division.round
+        end
+
+        rv = []
+        maxvalue = maxvalue%scale_division == 0 ? 
+          maxvalue : maxvalue + scale_division
+        minvalue.step( maxvalue, scale_division ) {|v| rv << v}
+        return rv
+      end
+
+      def get_y_labels
+        @config[:fields]
+      end
+
+      def y_label_offset( height )
+        height / -2.0
+      end
+
+      def draw_data
+        minvalue = min_value
+        fieldheight = field_height
+
+        unit_size = (@graph_width.to_f - font_size*2*right_font ) /
+                        (get_x_labels.max - get_x_labels.min )
+        bargap = bar_gap ? (fieldheight < 10 ? fieldheight / 2 : 10) : 0
+
+        bar_height = fieldheight - bargap
+        bar_height /= @data.length if stack == :side
+        y_mod = (bar_height / 2) + (font_size / 2)
+        
+        field_count = 1
+        @config[:fields].each_index { |i|
+          dataset_count = 0
+          for dataset in @data
+            value = dataset[:data][i]
+            
+            top = @graph_height - (fieldheight * field_count)
+            top += (bar_height * dataset_count) if stack == :side
+            # cases (assume 0 = +ve):
+            #   value  min  length          left
+            #    +ve   +ve  value.abs - min minvalue.abs
+            #    +ve   -ve  value.abs - 0   minvalue.abs
+            #    -ve   -ve  value.abs - 0   minvalue.abs + value
+            length = (value.abs - (minvalue > 0 ? minvalue : 0)) * unit_size
+            left = (minvalue.abs + (value < 0 ? value : 0)) * unit_size
+
+            @graph.add_element( "rect", {
+              "x" => left.to_s,
+              "y" => top.to_s,
+              "width" => length.to_s,
+              "height" => bar_height.to_s,
+              "class" => "fill#{dataset_count+1}"
+            })
+
+            make_datapoint_text( 
+              left+length+5, top+y_mod, value, "text-anchor: start; "
+              )
+            dataset_count += 1
+          end
+          field_count += 1
+        }
+      end
+    end
+  end
+end