Chris@909: require 'SVG/Graph/Plot' Chris@909: require 'parsedate' Chris@909: Chris@909: module SVG Chris@909: module Graph Chris@909: # === For creating SVG plots of scalar temporal data Chris@909: # Chris@909: # = Synopsis Chris@909: # Chris@909: # require 'SVG/Graph/TimeSeriess' Chris@909: # Chris@909: # # Data sets are x,y pairs Chris@909: # data1 = ["6/17/72", 11, "1/11/72", 7, "4/13/04 17:31", 11, Chris@909: # "9/11/01", 9, "9/1/85", 2, "9/1/88", 1, "1/15/95", 13] Chris@909: # data2 = ["8/1/73", 18, "3/1/77", 15, "10/1/98", 4, Chris@909: # "5/1/02", 14, "3/1/95", 6, "8/1/91", 12, "12/1/87", 6, Chris@909: # "5/1/84", 17, "10/1/80", 12] Chris@909: # Chris@909: # graph = SVG::Graph::TimeSeries.new( { Chris@909: # :width => 640, Chris@909: # :height => 480, Chris@909: # :graph_title => title, Chris@909: # :show_graph_title => true, Chris@909: # :no_css => true, Chris@909: # :key => true, Chris@909: # :scale_x_integers => true, Chris@909: # :scale_y_integers => true, Chris@909: # :min_x_value => 0, Chris@909: # :min_y_value => 0, Chris@909: # :show_data_labels => true, Chris@909: # :show_x_guidelines => true, Chris@909: # :show_x_title => true, Chris@909: # :x_title => "Time", Chris@909: # :show_y_title => true, Chris@909: # :y_title => "Ice Cream Cones", Chris@909: # :y_title_text_direction => :bt, Chris@909: # :stagger_x_labels => true, Chris@909: # :x_label_format => "%m/%d/%y", Chris@909: # }) Chris@909: # Chris@909: # graph.add_data({ Chris@909: # :data => projection Chris@909: # :title => 'Projected', Chris@909: # }) Chris@909: # Chris@909: # graph.add_data({ Chris@909: # :data => actual, Chris@909: # :title => 'Actual', Chris@909: # }) Chris@909: # Chris@909: # print graph.burn() Chris@909: # Chris@909: # = Description Chris@909: # Chris@909: # Produces a graph of temporal scalar data. Chris@909: # Chris@909: # = Examples Chris@909: # Chris@909: # http://www.germane-software/repositories/public/SVG/test/timeseries.rb Chris@909: # Chris@909: # = Notes Chris@909: # Chris@909: # The default stylesheet handles upto 10 data sets, if you Chris@909: # use more you must create your own stylesheet and add the Chris@909: # additional settings for the extra data sets. You will know Chris@909: # if you go over 10 data sets as they will have no style and Chris@909: # be in black. Chris@909: # Chris@909: # Unlike the other types of charts, data sets must contain x,y pairs: Chris@909: # Chris@909: # [ "12:30", 2 ] # A data set with 1 point: ("12:30",2) Chris@909: # [ "01:00",2, "14:20",6] # A data set with 2 points: ("01:00",2) and Chris@909: # # ("14:20",6) Chris@909: # Chris@909: # Note that multiple data sets within the same chart can differ in length, Chris@909: # and that the data in the datasets needn't be in order; they will be ordered Chris@909: # by the plot along the X-axis. Chris@909: # Chris@909: # The dates must be parseable by ParseDate, but otherwise can be Chris@909: # any order of magnitude (seconds within the hour, or years) Chris@909: # Chris@909: # = See also Chris@909: # Chris@909: # * SVG::Graph::Graph Chris@909: # * SVG::Graph::BarHorizontal Chris@909: # * SVG::Graph::Bar Chris@909: # * SVG::Graph::Line Chris@909: # * SVG::Graph::Pie Chris@909: # * SVG::Graph::Plot Chris@909: # Chris@909: # == Author Chris@909: # Chris@909: # Sean E. Russell Chris@909: # Chris@909: # Copyright 2004 Sean E. Russell Chris@909: # This software is available under the Ruby license[LICENSE.txt] Chris@909: # Chris@909: class TimeSeries < Plot Chris@909: # In addition to the defaults set by Graph::initialize and Chris@909: # Plot::set_defaults, sets: Chris@909: # [x_label_format] '%Y-%m-%d %H:%M:%S' Chris@909: # [popup_format] '%Y-%m-%d %H:%M:%S' Chris@909: def set_defaults Chris@909: super Chris@909: init_with( Chris@909: #:max_time_span => '', Chris@909: :x_label_format => '%Y-%m-%d %H:%M:%S', Chris@909: :popup_format => '%Y-%m-%d %H:%M:%S' Chris@909: ) Chris@909: end Chris@909: Chris@909: # The format string use do format the X axis labels. Chris@909: # See Time::strformat Chris@909: attr_accessor :x_label_format Chris@909: # Use this to set the spacing between dates on the axis. The value Chris@909: # must be of the form Chris@909: # "\d+ ?(days|weeks|months|years|hours|minutes|seconds)?" Chris@909: # Chris@909: # EG: Chris@909: # Chris@909: # graph.timescale_divisions = "2 weeks" Chris@909: # Chris@909: # will cause the chart to try to divide the X axis up into segments of Chris@909: # two week periods. Chris@909: attr_accessor :timescale_divisions Chris@909: # The formatting used for the popups. See x_label_format Chris@909: attr_accessor :popup_format Chris@909: Chris@909: # Add data to the plot. Chris@909: # Chris@909: # d1 = [ "12:30", 2 ] # A data set with 1 point: ("12:30",2) Chris@909: # d2 = [ "01:00",2, "14:20",6] # A data set with 2 points: ("01:00",2) and Chris@909: # # ("14:20",6) Chris@909: # graph.add_data( Chris@909: # :data => d1, Chris@909: # :title => 'One' Chris@909: # ) Chris@909: # graph.add_data( Chris@909: # :data => d2, Chris@909: # :title => 'Two' Chris@909: # ) Chris@909: # Chris@909: # Note that the data must be in time,value pairs, and that the date format Chris@909: # may be any date that is parseable by ParseDate. Chris@909: def add_data data Chris@909: @data = [] unless @data Chris@909: Chris@909: raise "No data provided by #{@data.inspect}" unless data[:data] and Chris@909: data[:data].kind_of? Array Chris@909: raise "Data supplied must be x,y pairs! "+ Chris@909: "The data provided contained an odd set of "+ Chris@909: "data points" unless data[:data].length % 2 == 0 Chris@909: return if data[:data].length == 0 Chris@909: Chris@909: Chris@909: x = [] Chris@909: y = [] Chris@909: data[:data].each_index {|i| Chris@909: if i%2 == 0 Chris@909: arr = ParseDate.parsedate( data[:data][i] ) Chris@909: t = Time.local( *arr[0,6].compact ) Chris@909: x << t.to_i Chris@909: else Chris@909: y << data[:data][i] Chris@909: end Chris@909: } Chris@909: sort( x, y ) Chris@909: data[:data] = [x,y] Chris@909: @data << data Chris@909: end Chris@909: Chris@909: Chris@909: protected Chris@909: Chris@909: def min_x_value=(value) Chris@909: arr = ParseDate.parsedate( value ) Chris@909: @min_x_value = Time.local( *arr[0,6].compact ).to_i Chris@909: end Chris@909: Chris@909: Chris@909: def format x, y Chris@909: Time.at( x ).strftime( popup_format ) Chris@909: end Chris@909: Chris@909: def get_x_labels Chris@909: get_x_values.collect { |v| Time.at(v).strftime( x_label_format ) } Chris@909: end Chris@909: Chris@909: private Chris@909: def get_x_values Chris@909: rv = [] Chris@909: min, max, scale_division = x_range Chris@909: if timescale_divisions Chris@909: timescale_divisions =~ /(\d+) ?(day|week|month|year|hour|minute|second)?/ Chris@909: division_units = $2 ? $2 : "day" Chris@909: amount = $1.to_i Chris@909: if amount Chris@909: step = nil Chris@909: case division_units Chris@909: when "month" Chris@909: cur = min Chris@909: while cur < max Chris@909: rv << cur Chris@909: arr = Time.at( cur ).to_a Chris@909: arr[4] += amount Chris@909: if arr[4] > 12 Chris@909: arr[5] += (arr[4] / 12).to_i Chris@909: arr[4] = (arr[4] % 12) Chris@909: end Chris@909: cur = Time.local(*arr).to_i Chris@909: end Chris@909: when "year" Chris@909: cur = min Chris@909: while cur < max Chris@909: rv << cur Chris@909: arr = Time.at( cur ).to_a Chris@909: arr[5] += amount Chris@909: cur = Time.local(*arr).to_i Chris@909: end Chris@909: when "week" Chris@909: step = 7 * 24 * 60 * 60 * amount Chris@909: when "day" Chris@909: step = 24 * 60 * 60 * amount Chris@909: when "hour" Chris@909: step = 60 * 60 * amount Chris@909: when "minute" Chris@909: step = 60 * amount Chris@909: when "second" Chris@909: step = amount Chris@909: end Chris@909: min.step( max, step ) {|v| rv << v} if step Chris@909: Chris@909: return rv Chris@909: end Chris@909: end Chris@909: min.step( max, scale_division ) {|v| rv << v} Chris@909: return rv Chris@909: end Chris@909: end Chris@909: end Chris@909: end