svg-graph 2.0.2.beta → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d856850b800bff5e1688e0ad450ccbcc21bdd21d
-  data.tar.gz: 095e8398439866cc6cd52439d60d036ef960ac8a
+  metadata.gz: 7101e9e0d576c758450907b8f9d30bf2b8c787ee
+  data.tar.gz: c370f0c3b179587d0e4bf34d4862f4c1a0366dce
 SHA512:
-  metadata.gz: 69d1f607ba2edec2452d14e39fdb18079bc59a76c52898e101d7adff4c383d8ae40c589e45a001eb3b50912bd2d46af6ac89e4d1b9a9a68f87968a8cf2382877
-  data.tar.gz: 2cb188581fe18553a4c1a2527168f4d4988cf2b47dd6577dadf248b4d93fe09d26608f164bdca8fddb9d97ee9feece347b1287ee8fef12e325245a11d63b05d6
+  metadata.gz: da39453fcbd961e3b8758da1b7a5ed49f9fa6142f598151de6625e7294ca3ffc2689aca19110841a6f598bf23305ab85daaf2f5b2d59a03f29b3204d96c2ecc2
+  data.tar.gz: 58a9de11f45ce90ffbf7600b4d82a0b26b27f4b6598e016221bc838fa074cd7aaaecad537aa7cd69fbcae33d03f4c6da432883b890775dfd9db24900c1c39f3e

data/History.txt

@@ -1,16 +1,18 @@
-TODO
-* fix axis titles positioning for staggered axis (prevent overlap)
-* fix scale_integer
-* fix sorting and connected lines for Plot
+TODO / Backlog
+* add unit tests for all types of graphs
+* refactor various hardcoded constant pixel offsets in Graph class to use named constants or variables
 
 
-=== 2.0.2 work in progress
+=== 2.0.2 / 2016-10-24 [lumean]
 * fix axis-title positioning
 * fix/add support for popups of values line, plot, bar graph
 * Line,Plot,Pie graph support nil values (or pairs of nil for plot) for non-present datapoints
-* changed text anchor of first datapoint label to avoid overlap with axis
-* fix pie graph key overlapping the graph
-*
+* fix show datapoint labels: changed text anchor of first datapoint label to avoid overlap with axis
+  and text anchor of last datapoint label
+* fix pie graph key overlapping the graph [thanks adamalbrecht for reporting]
+* fix axis titles positioning for staggered axis (prevent overlap)
+* fix axis labels and positioning when scale_integers is true and min value is not integer.
+* added various comments in the code to be better understandable (for me)
 
 === 2.0.1 / 2016-08-09
 * dropped support for ruby 1.8.7 [lumean]

data/README.markdown

@@ -78,18 +78,27 @@ File.open('bar.svg', 'w') {|f| f.write(g.burn_svg_only)}
 
 ### ErrBar
 
+![example err_bar graph](https://cdn.rawgit.com/lumean/svg-graph2/master/examples/err_bar.svg)
+
 ### Line
 
 ![example line graph](https://cdn.rawgit.com/lumean/svg-graph2/master/examples/line.svg)
 
 ### Pie
 
+![example pie graph](https://cdn.rawgit.com/lumean/svg-graph2/master/examples/pie.svg)
+
 ### Plot
 
+![example plot graph](https://cdn.rawgit.com/lumean/svg-graph2/master/examples/plot.svg)
+
 ### Schedule
 
+![example schedule graph](https://cdn.rawgit.com/lumean/svg-graph2/master/examples/schedule.svg)
+
 ### TimeSeries
 
+![example timeseries graph](https://cdn.rawgit.com/lumean/svg-graph2/master/examples/timeseries.svg)
 
 Also have a look at the original [SVG::Graph web page](http://www.germane-software.com/software/SVG/SVG::Graph/), but note that this repository has already added some additional functionality, not available with the original.
 

data/lib/SVG/Graph/Bar.rb

@@ -58,12 +58,6 @@ module SVG
     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
@@ -74,9 +68,13 @@ module SVG
         maxvalue = max_value
         minvalue = min_value
         range = maxvalue - minvalue
-
-        top_pad = range == 0 ? 10 : range / 20.0
-        scale_range = (maxvalue + top_pad) - minvalue
+        # add some padding on top of the graph
+        if range == 0
+          maxvalue += 10
+        else
+          maxvalue += range / 20.0
+        end
+        scale_range = maxvalue - minvalue
 
         @y_scale_division = scale_divisions || (scale_range / 10.0)
 
@@ -100,14 +98,11 @@ module SVG
         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)
         unit_size = field_height
         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
 

data/lib/SVG/Graph/BarBase.rb

@@ -40,6 +40,13 @@ module SVG
       attr_accessor :stack
       protected
       
+      # space in px between x-labels, we override the Graph version because
+      # we need the extra space (i.e. don't subtract 1 from get_x_labels.length)
+      def field_width
+        # don't use -1 otherwise bar is out of bounds        
+        @graph_width.to_f / ( get_x_labels.length )
+      end
+      
       def max_value
         @data.collect{|x| x[:data].max}.max
       end

data/lib/SVG/Graph/BarHorizontal.rb

@@ -86,9 +86,9 @@ module SVG
         end
 
         rv = []
-        if maxvalue%@x_scale_division != 0
-          maxvalue = maxvalue + @x_scale_division
-        end
+        #if maxvalue%@x_scale_division != 0
+        #  maxvalue = maxvalue + @x_scale_division
+        #end
         minvalue.step( maxvalue, @x_scale_division ) {|v| rv << v}
         return rv
       end
@@ -104,10 +104,7 @@ module SVG
       def draw_data
         minvalue = min_value
         fieldheight = field_height
-        # number of steps in px between x-labels
-        # unit_size = (@graph_width.to_f - font_size*2*right_font ) /
-        #                 (get_x_labels.max - get_x_labels.min )
-        unit_size = field_width
+
         bargap = bar_gap ? (fieldheight < 10 ? fieldheight / 2 : 10) : 0
 
         bar_height = fieldheight - bargap
@@ -118,7 +115,7 @@ module SVG
         @config[:fields].each_index { |i|
           dataset_count = 0
           for dataset in @data
-            value = dataset[:data][i]/@x_scale_division
+            value = dataset[:data][i]
             
             top = @graph_height - (fieldheight * field_count)
             top += (bar_height * dataset_count) if stack == :side
@@ -127,8 +124,8 @@ module SVG
             #    +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
+            length = (value.abs - (minvalue > 0 ? minvalue : 0))/@x_scale_division.to_f * field_width
+            left = (minvalue.abs + (value < 0 ? value : 0))/@x_scale_division.to_f * field_width
 
             @graph.add_element( "rect", {
               "x" => left.to_s,

data/lib/SVG/Graph/DataPoint.rb

@@ -1,3 +1,4 @@
+# Allows to customize datapoint shapes
 class DataPoint
   OVERLAY = "OVERLAY" unless defined?(OVERLAY)
   DEFAULT_SHAPE = lambda{|x,y,line| ["circle", {
@@ -8,24 +9,58 @@ class DataPoint
         }]
       } unless defined? DEFAULT_SHAPE
   CRITERIA = [] unless defined? CRITERIA
+  
+  # matchers are class scope. Once configured, each DataPoint instance will have
+  # access to the same matchers
+  # @param matchers [Array] multiple arrays of the following form:
+  #     [ regex , 
+  #       lambda taking three arguments (x,y, line_number for css)
+  #         -> return value of the lambda must be an array: [svg tag name,  Hash with attributes for the svg tag, e.g. "points" and "class"]
+  #     ]
+  # @example
+  #   DataPoint.configure_shape_criteria(
+  #     [/.*/, lambda{|x,y,line| ['polygon', {
+  #       "points" => "#{x-1.5},#{y+2.5} #{x+1.5},#{y+2.5} #{x+1.5},#{y-2.5} #{x-1.5},#{y-2.5}",
+  #       "class" => "dataPoint#{line}"
+  #       }]
+  #     }]
+  #   )
   def DataPoint.configure_shape_criteria(*matchers)
     CRITERIA.push(*matchers)
   end
+  
+  # 
   def DataPoint.reset_shape_criteria
     CRITERIA.clear
   end
 
+  # creates a new DataPoint
+  # @param x [Numeric] x coordinates of the point
+  # @param y [Numeric] y coordinates of the point
+  # @param line [Fixnum] line index of the current dataset (e.g. when multiple times Graph.add_data()), can be used to reference to the correct css class
   def initialize(x, y, line)
     @x = x
     @y = y
     @line = line
   end
+  
+  # @return [Array<Array>] see example
+  # @example Return value
+  #   # two dimensional array, the splatted (*) inner array can be used as argument to REXML::add_element
+  #   [["svgtag",  {"points" => "", "class"=> "dataPoint#{line}" } ], ["svgtag", {"points"=>"", "class"=> ""}], ...]
+  # @exmple Usage
+  #   dp = DataPoint.new(x, y, line).shape(data[:description])
+  #   # for each svg we insert it to the graph
+  #   dp.each {|s| @graph.add_element( *s )}
+  #
   def shape(description=nil)
+    # select all criteria with size 2, and collect rendered lambdas in an array 
     shapes = CRITERIA.select {|criteria|
       criteria.size == 2
     }.collect {|regexp, proc|
       proc.call(@x, @y, @line) if description =~ regexp
     }.compact
+    # if above did not render anything use the defalt shape
     shapes = [DEFAULT_SHAPE.call(@x, @y, @line)] if shapes.empty?
 
     overlays = CRITERIA.select { |criteria|

data/lib/SVG/Graph/ErrBar.rb

@@ -8,19 +8,29 @@ module SVG
     #
     # = Synopsis
     #
-    #   require 'SVG/Graph/Bar'
+    #   require 'SVG/Graph/ErrBar'
     #
-    #   fields = %w(Jan Feb Mar);
-    #   data_sales_02 = [12, 45, 21]
-    #
-    #   graph = SVG::Graph::Bar.new(
+    #   fields = %w(Jan Feb);
+    #   myarr1_mean = 10
+    #   myarr1_confidence = 1
+    #   
+    #   myarr2_mean = 20
+    #   myarr2_confidence = 2
+    #   
+    #   data= [myarr1_mean, myarr2_mean]
+    #   
+    #   err_mesure = [myarr1_confidence, myarr2_confidence]
+    #   
+    #   graph = SVG::Graph::ErrBar.new(
     #     :height => 500,
-    #     :width => 300,
-    #     :fields => fields
+    #     :width => 600,
+    #     :fields => fields,
+    #     :errorBars => err_mesure,
+    #     :scale_integers => true,
     #   )
-    #
+    #   
     #   graph.add_data(
-    #     :data => data_sales_02,
+    #     :data => data,
     #     :title => 'Sales 2002'
     #   )
     #
@@ -58,19 +68,15 @@ module SVG
     class ErrBar < BarBase
       include REXML
 
-        def initialize config
-            raise "fields was not supplied or is empty" unless config[:errorBars] &&
-            config[:errorBars].kind_of?(Array) &&
-            config[:errorBars].length > 0 
-            super
-        end 
-
-
-      # See Graph::initialize and BarBase::set_defaults
-      def set_defaults 
-        super
-        # self.top_align = self.top_font = 1
-      end
+      def initialize config
+          raise "fields was not supplied or is empty" unless config[:errorBars] &&
+          config[:errorBars].kind_of?(Array) &&
+          config[:errorBars].length > 0 
+          super
+      end 
+      # Array of confidence values for each item in :fields. A range from 
+      # value[i]-errorBars[i] to value[i]+errorBars[i] is drawn into the graph.
+      attr_accessor :errorBars
 
       protected
 
@@ -82,20 +88,24 @@ module SVG
         maxvalue = max_value
         minvalue = min_value
         range = maxvalue - minvalue
+        # add some padding on top of the graph
+        if range == 0
+          maxvalue += 10
+        else
+          maxvalue += range / 20.0
+        end
+        scale_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)
+        @y_scale_division = scale_divisions || (scale_range / 10.0)
 
         if scale_integers
-          scale_division = scale_division < 1 ? 1 : scale_division.round
+          @y_scale_division = @y_scale_division < 1 ? 1 : @y_scale_division.round
         end
 
         rv = []
-        maxvalue = maxvalue%scale_division == 0 ? 
-          maxvalue : maxvalue + scale_division
-        minvalue.step( maxvalue, scale_division ) {|v| rv << v}
+        maxvalue = maxvalue%@y_scale_division == 0 ? 
+          maxvalue : maxvalue + @y_scale_division
+        minvalue.step( maxvalue, @y_scale_division ) {|v| rv << v}
         return rv
       end
 
@@ -107,13 +117,11 @@ module SVG
         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)
+        unit_size = field_height
         bargap = bar_gap ? (fieldwidth < 10 ? fieldwidth / 2 : 10) : 0
 
         bar_width = fieldwidth - (bargap *2)
         bar_width /= @data.length if stack == :side
-        #x_mod = (@graph_width-bargap)/2 - (stack==:side ? bar_width/2 : 0)
  
         bottom = @graph_height
 
@@ -128,7 +136,7 @@ module SVG
             #    +ve   -ve  value - 0
             #    -ve   -ve  value.abs - 0
           
-            value = dataset[:data][i]
+            value = dataset[:data][i].to_f/@y_scale_division
             
             left = (fieldwidth * field_count)
             left += bargap
@@ -147,13 +155,11 @@ module SVG
               "class" => "fill#{dataset_count+1}"
             })
 
-		
-			
-			threshold = @config[:errorBars][i] * unit_size
-			middlePointErr = left+bar_width/2
-			upperErr = top+threshold
-			bottomErr = top-threshold
-			withthErr = bar_width/4
+            threshold = @config[:errorBars][i].to_f/@y_scale_division * unit_size
+            middlePointErr = left+bar_width/2
+            upperErr = top+threshold
+            bottomErr = top-threshold
+            withthErr = bar_width/4
 			
             @graph.add_element( "line", {
               "x1" => middlePointErr.to_s,
@@ -178,12 +184,14 @@ module SVG
               "style" => "stroke:rgb(0,0,0);stroke-width:1"
             })
             
-            make_datapoint_text(left + bar_width/2.0, top - 6, value.to_s)
+            make_datapoint_text(left + bar_width/2.0, top - 6, dataset[:data][i].to_s)
+            add_popup(left + bar_width/2.0, top , dataset[:data][i].to_s)
             dataset_count += 1
           end
           field_count += 1
-        }
-      end
-    end
+        } # config[:fields].each_index
+      end # draw_data
+      
+    end # ErrBar
   end
 end

data/lib/SVG/Graph/Graph.rb

@@ -198,11 +198,7 @@ module SVG
       # 
       def burn
         raise "No data available" unless @data.size > 0
-        
-        # undocumented and not used in any sublass
-        # to be removed
-        #calculations if methods.include? 'calculations'
-
+       
         start_svg
         calculate_graph_dimensions
         @foreground = Element.new( "g" )
@@ -381,7 +377,8 @@ module SVG
       # Customize popup radius
       attr_accessor :popup_radius
       # Number format values and Y axis representation like 1.2345667 represent as 1.23,
-      # defaults to '%.2f'
+      # Any valid format accepted by sprintf can be specified.
+      # If you don't want to change the format in any way you can use "%s". Defaults to "%.2f"
       attr_accessor :number_format
 
 
@@ -402,9 +399,6 @@ module SVG
         @popup_radius ||= 10
       end
 
-      # unknown why needed
-      # attr_accessor :top_align, :top_font, :right_align, :right_font
-
       # size of the square box in the legend which indicates the colors
       KEY_BOX_SIZE = 12
 
@@ -431,7 +425,7 @@ module SVG
         else
           max_width = y_label_font_size + 3
         end
-        max_width += 10 if stagger_y_labels
+        max_width += 5 + y_label_font_size if stagger_y_labels
         return max_width
       end
 
@@ -501,8 +495,8 @@ module SVG
             "onmouseout" => 
               "document.getElementById(#{t.object_id}).setAttribute('visibility', 'hidden' )",
           })
-        end # add_popups
-      end
+        end # if add_popups
+      end # add_popup
 
       # returns the longest label from an array of labels as string
       # each object in the array must support .to_s
@@ -543,7 +537,7 @@ module SVG
         else
           max_height = x_label_font_size + 3
         end
-        max_height += 10 if stagger_x_labels
+        max_height += 5 + x_label_font_size if stagger_x_labels
         return max_height
       end
 
@@ -598,9 +592,11 @@ module SVG
           if( numeric?(value) )
             textStr = @number_format % value
           end
-          # change anchor is label overlaps axis
-          if x < textStr.length/2 * font_size * 0.6
+          # change anchor is label overlaps axis, normally anchor is middle (that's why we compute length/2)
+          if x < textStr.length/2 * font_size
             style << "text-anchor: start;"
+          elsif x > @graph_width - textStr.length/2 * font_size
+            style << "text-anchor: end;"
           end
           # white background for better readability
           @foreground.add_element( "text", {
@@ -694,9 +690,9 @@ module SVG
       
       # space in px between x-labels
       def field_width
-        #(@graph_width.to_f - font_size*2*right_font) /
-        #   (get_x_labels.length - right_align)
-        @graph_width.to_f / get_x_labels.length
+        # -1 is to use entire x-axis
+        # otherwise there is always 1 division unused        
+        @graph_width.to_f / ( get_x_labels.length - 1 )
       end
 
       # space in px between the y-labels
@@ -880,14 +876,7 @@ 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
-              #   x_label_font_size
               y_offset += max_x_label_height_px
-              y_offset += max_x_label_height_px + 5 if stagger_x_labels
             end
             y_offset += x_title_font_size + 5 if show_x_title
           end

data/lib/SVG/Graph/Line.rb

@@ -104,7 +104,6 @@ module SVG
           :stacked            => false,
           :area_fill          => false
         )
-      # self.top_align = self.top_font = self.right_align = self.right_font = 1
       end
 
       protected
@@ -157,29 +156,26 @@ module SVG
       def get_y_labels
         maxvalue = max_value
         minvalue = min_value
-        #
         range = maxvalue - minvalue
+        # add some padding on top of the graph
         if range == 0
-          top_pad = 10
+          maxvalue += 10
         else
-          top_pad = range / 20.0
+          maxvalue += range / 20.0
         end
-        scale_range = (maxvalue + top_pad) - minvalue
+        scale_range = maxvalue - minvalue
 
         @y_scale_division = scale_divisions || (scale_range / 10.0)
-
+        @y_offset = 0
+        
         if scale_integers
-          # only use integers if there will be at least 3 labels and division is > 0.5
-          if maxvalue/@y_scale_division >= 3 && @y_scale_division > 0.5
-            @y_scale_division = @y_scale_division.round
-          end
+          @y_scale_division = @y_scale_division < 1 ? 1 : @y_scale_division.round
+          @y_offset = (minvalue.to_f - minvalue.floor).to_f
+          minvalue = minvalue.floor
         end
 
         rv = []
-        # make sure we have at least one label higher than the max_value
-        if maxvalue%@y_scale_division != 0
-          maxvalue = maxvalue + @y_scale_division
-        end 
+
         minvalue.step( maxvalue, @y_scale_division ) {|v| rv << v}
         return rv
       end
@@ -187,20 +183,19 @@ module SVG
       def calc_coords(field, value, width = field_width, height = field_height)
         coords = {:x => 0, :y => 0}
         coords[:x] = width * field
-        coords[:y] = @graph_height - value/@y_scale_division * height
-      
+        # make sure we do float division, otherwise coords get messed up
+        coords[:y] = @graph_height - (value + @y_offset)/@y_scale_division.to_f * height
         return coords
       end
 
       def draw_data
         minvalue = min_value
-        #fieldheight = (@graph_height.to_f - font_size*2*top_font) / 
-        #                 (get_y_labels.max - get_y_labels.min)
         fieldheight = field_height
         fieldwidth = field_width
         line = @data.length
-
-        prev_sum = Array.new(@config[:fields].length).fill(0)
+        # always zero for filling areas
+        prev_sum = Array.new(@config[:fields].length).fill(-@y_offset)
+        # cumulated sum (used for stacked graphs)
         cum_sum = Array.new(@config[:fields].length).fill(nil)
 
         for data in @data.reverse
@@ -234,7 +229,7 @@ module SVG
               c = calc_coords(0, prev_sum[0], fieldwidth, fieldheight)
             else
               apath = "V#@graph_height"
-              c = calc_coords(0, 0, fieldwidth, fieldheight)
+              c = calc_coords(0, -@y_offset, fieldwidth, fieldheight)
             end
               
             @graph.add_element("path", {
@@ -255,18 +250,13 @@ module SVG
               c = calc_coords(i, cum_sum[i], fieldwidth, fieldheight)
               if show_data_points
                 @graph.add_element( "circle", {
-                  # "cx" => (fieldwidth * i).to_s,
-                  # "cy" => (@graph_height - cum_sum[i] * fieldheight).to_s,
                   "cx" => c[:x].to_s,
                   "cy" => c[:y].to_s,
                   "r" => "2.5",
                   "class" => "dataPoint#{line}"
                 })
               end
-              #x = fieldwidth * i
-              #y = @graph_height - cum_sum[i] * fieldheight
-              #make_datapoint_text( x, y - font_size/2, cum_sum[i] + minvalue)
-              #add_popup(x, y, cum_sum[i] + minvalue)
+
               make_datapoint_text( c[:x], c[:y] - font_size/2, cum_sum[i] + minvalue)
               add_popup(c[:x], c[:y], cum_sum[i] + minvalue)
             end

data/lib/SVG/Graph/Pie.rb

@@ -204,7 +204,6 @@ module SVG
         diameter -= 10 if show_shadow
         radius = diameter / 2.0
 
-        #xoff = (width - diameter) / 2
         xoff = (@graph_width - diameter) / 2
         yoff = (height - @border_bottom - diameter)
         yoff -= 10 if show_shadow
@@ -224,7 +223,7 @@ module SVG
         prev_percent = 0
         rad_mult = 3.6 * RADIANS
         @config[:fields].each_index { |count|
-          value = @data[count]
+          value = @data[count].to_f
           percent = percent_scale * value
           radians = prev_percent * rad_mult
 

data/lib/SVG/Graph/Plot.rb

@@ -67,8 +67,11 @@ module SVG
     #
     # Unlike the other types of charts, data sets must contain x,y pairs:
     #
-    #   [ 1, 2 ]    # A data set with 1 point: (1,2)
-    #   [ 1,2, 5,6] # A data set with 2 points: (1,2) and (5,6)  
+    #   [ 1,2 ]    # A data set with 1 point: (1,2)
+    #   [ 1,2, 5,6] # A data set with 2 points: (1,2) and (5,6)
+    # Additional possible notation
+    #   [ [1,2], 5,6] # A data set with 2 points: (1,2) and (5,6), mixed notation
+    #   [ [1,2], [5,6]] # A data set with 2 points: (1,2) and (5,6), nested array
     # 
     # = See also
     # 
@@ -89,20 +92,21 @@ module SVG
     class Plot < Graph
 
       # In addition to the defaults set by Graph::initialize, sets
-      # [show_data_values] true
       # [show_data_points] true
       # [area_fill] false
-      # [stacked] false
+      # [stacked] false, will not have any effect if true
+      # [show_lines] true
+      # [round_popups] true
       def set_defaults
         init_with(
-                  :show_data_values  => true,
-                  :show_data_points  => true,
-                  :area_fill         => false,
-                  :stacked           => false,
-                  :show_lines        => true,
-                  :round_popups      => true
-                 )
-                 # self.top_align = self.right_align = self.top_font = self.right_font = 1
+          :show_data_points  => true,
+          :area_fill         => false,
+          :stacked           => false,
+          :show_lines        => true,
+          :round_popups      => true,
+          :scale_x_integers  => false,
+          :scale_y_integerrs => false,
+         )
       end
 
       # Determines the scaling for the X axis divisions.
@@ -111,6 +115,7 @@ module SVG
       #
       # would cause the graph to attempt to generate labels stepped by 2; EG:
       # 0,2,4,6,8...
+      # default is automatic such that there are 10 labels
       attr_accessor :scale_x_divisions
       # Determines the scaling for the Y axis divisions.
       #
@@ -118,33 +123,38 @@ module SVG
       #
       # would cause the graph to attempt to generate labels stepped by 0.5; EG:
       # 0, 0.5, 1, 1.5, 2, ...
+      # default is automatic such that there are 10 labels
       attr_accessor :scale_y_divisions 
-      # Make the X axis labels integers
+      # Make the X axis labels integers, default: false
       attr_accessor :scale_x_integers 
-      # Make the Y axis labels integers
+      # Make the Y axis labels integers, default: false
       attr_accessor :scale_y_integers 
-      # Fill the area under the line
+      # Fill the area under the line, default: false
       attr_accessor :area_fill 
       # Show a small circle on the graph where the line
-      # goes from one point to the next.
+      # goes from one point to the next. default: true
       attr_accessor :show_data_points
-      # Set the minimum value of the X axis
+      # Set the minimum value of the X axis, if nil the minimum from data is chosen, default: nil
       attr_accessor :min_x_value 
-      # Set the maximum value of the X axis
+      # Set the maximum value of the X axis, if nil the maximum from data is chosen, default: nil
       attr_accessor :max_x_value 
-      # Set the minimum value of the Y axis
+      # Set the minimum value of the Y axis, if nil the minimum from data is chosen, default: nil
       attr_accessor :min_y_value
-      # Set the maximum value of the Y axis
+      # Set the maximum value of the Y axis, if nil the maximum from data is chosen, default: nil
       attr_accessor :max_y_value
-      # Show lines connecting data points
+      # Show lines connecting data points, default: true
       attr_accessor :show_lines
-      # Round value of data points in popups to integer
+      # Round value of data points in popups to integer, default: true
       attr_accessor :round_popups
 
 
       # Adds data to the plot.  The data must be in X,Y pairs; EG
       #   data_set1 = [ 1, 2 ]    # A data set with 1 point: (1,2)
-      #   data_set2 = [ 1,2, 5,6] # A data set with 2 points: (1,2) and (5,6) 
+      #   data_set2 = [ 1,2, 5,6] # A data set with 2 points: (1,2) and (5,6)
+      # It's also supported to supply nested array or a mix (flatten is applied to the array); EG
+      #   data_set2 = [[1,2], 5,6]
+      # or
+      #   data_set2 = [[1,2], [5,6]]
       #   
       #   graph.add_data({
       #     :data => data_set1,
@@ -156,13 +166,18 @@ module SVG
       #   })         
       def add_data(conf)
 	      @data ||= []
-        # remove nil values
-        conf[:data] = conf[:data].compact
         raise "No data provided by #{conf.inspect}" unless conf[:data] and
           conf[:data].kind_of? Array
+        # support array of arrays and flatten it
+        conf[:data] = conf[:data].flatten
+        # check that we have pairs of values
         raise "Data supplied must be x,y pairs!  "+
           "The data provided contained an odd set of "+
           "data points" unless conf[:data].length % 2 == 0
+          
+        # remove nil values
+        conf[:data] = conf[:data].compact
+          
         return if conf[:data].length == 0
 
         conf[:description] ||= Array.new(conf[:data].size/2)
@@ -177,6 +192,11 @@ module SVG
         }
         sort( x, y, conf[:description] )
         conf[:data] = [x,y]
+        # at the end data looks like:
+        # [
+        #   [all x values],
+        #   [all y values]
+        # ]
         @data << conf
       end
 
@@ -214,27 +234,34 @@ module SVG
         min_value
       end
 
-      def x_range
+      def x_label_range
         max_value = max_x_range
         min_value = min_x_range
-
         range = max_value - min_value
-        right_pad = range == 0 ? 10 : range / 20.0
-        scale_range = (max_value + right_pad) - min_value
+        # add some padding on right
+        if range == 0
+          max_value += 10
+        else
+          max_value += range / 20.0
+        end
+        scale_range = max_value - min_value
 
         scale_division = scale_x_divisions || (scale_range / 10.0)
-
+        @x_offset = 0
+        
         if scale_x_integers
           scale_division = scale_division < 1 ? 1 : scale_division.round
+          @x_offset = min_value.to_f - min_value.floor
+          min_value = min_value.floor
         end
 
         [min_value, max_value, scale_division]
       end
 
       def get_x_values
-        min_value, max_value, scale_division = x_range
+        min_value, max_value, @x_scale_division = x_label_range
         rv = []
-        min_value.step( max_value, scale_division ) {|v| rv << v}
+        min_value.step( max_value, @x_scale_division ) {|v| rv << v}
         return rv
       end
       alias :get_x_labels :get_x_values
@@ -242,11 +269,8 @@ module SVG
       def field_width
         # exclude values which are outside max_x_range
         values = get_x_values
-        max = max_x_range
-        dx = (max - values[-1]).to_f / (values[-1] - values[-2])
-        #(@graph_width.to_f - font_size*2*right_font) /
-        #  (values.length + dx - right_align)
-        @graph_width.to_f / values.length
+        @graph_width.to_f / (values.length - 1 ) # -1 is to use entire x-axis
+                                                 # otherwise there is always 1 division unused 
       end
 
 
@@ -262,32 +286,39 @@ module SVG
         min_value
       end
 
-      def y_range
+      def y_label_range
         max_value = max_y_range
         min_value = min_y_range
-
         range = max_value - min_value
-        top_pad = range == 0 ? 10 : range / 20.0
-        scale_range = (max_value + top_pad) - min_value
+        # add some padding on top
+        if range == 0
+          max_value += 10
+        else
+          max_value += range / 20.0
+        end
+        scale_range = max_value - min_value
 
         scale_division = scale_y_divisions || (scale_range / 10.0)
-
+        @y_offset = 0
+        
         if scale_y_integers
           scale_division = scale_division < 1 ? 1 : scale_division.round
+          @y_offset = (min_value.to_f - min_value.floor).to_f
+          min_value = min_value.floor
         end
 
         return [min_value, max_value, scale_division]
       end
 
       def get_y_values
-        min_value, max_value, scale_division = y_range
+        min_value, max_value, @y_scale_division = y_label_range
         if max_value != min_value
-          while (max_value - min_value) < scale_division
-            scale_division /= 10.0
+          while (max_value - min_value) < @y_scale_division
+            @y_scale_division /= 10.0
           end
         end
         rv = []
-        min_value.step( max_value, scale_division ) {|v| rv << v}
+        min_value.step( max_value, @y_scale_division ) {|v| rv << v}
         rv << rv[0] + 1 if rv.length == 1
         return rv
       end
@@ -302,18 +333,25 @@ module SVG
         else
           dx = (max - values[-1]).to_f / (values[-1] - values[-2])
         end
-        #(@graph_height.to_f - font_size*2*top_font) /
-        #  (values.length + dx - top_align)
         @graph_height.to_f / values.length
       end
+      
+      def calc_coords(x, y)
+        coords = {:x => 0, :y => 0}
+        # scale the coordinates, use float division / multiplication
+        # otherwise the point will be place inaccurate
+        coords[:x] = (x + @x_offset)/@x_scale_division.to_f * field_width 
+        coords[:y] = @graph_height - (y + @y_offset)/@y_scale_division.to_f * field_height
+        return coords
+      end
 
       def draw_data
         line = 1
         
-        x_min, x_max = x_range
-        y_min, y_max = y_range
-        x_step = (@graph_width.to_f - font_size*2) / (x_max-x_min)
-        y_step = (@graph_height.to_f -  font_size*2) / (y_max-y_min)
+        x_min = min_x_range
+        x_max = max_x_range
+        y_min = min_y_range
+        y_max = max_y_range
 
         for data in @data
           x_points = data[:data][X]
@@ -323,10 +361,9 @@ module SVG
           x_start = 0
           y_start = 0
           x_points.each_index { |idx|
-            x = (x_points[idx] -  x_min) * x_step
-            y = @graph_height - (y_points[idx] -  y_min) * y_step
-            x_start, y_start = x,y if idx == 0
-            lpath << "#{x} #{y} "
+            c = calc_coords(x_points[idx] -  x_min, y_points[idx] -  y_min)
+            x_start, y_start = c[:x],c[:y] if idx == 0
+            lpath << "#{c[:x]} #{c[:y]} "
           }
 
           if area_fill
@@ -345,25 +382,25 @@ module SVG
 
           if show_data_points || show_data_values || add_popups
             x_points.each_index { |idx|
-              x = (x_points[idx] -  x_min) * x_step
-              y = @graph_height - (y_points[idx] -  y_min) * y_step
+              c = calc_coords(x_points[idx] -  x_min, y_points[idx] -  y_min)
               if show_data_points
-                DataPoint.new(x, y, line).shape(data[:description][idx]).each{|s|
+                DataPoint.new(c[:x], c[:y], line).shape(data[:description][idx]).each{|s|
                   @graph.add_element( *s )
                 }
               end
-              make_datapoint_text( x, y-6, y_points[idx] )
-              add_popup(x, y, format( x_points[idx], y_points[idx], data[:description][idx]))
+              make_datapoint_text( c[:x], c[:y]-6, y_points[idx] )
+              add_popup(c[:x], c[:y], format( x_points[idx], y_points[idx], data[:description][idx]))
             }
           end
           line += 1
         end
       end
-
+      
+      # returns the formatted string which is added as popup information
       def format x, y, desc
         info = []
-        info << (round_popups ? (x * 100).to_i / 100 : x)
-        info << (round_popups ? (y * 100).to_i / 100 : y)
+        info << (round_popups ? x.round : @number_format % x )
+        info << (round_popups ? y.round : @number_format % y )
         info << desc
         "(#{info.compact.join(', ')})"
       end

data/lib/SVG/Graph/Schedule.rb

@@ -140,7 +140,7 @@ module SVG
       # Note that the data must be in time,value pairs, and that the date format
       # may be any date that is parseable by DateTime#parse, DateTime#strptime.
       # The :template argument is optional. By default DateTime#parse will be used.
-      # Checkout the ruby doc for valit template notation:
+      # Checkout the ruby doc for valid template notation:
       # http://ruby-doc.org/stdlib-2.3.1/libdoc/date/rdoc/Date.html#method-i-strftime
       # http://ruby-doc.org/stdlib-2.3.1/libdoc/date/rdoc/DateTime.html#method-c-parse
       # http://ruby-doc.org/stdlib-2.3.1/libdoc/date/rdoc/DateTime.html#method-c-strptime.

data/lib/SVG/Graph/TimeSeries.rb

@@ -109,12 +109,12 @@ module SVG
         init_with(
           #:max_time_span     => '',
           :x_label_format     => '%Y-%m-%d %H:%M:%S',
-          :popup_format       => '%Y-%m-%d %H:%M:%S'
+          :popup_format       => '%Y-%m-%d %H:%M:%S',
         )
       end
 
-      # The format string use do format the X axis labels.
-      # See Time::strformat
+      # The format string used to format the X axis labels.
+      # See Time::strformat, default: '%Y-%m-%d %H:%M:%S'
       attr_accessor :x_label_format
       # Use this to set the spacing between dates on the axis.  The value
       # must be of the form 
@@ -138,7 +138,7 @@ module SVG
       #   graph.add_data( 
       #     :data => d1,
       #     :title => 'One',
-      #     :template => '%H:%M'
+      #     :template => '%H:%M'  #template is optional
       #   )
       #   graph.add_data(
       #     :data => d2,
@@ -150,26 +150,24 @@ module SVG
       # a format that is parseable by ParseDate, a Time object, or a number of seconds
       # after the unix epoch.
       def add_data data
-        @time_template = data[:template]
         data[:data].each_index do |i|
-          data[:data][i] = parse_time(data[:data][i]).to_i if i % 2 == 0
+          data[:data][i] = parse_time(data[:data][i], data[:template]).to_i if i % 2 == 0  # only even indices are time, odd indices are values
         end
-        @time_template = nil # reset for the next data series
         super(data)
       end
 
 
       protected
 
-      
+      # value must be Integer, Time, or parseable by DateTime#parse
       def min_x_value=(value)
-        t = parse_time(value)
+        t = parse_time(value, nil)
         @min_x_value = t.to_i
       end
 
-      # value should be 
+      # value must be Integer, Time, or parseable by DateTime#parse
       def max_x_value=(value)
-        t = parse_time(value)
+        t = parse_time(value, nil)
         @max_x_value = t.to_i
       end
 
@@ -190,13 +188,13 @@ module SVG
       # Accepts date time as a string, number of seconds since the epoch, or Time 
       # object and returns a Time object. Raises an error if not a valid date time
       # representation.
-      def parse_time(time)
+      def parse_time(time, template)
         case time
         when Time
           return time
         when String
-          if @time_template.kind_of? String
-            return DateTime.strptime(time, @time_template).to_time
+          if template.kind_of? String
+            return DateTime.strptime(time, template).to_time
           else
             return DateTime.parse(time).to_time
           end
@@ -209,7 +207,7 @@ module SVG
 
       def get_x_values
         rv = []
-        min, max, scale_division = x_range
+        min, max, @x_scale_division = x_label_range
         if timescale_divisions
           timescale_divisions =~ /(\d+) ?(day|week|month|year|hour|minute|second)?/
           division_units = $2 ? $2 : "day"
@@ -219,6 +217,7 @@ module SVG
             case division_units
             when "month"
               cur = min
+              @x_scale_division = 365.25/12 * 24 * 60 * 60 * amount
               while cur < max
                 rv << cur
                 arr = Time.at( cur ).to_a
@@ -231,6 +230,7 @@ module SVG
               end
             when "year"
               cur = min
+              @x_scale_division = 365.25 * 24 * 60 * 60 * amount
               while cur < max
                 rv << cur
                 arr = Time.at( cur ).to_a
@@ -248,12 +248,13 @@ module SVG
             when "second"
               step = amount
             end
+            # only do this if division_units is not year or month. Those are done already above in the cases.
             min.step( max, step ) {|v| rv << v} if step
-
+            @x_scale_division = step if step
             return rv
           end
         end
-        min.step( max, scale_division ) {|v| rv << v}
+        min.step( max, @x_scale_division ) {|v| rv << v}
         return rv
       end # get_x_values
       

data/lib/svggraph.rb

@@ -1,6 +1,6 @@
 module SVG
   module Graph
-    VERSION = '2.0.2.beta'
+    VERSION = '2.0.2'
   end
 end
 require_relative 'SVG/Graph/DataPoint'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svg-graph
 version: !ruby/object:Gem::Version
-  version: 2.0.2.beta
+  version: 2.0.2
 platform: ruby
 authors:
 - Sean Russell
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-10-26 00:00:00.000000000 Z
 dependencies: []
 description: "Gem version of SVG:::Graph. SVG:::Graph is a pure Ruby library for generating
   charts, \nwhich are a type of graph where the values of one axis are not scalar.
@@ -67,9 +67,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.7