svg-graph 1.0.5 → 2.0.1

data/lib/SVG/Graph/Graph.rb

@@ -1,8 +1,7 @@
 begin
   require 'zlib'
-  @@__have_zlib = true
 rescue
-  @@__have_zlib = false
+  # No Zlib.
 end
 
 require 'rexml/document'
@@ -78,9 +77,11 @@ module SVG
       # [scale_integers] false
       # [show_x_title] false
       # [x_title] 'X Field names'
+      # [x_title_location] :middle | :end
       # [show_y_title] false
-      # [y_title_text_direction] :bt
+      # [y_title_text_direction] :bt | :tb
       # [y_title] 'Y Scale'
+      # [y_title_location] :middle | :end
       # [show_graph_title] false
       # [graph_title] 'Graph Title'
       # [show_graph_subtitle] false
@@ -97,19 +98,20 @@ module SVG
       # [key_font_size] 10
       # [no_css] false
       # [add_popups] false
+      # [number_format] '%.2f' 
       def initialize( config )
         @config = config
-        @data = nil
+        @data = []
         self.top_align = self.top_font = self.right_align = self.right_font = 0
 
         init_with({
           :width                => 500,
-          :height                => 300,
+          :height               => 300,
           :show_x_guidelines    => false,
           :show_y_guidelines    => true,
           :show_data_values     => true,
 
-#          :min_scale_value      => 0,
+          :min_scale_value      => nil,
 
           :show_x_labels        => true,
           :stagger_x_labels     => false,
@@ -124,10 +126,12 @@ module SVG
 
           :show_x_title         => false,
           :x_title              => 'X Field names',
+          :x_title_location     => :middle,  # or :end
 
           :show_y_title         => false,
-          :y_title_text_direction => :bt,
+          :y_title_text_direction => :bt,  # other option is :tb
           :y_title              => 'Y Scale',
+          :y_title_location     => :middle,  # or :end
 
           :show_graph_title      => false,
           :graph_title          => 'Graph Title',
@@ -142,12 +146,12 @@ module SVG
           :x_label_font_size    =>12,
           :y_label_font_size    =>12,
           :x_title_font_size    =>14,
-          :y_label_font_size    =>12,
           :y_title_font_size    =>14,
           :key_font_size        =>10,
           
           :no_css               =>false,
           :add_popups           =>false,
+          :number_format        => '%.2f' 
         })
         set_defaults if self.respond_to? :set_defaults
         init_with config
@@ -164,7 +168,7 @@ module SVG
       #     :title => 'Sales 2002'
       #   })
       def add_data conf
-          @data = [] unless (defined? @data and !@data.nil?) 
+        @data = [] unless (defined? @data and !@data.nil?) 
 
         if conf[:data] and conf[:data].kind_of? Array
           @data << conf
@@ -209,7 +213,7 @@ module SVG
         @doc.write( data, 0 )
 
         if @config[:compress]
-          if @@__have_zlib
+          if defined?(Zlib)
             inp, out = IO.pipe
             gz = Zlib::GzipWriter.new( out )
             gz.write data
@@ -222,6 +226,21 @@ module SVG
         
         return data
       end
+      
+      # Burns the graph but returns only the <svg> node as String without the 
+      # Doctype and XML Declaration. This allows easy integration into
+      # existing xml documents.
+      # 
+      # @return [String] the SVG node which represents the Graph
+      def burn_svg_only
+        # initialize all instance variables by burning the graph
+        burn
+        f = REXML::Formatters::Pretty.new(0)
+        f.compact = true
+        out = ''
+        f.write(@root, out)
+        return out
+      end
 
 
       #   Set the height of the graph box, this is the total height
@@ -241,7 +260,7 @@ module SVG
       attr_accessor :style_sheet
       #   (Bool) Show the value of each element of data on the graph
       attr_accessor :show_data_values
-      #   The point at which the Y axis starts, defaults to '0',
+      #   The point at which the Y axis starts, defaults to nil,
       #   if set to nil it will default to the minimum data value.
       attr_accessor :min_scale_value
       #   Whether to show labels on the X axis or not, defaults
@@ -290,6 +309,9 @@ module SVG
       attr_accessor :show_x_title
       #   What the title under X axis should be, e.g. 'Months'.
       attr_accessor :x_title
+      #   Where the x_title should be positioned, either in the :middle of the axis or
+      #   at the :end of the axis. Defaults to :middle
+      attr_accessor :x_title_location
       #   Whether to show the title under the Y axis labels,
       #   default is false, set to true to show.
       attr_accessor :show_y_title
@@ -299,6 +321,9 @@ module SVG
       attr_accessor :y_title_text_direction
       #   What the title under Y axis should be, e.g. 'Sales in thousands'.
       attr_accessor :y_title
+      #   Where the y_title should be positioned, either in the :middle of the axis or
+      #   at the :end of the axis. Defaults to :middle
+      attr_accessor :y_title_location
       #   Whether to show a title on the graph, defaults
       #   to false, set to true to show.
       attr_accessor :show_graph_title
@@ -309,40 +334,51 @@ module SVG
       attr_accessor :show_graph_subtitle
       #   What the subtitle on the graph should be.
       attr_accessor :graph_subtitle
-      #   Whether to show a key, defaults to false, set to
-      #   true if you want to show it.
+      #   Whether to show a key (legend), defaults to true, set to
+      #   false if you want to hide it.
       attr_accessor :key
       #   Where the key should be positioned, defaults to
       #   :right, set to :bottom if you want to move it.
       attr_accessor :key_position
-      # Set the font size (in points) of the data point labels
+      # Set the font size (in points) of the data point labels.
+      # Defaults to 12.
       attr_accessor :font_size
-      # Set the font size of the X axis labels
+      # Set the font size of the X axis labels.
+      # Defaults to 12.
       attr_accessor :x_label_font_size
-      # Set the font size of the X axis title
+      # Set the font size of the X axis title.
+      # Defaults to 14.
       attr_accessor :x_title_font_size
-      # Set the font size of the Y axis labels
+      # Set the font size of the Y axis labels.
+      # Defaults to 12.
       attr_accessor :y_label_font_size
-      # Set the font size of the Y axis title
+      # Set the font size of the Y axis title.
+      # Defaults to 14.
       attr_accessor :y_title_font_size
-      # Set the title font size
+      # Set the title font size.
+      # Defaults to 16.
       attr_accessor :title_font_size
-      # Set the subtitle font size
+      # Set the subtitle font size.
+      # Defaults to 14.
       attr_accessor :subtitle_font_size
-      # Set the key font size
+      # Set the key font size.
+      # Defaults to 10.
       attr_accessor :key_font_size
-      # Show guidelines for the X axis
+      # Show guidelines for the X axis, default is false
       attr_accessor :show_x_guidelines
-      # Show guidelines for the Y axis
+      # Show guidelines for the Y axis, default is true
       attr_accessor :show_y_guidelines
       # Do not use CSS if set to true.  Many SVG viewers do not support CSS, but
       # not using CSS can result in larger SVGs as well as making it impossible to
       # change colors after the chart is generated.  Defaults to false.
       attr_accessor :no_css
-      # Add popups for the data points on some graphs
+      # Add popups for the data points on some graphs, default is false.
       attr_accessor :add_popups
       # Customize popup radius
       attr_accessor :popup_radius
+      # Number format values and Y axis representation like 1.2345667 represent as 1.23,
+      # defaults to '%.2f'
+      attr_accessor :number_format
 
 
       protected
@@ -368,15 +404,15 @@ module SVG
       # of the plot area.  Results in @border_left being set.
       def calculate_left_margin
         @border_left = 7
-        # Check for Y labels
-        max_y_label_height_px = @rotate_y_labels ? 
-          @y_label_font_size :
-          get_y_labels.max{|a,b| 
-            a.to_s.length<=>b.to_s.length
-          }.to_s.length * @y_label_font_size * 0.6
-        @border_left += max_y_label_height_px if @show_y_labels
-        @border_left += max_y_label_height_px + 10 if @stagger_y_labels
-        @border_left += y_title_font_size + 5 if @show_y_title
+        # Check size of Y labels
+        max_y_label_height_px = y_label_font_size
+        if !rotate_y_labels
+          max_y_label_height_px = get_longest_label(get_y_labels).to_s.length * y_label_font_size * 0.6
+        end
+
+        @border_left += max_y_label_height_px if show_y_labels
+        @border_left += max_y_label_height_px + 10 if stagger_y_labels
+        @border_left += y_title_font_size + 5 if (show_y_title && (y_title_location ==:middle))
       end
 
 
@@ -397,6 +433,9 @@ module SVG
           @border_right += KEY_BOX_SIZE
           @border_right += 10    # Some padding around the box
         end
+        if (x_title_location == :end)
+          @border_right = [@border_right, x_title.length * x_title_font_size * 0.6].max 
+        end
       end
 
 
@@ -404,7 +443,7 @@ module SVG
       # of the plot area.  Results in @border_top being set.
       def calculate_top_margin
         @border_top = 5
-        @border_top += title_font_size if show_graph_title
+        @border_top += [title_font_size, y_title_font_size].max if (show_graph_title || (y_title_location ==:end))
         @border_top += 5
         @border_top += subtitle_font_size if show_graph_subtitle
       end
@@ -437,6 +476,18 @@ module SVG
 
       end
 
+      # returns the longest label from an array of labels as string
+      # each object in the array must support .to_s
+      def get_longest_label(arry)
+        longest_label = arry.max{|a,b| 
+              # respect number_format
+              a = @number_format % a if numeric?(a) 
+              b = @number_format % b if numeric?(b)
+              a.to_s.length <=> b.to_s.length
+            }
+        longest_label = @number_format % longest_label if numeric?(longest_label)
+        return longest_label
+      end
       
       # Override this (and call super) to change the margin to the bottom
       # of the plot area.  Results in @border_bottom being set.
@@ -447,15 +498,15 @@ module SVG
           @border_bottom += 10
         end
         if show_x_labels
-		  max_x_label_height_px = (not rotate_x_labels) ? 
-            x_label_font_size :
-            get_x_labels.max{|a,b| 
-              a.to_s.length<=>b.to_s.length
-            }.to_s.length * x_label_font_size * 0.6
+          max_x_label_height_px = x_label_font_size
+          if rotate_x_labels     
+            max_x_label_height_px = get_longest_label(get_x_labels).to_s.length * x_label_font_size * 0.6
+          end
+
           @border_bottom += max_x_label_height_px
           @border_bottom += max_x_label_height_px + 10 if stagger_x_labels
         end
-        @border_bottom += x_title_font_size + 5 if show_x_title
+        @border_bottom += x_title_font_size + 5 if (show_x_title && (x_title_location ==:middle))
       end
 
 
@@ -496,21 +547,30 @@ module SVG
       def x_label_offset( width )
         0
       end
+      
+      # check if an object can be converted to float
+      def numeric?(object)
+        true if Float(object) rescue false
+      end
 
       def make_datapoint_text( x, y, value, style="" )
         if show_data_values
+          textStr = value
+          if( numeric?(value) )
+            textStr = @number_format % value
+          end
           @foreground.add_element( "text", {
             "x" => x.to_s,
             "y" => y.to_s,
             "class" => "dataPointLabel",
             "style" => "#{style} stroke: #fff; stroke-width: 2;"
-          }).text = value.to_s
+          }).text = textStr 
           text = @foreground.add_element( "text", {
             "x" => x.to_s,
             "y" => y.to_s,
             "class" => "dataPointLabel"
           })
-          text.text = value.to_s
+          text.text = textStr
           text.attributes["style"] = style if style.length > 0
         end
       end
@@ -611,7 +671,11 @@ module SVG
               "y" => y.to_s,
               "class" => "yAxisLabels"
             })
-            text.text = label.to_s
+            textStr = label.to_s
+            if( numeric?(label) )
+              textStr = @number_format % label
+            end
+            text.text = textStr
             if rotate_y_labels
               text.attributes["transform"] = "translate( -#{font_size} 0 ) "+
                 "rotate( 90 #{x} #{y} ) "
@@ -661,7 +725,7 @@ module SVG
 
         if show_graph_subtitle
           y_subtitle = show_graph_title ? 
-            title_font_size + 10 :
+            title_font_size + subtitle_font_size + 5 :
             subtitle_font_size
           @root.add_element("text", {
             "x" => (width / 2).to_s,
@@ -672,11 +736,16 @@ module SVG
 
         if show_x_title
           y = @graph_height + @border_top + x_title_font_size
-          if show_x_labels
-            y += x_label_font_size + 5 if stagger_x_labels
-            y += x_label_font_size + 5
+          if (x_title_location == :end)
+            y = y - x_title_font_size/2.0
+            x = width - x_title.length * x_title_font_size * 0.6/2.0
+          else
+            x = width / 2
+            if show_x_labels
+              y += x_label_font_size + 5 if stagger_x_labels
+              y += x_label_font_size + 5
+            end
           end
-          x = width / 2
 
           @root.add_element("text", {
             "x" => x.to_s,
@@ -687,21 +756,29 @@ module SVG
 
         if show_y_title
           x = y_title_font_size + (y_title_text_direction==:bt ? 3 : -3)
-          y = height / 2
-
+          if (y_title_location == :end)
+            x = y_title.length * y_title_font_size * 0.6/2.0 # positioning is not optimal but ok for now
+            y = @border_top - y_title_font_size/2.0
+          else
+            y = height / 2
+          end
           text = @root.add_element("text", {
             "x" => x.to_s,
             "y" => y.to_s,
             "class" => "yAxisTitle",
           })
           text.text = y_title.to_s
-          if y_title_text_direction == :bt
-            text.attributes["transform"] = "rotate( -90, #{x}, #{y} )"
-          else
-            text.attributes["transform"] = "rotate( 90, #{x}, #{y} )"
+          # only rotate text if it is at the middle left of the y-axis
+          # ignore the text_direction if y_title_location is set to :end
+          if (y_title_location != :end)
+            if y_title_text_direction == :bt
+              text.attributes["transform"] = "rotate( -90, #{x}, #{y} )"
+            else
+              text.attributes["transform"] = "rotate( 90, #{x}, #{y} )"
+            end
           end
         end
-      end
+      end # draw_titles
 
       def keys 
         i = 0
@@ -739,11 +816,11 @@ module SVG
             x_offset = @border_left + 20
             y_offset = @border_top + @graph_height + 5
             if show_x_labels
-			  max_x_label_height_px = (not rotate_x_labels) ? 
-				x_label_font_size :
-				get_x_labels.max{|a,b| 
-				  a.to_s.length<=>b.to_s.length
-				}.to_s.length * x_label_font_size * 0.6
+              max_x_label_height_px = (not rotate_x_labels) ? 
+              x_label_font_size :
+              get_x_labels.max{|a,b| 
+                a.to_s.length<=>b.to_s.length
+              }.to_s.length * x_label_font_size * 0.6
                 x_label_font_size
               y_offset += max_x_label_height_px
               y_offset += max_x_label_height_px + 5 if stagger_x_labels
@@ -973,8 +1050,8 @@ module SVG
 }
 /* End copy for external style sheet */
 EOL
-      end
+      end # get_style
 
-    end
-  end
-end
+    end # class Graph
+  end # module Graph
+end # module SVG

data/lib/SVG/Graph/Line.rb

@@ -1,4 +1,4 @@
-require 'SVG/Graph/Graph'
+require_relative 'Graph'
 
 module SVG
   module Graph

data/lib/SVG/Graph/Pie.rb

@@ -1,4 +1,4 @@
-require 'SVG/Graph/Graph'
+require_relative 'Graph'
 
 module SVG
   module Graph
@@ -205,9 +205,9 @@ module SVG
 
         total = 0
         max_value = 0
-        @data.each {|x| 
+        @data.each {|x|
           max_value = max_value < x ? x : max_value
-          total += x 
+          total += x
         }
         percent_scale = 100.0 / total
 
@@ -216,56 +216,85 @@ module SVG
         @config[:fields].each_index { |count|
           value = @data[count]
           percent = percent_scale * value
-
           radians = prev_percent * rad_mult
-          x_start = radius+(Math.sin(radians) * radius)
-          y_start = radius-(Math.cos(radians) * radius)
-          radians = (prev_percent+percent) * rad_mult
-          x_end = radius+(Math.sin(radians) * radius)
-          x_end -= 0.00001 if @data.length == 1
-          y_end = radius-(Math.cos(radians) * radius)
-          path = "M#{radius},#{radius} L#{x_start},#{y_start} "+
-            "A#{radius},#{radius} "+
-            "0, #{percent >= 50 ? '1' : '0'},1, "+
-            "#{x_end} #{y_end} Z"
-
-
-          wedge = @foreground.add_element( "path", {
-            "d" => path,
-            "class" => "fill#{count+1}"
-          })
-
-          translate = nil
-          tx = 0
-          ty = 0
-          half_percent = prev_percent + percent / 2
-          radians = half_percent * rad_mult
-
-          if show_shadow
-            shadow = background.add_element( "path", {
-              "d" => path,
-              "filter" => "url(#dropshadow)",
-              "style" => "fill: #ccc; stroke: none;"
+
+          if percent == 100.0
+            @foreground.add_element( "circle", {
+              "cx" => radius.to_s,
+              "cy" => radius.to_s,
+              "r" => radius.to_s,
+              "class" => "fill1"
             })
-            clear = midground.add_element( "path", {
+
+            if show_shadow
+              shadow = background.add_element( "circle", {
+                "cx" => radius.to_s,
+                "cy" => radius.to_s,
+                "r" => radius.to_s,
+                "filter" => "url(#dropshadow)",
+                "style" => "fill: #ccc; stroke: none;"
+              })
+              clear = midground.add_element( "circle", {
+                "cx" => radius.to_s,
+                "cy" => radius.to_s,
+                "r" => radius.to_s,
+                "style" => "fill: #fff; stroke: none;"
+              })
+              shadow.attributes["transform"] =
+                "translate( #{shadow_offset} #{shadow_offset} )"
+            end
+          else
+            x_start = radius+(Math.sin(radians) * radius)
+            y_start = radius-(Math.cos(radians) * radius)
+            radians = (prev_percent+percent) * rad_mult
+            x_end = radius+(Math.sin(radians) * radius)
+            x_end -= 0.00001 if @data.length == 1
+            y_end = radius-(Math.cos(radians) * radius)
+            path = "M#{radius},#{radius} L#{x_start},#{y_start} "+
+              "A#{radius},#{radius} "+
+              "0, #{percent >= 50 ? '1' : '0'},1, "+
+              "#{x_end} #{y_end} Z"
+
+
+            wedge = @foreground.add_element( "path", {
               "d" => path,
-              "style" => "fill: #fff; stroke: none;"
+              "class" => "fill#{count+1}"
             })
-          end
 
-          if expanded or (expand_greatest && value == max_value)
-            tx = (Math.sin(radians) * expand_gap)
-            ty = -(Math.cos(radians) * expand_gap)
-            translate = "translate( #{tx} #{ty} )"
-            wedge.attributes["transform"] = translate
-            clear.attributes["transform"] = translate if clear
-          end
+            translate = nil
+            tx = 0
+            ty = 0
+            half_percent = prev_percent + percent / 2
+            radians = half_percent * rad_mult
+
+            if show_shadow
+              shadow = background.add_element( "path", {
+                "d" => path,
+                "filter" => "url(#dropshadow)",
+                "style" => "fill: #ccc; stroke: none;"
+              })
+              clear = midground.add_element( "path", {
+                "d" => path,
+                "style" => "fill: #fff; stroke: none;"
+              })
+            end
 
-          if show_shadow
-            shadow.attributes["transform"] = 
-              "translate( #{tx+shadow_offset} #{ty+shadow_offset} )"
+            if expanded or (expand_greatest && value == max_value)
+              tx = (Math.sin(radians) * expand_gap)
+              ty = -(Math.cos(radians) * expand_gap)
+              translate = "translate( #{tx} #{ty} )"
+              wedge.attributes["transform"] = translate
+              clear.attributes["transform"] = translate if clear
+            end
+
+            if show_shadow
+              shadow.attributes["transform"] =
+                "translate( #{tx+shadow_offset} #{ty+shadow_offset} )"
+            end
+
+            prev_percent += percent
           end
-          
+
           if show_data_labels and value != 0
             label = ""
             label += @config[:fields][count] if show_key_data_labels
@@ -293,11 +322,9 @@ module SVG
               "class" => "dataPointLabel",
             }).text = label.to_s
           end
-
-          prev_percent += percent
         }
       end
-      
+
 
       def round val, to
         up = 10**to.to_f