Class: SVG::Graph::TimeSeries

Inherits:
Plot show all
Defined in:
lib/SVG/Graph/TimeSeries.rb

Overview

For creating SVG plots of scalar temporal data

Synopsis

require 'SVG/Graph/TimeSeriess'

# Data sets are x,y pairs
data1 = ["6/17/72", 11,    "1/11/72", 7,    "4/13/04 17:31", 11, 
        "9/11/01", 9,    "9/1/85", 2,    "9/1/88", 1,    "1/15/95", 13]
data2 = ["8/1/73", 18,    "3/1/77", 15,    "10/1/98", 4, 
        "5/1/02", 14,    "3/1/95", 6,    "8/1/91", 12,    "12/1/87", 6, 
        "5/1/84", 17,    "10/1/80", 12]

graph = SVG::Graph::TimeSeries.new( {
  :width => 640,
  :height => 480,
  :graph_title => title,
  :show_graph_title => true,
  :no_css => true,
  :key => true,
  :scale_x_integers => true,
  :scale_y_integers => true,
  :min_x_value => 0,
  :min_y_value => 0,
  :show_data_labels => true,
  :show_x_guidelines => true,
  :show_x_title => true,
  :x_title => "Time",
  :show_y_title => true,
  :y_title => "Ice Cream Cones",
  :y_title_text_direction => :bt,
  :stagger_x_labels => true,
  :x_label_format => "%m/%d/%y",
})

graph.add_data({
	:data => projection

:title => 'Projected',

})

graph.add_data({
	:data => actual,

:title => 'Actual',

})

print graph.burn()

Description

Produces a graph of temporal scalar data.

Examples

www.germane-software/repositories/public/SVG/test/timeseries.rb

Notes

The default stylesheet handles upto 10 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 10 data sets as they will have no style and be in black.

Unlike the other types of charts, data sets must contain x,y pairs:

[ "12:30", 2 ]          # A data set with 1 point: ("12:30",2)
[ "01:00",2, "14:20",6] # A data set with 2 points: ("01:00",2) and 
                        #                           ("14:20",6)

Note that multiple data sets within the same chart can differ in length, and that the data in the datasets needn't be in order; they will be ordered by the plot along the X-axis.

The dates must be parseable by ParseDate, but otherwise can be any order of magnitude (seconds within the hour, or years)

See also

  • SVG::Graph::Graph

  • SVG::Graph::BarHorizontal

  • SVG::Graph::Bar

  • SVG::Graph::Line

  • SVG::Graph::Pie

  • SVG::Graph::Plot

Author

Sean E. Russell <serATgermaneHYPHENsoftwareDOTcom>

Copyright 2004 Sean E. Russell This software is available under the Ruby license

Instance Attribute Summary collapse

Attributes inherited from Plot

#area_fill, #min_x_value, #min_y_value, #scale_x_divisions, #scale_x_integers, #scale_y_divisions, #scale_y_integers, #show_data_points

Attributes inherited from Graph

#add_popups, #font_size, #graph_subtitle, #graph_title, #height, #key, #key_font_size, #key_position, #min_scale_value, #no_css, #rotate_x_labels, #rotate_y_labels, #scale_divisions, #scale_integers, #show_data_values, #show_graph_subtitle, #show_graph_title, #show_x_guidelines, #show_x_labels, #show_x_title, #show_y_guidelines, #show_y_labels, #show_y_title, #stagger_x_labels, #stagger_y_labels, #step_include_first_x_label, #step_x_labels, #style_sheet, #subtitle_font_size, #title_font_size, #width, #x_label_font_size, #x_title, #x_title_font_size, #y_label_font_size, #y_title, #y_title_font_size, #y_title_text_direction

Instance Method Summary collapse

Methods inherited from Graph

#burn, #clear_data, #initialize

Constructor Details

This class inherits a constructor from SVG::Graph::Graph

Instance Attribute Details

The formatting used for the popups. See x_label_format



126
127
128
# File 'lib/SVG/Graph/TimeSeries.rb', line 126

def popup_format
  @popup_format
end

#timescale_divisionsObject

Use this to set the spacing between dates on the axis. The value must be of the form “d+ ?(days|weeks|months|years|hours|minutes|seconds)?”

EG:

graph.timescale_divisions = "2 weeks"

will cause the chart to try to divide the X axis up into segments of two week periods.



124
125
126
# File 'lib/SVG/Graph/TimeSeries.rb', line 124

def timescale_divisions
  @timescale_divisions
end

#x_label_formatObject

The format string use do format the X axis labels. See Time::strformat



113
114
115
# File 'lib/SVG/Graph/TimeSeries.rb', line 113

def x_label_format
  @x_label_format
end

Instance Method Details

#add_data(data) ⇒ Object

Add data to the plot.

d1 = [ "12:30", 2 ]          # A data set with 1 point: ("12:30",2)
d2 = [ "01:00",2, "14:20",6] # A data set with 2 points: ("01:00",2) and 
                             #                           ("14:20",6)  
graph.add_data( 
  :data => d1,
  :title => 'One'
)
graph.add_data(
  :data => d2,
  :title => 'Two'
)

Note that the data must be in time,value pairs, and that the date format may be any date that is parseable by ParseDate.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
# File 'lib/SVG/Graph/TimeSeries.rb', line 144

def add_data data
  @data = [] unless @data
 
  raise "No data provided by #{@data.inspect}" unless data[:data] and
                                              data[:data].kind_of? Array
  raise "Data supplied must be x,y pairs!  "+
    "The data provided contained an odd set of "+
    "data points" unless data[:data].length % 2 == 0
  return if data[:data].length == 0


  x = []
  y = []
  data[:data].each_index {|i|
    if i%2 == 0
      t = DateTime.parse( data[:data][i] ).to_time
      x << t.to_i
    else
      y << data[:data][i]
    end
  }
  sort( x, y )
  data[:data] = [x,y]
  @data << data
end

#set_defaultsObject

In addition to the defaults set by Graph::initialize and Plot::set_defaults, sets:

x_label_format

'%Y-%m-%d %H:%M:%S'

popup_format

'%Y-%m-%d %H:%M:%S'



102
103
104
105
106
107
108
109
# File 'lib/SVG/Graph/TimeSeries.rb', line 102

def set_defaults
  super
  init_with(
    #:max_time_span     => '',
    :x_label_format     => '%Y-%m-%d %H:%M:%S',
    :popup_format       => '%Y-%m-%d %H:%M:%S'
  )
end