Class: SVG::Graph::Plot

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

Overview

For creating SVG plots of scalar data

Synopsis

require 'SVG/Graph/Plot'

# Data sets are x,y pairs
# Note that multiple data sets 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.
projection = [
  6, 11,    0, 5,   18, 7,   1, 11,   13, 9,   1, 2,   19, 0,   3, 13,
  7, 9 
]
actual = [
  0, 18,    8, 15,    9, 4,   18, 14,   10, 2,   11, 6,  14, 12,   
  15, 6,   4, 17,   2, 12
]

graph = SVG::Graph::Plot.new({
	:height => 500,
 	:width => 300,
  :key => true,
  :scale_x_integers => true,
  :scale_y_integerrs => true,
})

graph.add_data({
	:data => projection

:title => ‘Projected’,

})

graph.add_data({
	:data => actual,

:title => ‘Actual’,

})

print graph.burn()

Description

Produces a graph of scalar data.

This object aims to allow you to easily create high quality SVG scalar plots. You can either use the default style sheet or supply your own. Either way there are many options which can be configured to give you control over how the graph is generated - with or without a key, data elements at each point, title, subtitle etc.

Examples

www.germane-software/repositories/public/SVG/test/plot.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:

[ 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)

See also

  • SVG::Graph::Graph

  • SVG::Graph::BarHorizontal

  • SVG::Graph::Bar

  • SVG::Graph::Line

  • SVG::Graph::Pie

  • SVG::Graph::TimeSeries

Author

Sean E. Russell <serATgermaneHYPHENsoftwareDOTcom>

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

Direct Known Subclasses

TimeSeries

Constant Summary

Constants included from SVG::Graph

VERSION

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#area_fill ⇒ Object

Fill the area under the line



127
128
129
 
# File 'lib/SVG/Graph/Plot.rb', line 127

def area_fill
  @area_fill
end

#max_x_value ⇒ Object

Set the maximum value of the X axis



134
135
136
 
# File 'lib/SVG/Graph/Plot.rb', line 134

def max_x_value
  @max_x_value
end

#max_y_value ⇒ Object

Set the maximum value of the Y axis



138
139
140
 
# File 'lib/SVG/Graph/Plot.rb', line 138

def max_y_value
  @max_y_value
end

#min_x_value ⇒ Object

Set the minimum value of the X axis



132
133
134
 
# File 'lib/SVG/Graph/Plot.rb', line 132

def min_x_value
  @min_x_value
end

#min_y_value ⇒ Object

Set the minimum value of the Y axis



136
137
138
 
# File 'lib/SVG/Graph/Plot.rb', line 136

def min_y_value
  @min_y_value
end

#round_popups ⇒ Object

Round value of data points in popups to integer



142
143
144
 
# File 'lib/SVG/Graph/Plot.rb', line 142

def round_popups
  @round_popups
end

#scale_x_divisions ⇒ Object

Determines the scaling for the X axis divisions.

graph.scale_x_divisions = 2

would cause the graph to attempt to generate labels stepped by 2; EG: 0,2,4,6,8…



114
115
116
 
# File 'lib/SVG/Graph/Plot.rb', line 114

def scale_x_divisions
  @scale_x_divisions
end

#scale_x_integers ⇒ Object

Make the X axis labels integers



123
124
125
 
# File 'lib/SVG/Graph/Plot.rb', line 123

def scale_x_integers
  @scale_x_integers
end

#scale_y_divisions ⇒ Object

Determines the scaling for the Y axis divisions.

graph.scale_y_divisions = 0.5

would cause the graph to attempt to generate labels stepped by 0.5; EG: 0, 0.5, 1, 1.5, 2, …



121
122
123
 
# File 'lib/SVG/Graph/Plot.rb', line 121

def scale_y_divisions
  @scale_y_divisions
end

#scale_y_integers ⇒ Object

Make the Y axis labels integers



125
126
127
 
# File 'lib/SVG/Graph/Plot.rb', line 125

def scale_y_integers
  @scale_y_integers
end

#show_data_points ⇒ Object

Show a small circle on the graph where the line goes from one point to the next.



130
131
132
 
# File 'lib/SVG/Graph/Plot.rb', line 130

def show_data_points
  @show_data_points
end

#show_lines ⇒ Object

Show lines connecting data points



140
141
142
 
# File 'lib/SVG/Graph/Plot.rb', line 140

def show_lines
  @show_lines
end

Instance Method Details

#add_data(data) ⇒ Object

Adds data to the plot. The data must be in X,Y pairs; EG

[ 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)



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/SVG/Graph/Plot.rb', line 148

def add_data(data)
 
  @data = [] unless @data

  raise "No data provided by #{conf.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

  data[:description] ||= Array.new(data[:data].size/2)
  if data[:description].size != data[:data].size/2
    raise "Description for popups does not have same size as provided data: #{data[:description].size} vs #{data[:data].size/2}"
  end

  x = []
  y = []
  data[:data].each_index {|i|
    (i%2 == 0 ? x : y) << data[:data][i]
  }
  sort( x, y, data[:description] )
  data[:data] = [x,y]
  @data << data
end

#set_defaults ⇒ Object

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

show_data_values

true

show_data_points

true

area_fill

false

stacked

false



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/SVG/Graph/Plot.rb', line 96

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
end