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