annotate lib/SVG/Graph/Graph.rb @ 1466:834828a14f2b bug_598

Close obsolete branch bug_598
author Chris Cannam
date Fri, 21 Jun 2013 14:51:55 +0100
parents 3e4c3460b6ca
children 261b3d9a4903
rev   line source
Chris@1294 1 begin
Chris@1294 2 require 'zlib'
Chris@1294 3 @@__have_zlib = true
Chris@1294 4 rescue
Chris@1294 5 @@__have_zlib = false
Chris@1294 6 end
Chris@1294 7
Chris@1294 8 require 'rexml/document'
Chris@1294 9
Chris@1294 10 module SVG
Chris@1294 11 module Graph
Chris@1294 12 VERSION = '@ANT_VERSION@'
Chris@1294 13
Chris@1294 14 # === Base object for generating SVG Graphs
Chris@1294 15 #
Chris@1294 16 # == Synopsis
Chris@1294 17 #
Chris@1294 18 # This class is only used as a superclass of specialized charts. Do not
Chris@1294 19 # attempt to use this class directly, unless creating a new chart type.
Chris@1294 20 #
Chris@1294 21 # For examples of how to subclass this class, see the existing specific
Chris@1294 22 # subclasses, such as SVG::Graph::Pie.
Chris@1294 23 #
Chris@1294 24 # == Examples
Chris@1294 25 #
Chris@1294 26 # For examples of how to use this package, see either the test files, or
Chris@1294 27 # the documentation for the specific class you want to use.
Chris@1294 28 #
Chris@1294 29 # * file:test/plot.rb
Chris@1294 30 # * file:test/single.rb
Chris@1294 31 # * file:test/test.rb
Chris@1294 32 # * file:test/timeseries.rb
Chris@1294 33 #
Chris@1294 34 # == Description
Chris@1294 35 #
Chris@1294 36 # This package should be used as a base for creating SVG graphs.
Chris@1294 37 #
Chris@1294 38 # == Acknowledgements
Chris@1294 39 #
Chris@1294 40 # Leo Lapworth for creating the SVG::TT::Graph package which this Ruby
Chris@1294 41 # port is based on.
Chris@1294 42 #
Chris@1294 43 # Stephen Morgan for creating the TT template and SVG.
Chris@1294 44 #
Chris@1294 45 # == See
Chris@1294 46 #
Chris@1294 47 # * SVG::Graph::BarHorizontal
Chris@1294 48 # * SVG::Graph::Bar
Chris@1294 49 # * SVG::Graph::Line
Chris@1294 50 # * SVG::Graph::Pie
Chris@1294 51 # * SVG::Graph::Plot
Chris@1294 52 # * SVG::Graph::TimeSeries
Chris@1294 53 #
Chris@1294 54 # == Author
Chris@1294 55 #
Chris@1294 56 # Sean E. Russell <serATgermaneHYPHENsoftwareDOTcom>
Chris@1294 57 #
Chris@1294 58 # Copyright 2004 Sean E. Russell
Chris@1294 59 # This software is available under the Ruby license[LICENSE.txt]
Chris@1294 60 #
Chris@1294 61 class Graph
Chris@1294 62 include REXML
Chris@1294 63
Chris@1294 64 # Initialize the graph object with the graph settings. You won't
Chris@1294 65 # instantiate this class directly; see the subclass for options.
Chris@1294 66 # [width] 500
Chris@1294 67 # [height] 300
Chris@1294 68 # [show_x_guidelines] false
Chris@1294 69 # [show_y_guidelines] true
Chris@1294 70 # [show_data_values] true
Chris@1294 71 # [min_scale_value] 0
Chris@1294 72 # [show_x_labels] true
Chris@1294 73 # [stagger_x_labels] false
Chris@1294 74 # [rotate_x_labels] false
Chris@1294 75 # [step_x_labels] 1
Chris@1294 76 # [step_include_first_x_label] true
Chris@1294 77 # [show_y_labels] true
Chris@1294 78 # [rotate_y_labels] false
Chris@1294 79 # [scale_integers] false
Chris@1294 80 # [show_x_title] false
Chris@1294 81 # [x_title] 'X Field names'
Chris@1294 82 # [show_y_title] false
Chris@1294 83 # [y_title_text_direction] :bt
Chris@1294 84 # [y_title] 'Y Scale'
Chris@1294 85 # [show_graph_title] false
Chris@1294 86 # [graph_title] 'Graph Title'
Chris@1294 87 # [show_graph_subtitle] false
Chris@1294 88 # [graph_subtitle] 'Graph Sub Title'
Chris@1294 89 # [key] true,
Chris@1294 90 # [key_position] :right, # bottom or righ
Chris@1294 91 # [font_size] 12
Chris@1294 92 # [title_font_size] 16
Chris@1294 93 # [subtitle_font_size] 14
Chris@1294 94 # [x_label_font_size] 12
Chris@1294 95 # [x_title_font_size] 14
Chris@1294 96 # [y_label_font_size] 12
Chris@1294 97 # [y_title_font_size] 14
Chris@1294 98 # [key_font_size] 10
Chris@1294 99 # [no_css] false
Chris@1294 100 # [add_popups] false
Chris@1294 101 def initialize( config )
Chris@1294 102 @config = config
Chris@1294 103
Chris@1294 104 self.top_align = self.top_font = self.right_align = self.right_font = 0
Chris@1294 105
Chris@1294 106 init_with({
Chris@1294 107 :width => 500,
Chris@1294 108 :height => 300,
Chris@1294 109 :show_x_guidelines => false,
Chris@1294 110 :show_y_guidelines => true,
Chris@1294 111 :show_data_values => true,
Chris@1294 112
Chris@1294 113 # :min_scale_value => 0,
Chris@1294 114
Chris@1294 115 :show_x_labels => true,
Chris@1294 116 :stagger_x_labels => false,
Chris@1294 117 :rotate_x_labels => false,
Chris@1294 118 :step_x_labels => 1,
Chris@1294 119 :step_include_first_x_label => true,
Chris@1294 120
Chris@1294 121 :show_y_labels => true,
Chris@1294 122 :rotate_y_labels => false,
Chris@1294 123 :stagger_y_labels => false,
Chris@1294 124 :scale_integers => false,
Chris@1294 125
Chris@1294 126 :show_x_title => false,
Chris@1294 127 :x_title => 'X Field names',
Chris@1294 128
Chris@1294 129 :show_y_title => false,
Chris@1294 130 :y_title_text_direction => :bt,
Chris@1294 131 :y_title => 'Y Scale',
Chris@1294 132
Chris@1294 133 :show_graph_title => false,
Chris@1294 134 :graph_title => 'Graph Title',
Chris@1294 135 :show_graph_subtitle => false,
Chris@1294 136 :graph_subtitle => 'Graph Sub Title',
Chris@1294 137 :key => true,
Chris@1294 138 :key_position => :right, # bottom or right
Chris@1294 139
Chris@1294 140 :font_size =>12,
Chris@1294 141 :title_font_size =>16,
Chris@1294 142 :subtitle_font_size =>14,
Chris@1294 143 :x_label_font_size =>12,
Chris@1294 144 :x_title_font_size =>14,
Chris@1294 145 :y_label_font_size =>12,
Chris@1294 146 :y_title_font_size =>14,
Chris@1294 147 :key_font_size =>10,
Chris@1294 148
Chris@1294 149 :no_css =>false,
Chris@1294 150 :add_popups =>false,
Chris@1294 151 })
Chris@1294 152
Chris@1294 153 set_defaults if respond_to? :set_defaults
Chris@1294 154
Chris@1294 155 init_with config
Chris@1294 156 end
Chris@1294 157
Chris@1294 158
Chris@1294 159 # This method allows you do add data to the graph object.
Chris@1294 160 # It can be called several times to add more data sets in.
Chris@1294 161 #
Chris@1294 162 # data_sales_02 = [12, 45, 21];
Chris@1294 163 #
Chris@1294 164 # graph.add_data({
Chris@1294 165 # :data => data_sales_02,
Chris@1294 166 # :title => 'Sales 2002'
Chris@1294 167 # })
Chris@1294 168 def add_data conf
Chris@1294 169 @data = [] unless defined? @data
Chris@1294 170
Chris@1294 171 if conf[:data] and conf[:data].kind_of? Array
Chris@1294 172 @data << conf
Chris@1294 173 else
Chris@1294 174 raise "No data provided by #{conf.inspect}"
Chris@1294 175 end
Chris@1294 176 end
Chris@1294 177
Chris@1294 178
Chris@1294 179 # This method removes all data from the object so that you can
Chris@1294 180 # reuse it to create a new graph but with the same config options.
Chris@1294 181 #
Chris@1294 182 # graph.clear_data
Chris@1294 183 def clear_data
Chris@1294 184 @data = []
Chris@1294 185 end
Chris@1294 186
Chris@1294 187
Chris@1294 188 # This method processes the template with the data and
Chris@1294 189 # config which has been set and returns the resulting SVG.
Chris@1294 190 #
Chris@1294 191 # This method will croak unless at least one data set has
Chris@1294 192 # been added to the graph object.
Chris@1294 193 #
Chris@1294 194 # print graph.burn
Chris@1294 195 def burn
Chris@1294 196 raise "No data available" unless @data.size > 0
Chris@1294 197
Chris@1294 198 calculations if respond_to? :calculations
Chris@1294 199
Chris@1294 200 start_svg
Chris@1294 201 calculate_graph_dimensions
Chris@1294 202 @foreground = Element.new( "g" )
Chris@1294 203 draw_graph
Chris@1294 204 draw_titles
Chris@1294 205 draw_legend
Chris@1294 206 draw_data
Chris@1294 207 @graph.add_element( @foreground )
Chris@1294 208 style
Chris@1294 209
Chris@1294 210 data = ""
Chris@1294 211 @doc.write( data, 0 )
Chris@1294 212
Chris@1294 213 if @config[:compress]
Chris@1294 214 if @@__have_zlib
Chris@1294 215 inp, out = IO.pipe
Chris@1294 216 gz = Zlib::GzipWriter.new( out )
Chris@1294 217 gz.write data
Chris@1294 218 gz.close
Chris@1294 219 data = inp.read
Chris@1294 220 else
Chris@1294 221 data << "<!-- Ruby Zlib not available for SVGZ -->";
Chris@1294 222 end
Chris@1294 223 end
Chris@1294 224
Chris@1294 225 return data
Chris@1294 226 end
Chris@1294 227
Chris@1294 228
Chris@1294 229 # Set the height of the graph box, this is the total height
Chris@1294 230 # of the SVG box created - not the graph it self which auto
Chris@1294 231 # scales to fix the space.
Chris@1294 232 attr_accessor :height
Chris@1294 233 # Set the width of the graph box, this is the total width
Chris@1294 234 # of the SVG box created - not the graph it self which auto
Chris@1294 235 # scales to fix the space.
Chris@1294 236 attr_accessor :width
Chris@1294 237 # Set the path to an external stylesheet, set to '' if
Chris@1294 238 # you want to revert back to using the defaut internal version.
Chris@1294 239 #
Chris@1294 240 # To create an external stylesheet create a graph using the
Chris@1294 241 # default internal version and copy the stylesheet section to
Chris@1294 242 # an external file and edit from there.
Chris@1294 243 attr_accessor :style_sheet
Chris@1294 244 # (Bool) Show the value of each element of data on the graph
Chris@1294 245 attr_accessor :show_data_values
Chris@1294 246 # The point at which the Y axis starts, defaults to '0',
Chris@1294 247 # if set to nil it will default to the minimum data value.
Chris@1294 248 attr_accessor :min_scale_value
Chris@1294 249 # Whether to show labels on the X axis or not, defaults
Chris@1294 250 # to true, set to false if you want to turn them off.
Chris@1294 251 attr_accessor :show_x_labels
Chris@1294 252 # This puts the X labels at alternative levels so if they
Chris@1294 253 # are long field names they will not overlap so easily.
Chris@1294 254 # Default it false, to turn on set to true.
Chris@1294 255 attr_accessor :stagger_x_labels
Chris@1294 256 # This puts the Y labels at alternative levels so if they
Chris@1294 257 # are long field names they will not overlap so easily.
Chris@1294 258 # Default it false, to turn on set to true.
Chris@1294 259 attr_accessor :stagger_y_labels
Chris@1294 260 # This turns the X axis labels by 90 degrees.
Chris@1294 261 # Default it false, to turn on set to true.
Chris@1294 262 attr_accessor :rotate_x_labels
Chris@1294 263 # This turns the Y axis labels by 90 degrees.
Chris@1294 264 # Default it false, to turn on set to true.
Chris@1294 265 attr_accessor :rotate_y_labels
Chris@1294 266 # How many "steps" to use between displayed X axis labels,
Chris@1294 267 # a step of one means display every label, a step of two results
Chris@1294 268 # in every other label being displayed (label <gap> label <gap> label),
Chris@1294 269 # a step of three results in every third label being displayed
Chris@1294 270 # (label <gap> <gap> label <gap> <gap> label) and so on.
Chris@1294 271 attr_accessor :step_x_labels
Chris@1294 272 # Whether to (when taking "steps" between X axis labels) step from
Chris@1294 273 # the first label (i.e. always include the first label) or step from
Chris@1294 274 # the X axis origin (i.e. start with a gap if step_x_labels is greater
Chris@1294 275 # than one).
Chris@1294 276 attr_accessor :step_include_first_x_label
Chris@1294 277 # Whether to show labels on the Y axis or not, defaults
Chris@1294 278 # to true, set to false if you want to turn them off.
Chris@1294 279 attr_accessor :show_y_labels
Chris@1294 280 # Ensures only whole numbers are used as the scale divisions.
Chris@1294 281 # Default it false, to turn on set to true. This has no effect if
Chris@1294 282 # scale divisions are less than 1.
Chris@1294 283 attr_accessor :scale_integers
Chris@1294 284 # This defines the gap between markers on the Y axis,
Chris@1294 285 # default is a 10th of the max_value, e.g. you will have
Chris@1294 286 # 10 markers on the Y axis. NOTE: do not set this too
Chris@1294 287 # low - you are limited to 999 markers, after that the
Chris@1294 288 # graph won't generate.
Chris@1294 289 attr_accessor :scale_divisions
Chris@1294 290 # Whether to show the title under the X axis labels,
Chris@1294 291 # default is false, set to true to show.
Chris@1294 292 attr_accessor :show_x_title
Chris@1294 293 # What the title under X axis should be, e.g. 'Months'.
Chris@1294 294 attr_accessor :x_title
Chris@1294 295 # Whether to show the title under the Y axis labels,
Chris@1294 296 # default is false, set to true to show.
Chris@1294 297 attr_accessor :show_y_title
Chris@1294 298 # Aligns writing mode for Y axis label.
Chris@1294 299 # Defaults to :bt (Bottom to Top).
Chris@1294 300 # Change to :tb (Top to Bottom) to reverse.
Chris@1294 301 attr_accessor :y_title_text_direction
Chris@1294 302 # What the title under Y axis should be, e.g. 'Sales in thousands'.
Chris@1294 303 attr_accessor :y_title
Chris@1294 304 # Whether to show a title on the graph, defaults
Chris@1294 305 # to false, set to true to show.
Chris@1294 306 attr_accessor :show_graph_title
Chris@1294 307 # What the title on the graph should be.
Chris@1294 308 attr_accessor :graph_title
Chris@1294 309 # Whether to show a subtitle on the graph, defaults
Chris@1294 310 # to false, set to true to show.
Chris@1294 311 attr_accessor :show_graph_subtitle
Chris@1294 312 # What the subtitle on the graph should be.
Chris@1294 313 attr_accessor :graph_subtitle
Chris@1294 314 # Whether to show a key, defaults to false, set to
Chris@1294 315 # true if you want to show it.
Chris@1294 316 attr_accessor :key
Chris@1294 317 # Where the key should be positioned, defaults to
Chris@1294 318 # :right, set to :bottom if you want to move it.
Chris@1294 319 attr_accessor :key_position
Chris@1294 320 # Set the font size (in points) of the data point labels
Chris@1294 321 attr_accessor :font_size
Chris@1294 322 # Set the font size of the X axis labels
Chris@1294 323 attr_accessor :x_label_font_size
Chris@1294 324 # Set the font size of the X axis title
Chris@1294 325 attr_accessor :x_title_font_size
Chris@1294 326 # Set the font size of the Y axis labels
Chris@1294 327 attr_accessor :y_label_font_size
Chris@1294 328 # Set the font size of the Y axis title
Chris@1294 329 attr_accessor :y_title_font_size
Chris@1294 330 # Set the title font size
Chris@1294 331 attr_accessor :title_font_size
Chris@1294 332 # Set the subtitle font size
Chris@1294 333 attr_accessor :subtitle_font_size
Chris@1294 334 # Set the key font size
Chris@1294 335 attr_accessor :key_font_size
Chris@1294 336 # Show guidelines for the X axis
Chris@1294 337 attr_accessor :show_x_guidelines
Chris@1294 338 # Show guidelines for the Y axis
Chris@1294 339 attr_accessor :show_y_guidelines
Chris@1294 340 # Do not use CSS if set to true. Many SVG viewers do not support CSS, but
Chris@1294 341 # not using CSS can result in larger SVGs as well as making it impossible to
Chris@1294 342 # change colors after the chart is generated. Defaults to false.
Chris@1294 343 attr_accessor :no_css
Chris@1294 344 # Add popups for the data points on some graphs
Chris@1294 345 attr_accessor :add_popups
Chris@1294 346
Chris@1294 347
Chris@1294 348 protected
Chris@1294 349
Chris@1294 350 def sort( *arrys )
Chris@1294 351 sort_multiple( arrys )
Chris@1294 352 end
Chris@1294 353
Chris@1294 354 # Overwrite configuration options with supplied options. Used
Chris@1294 355 # by subclasses.
Chris@1294 356 def init_with config
Chris@1294 357 config.each { |key, value|
Chris@1294 358 self.send((key.to_s+"=").to_sym, value ) if respond_to? key.to_sym
Chris@1294 359 }
Chris@1294 360 end
Chris@1294 361
Chris@1294 362 attr_accessor :top_align, :top_font, :right_align, :right_font
Chris@1294 363
Chris@1294 364 KEY_BOX_SIZE = 12
Chris@1294 365
Chris@1294 366 # Override this (and call super) to change the margin to the left
Chris@1294 367 # of the plot area. Results in @border_left being set.
Chris@1294 368 def calculate_left_margin
Chris@1294 369 @border_left = 7
Chris@1294 370 # Check for Y labels
Chris@1294 371 max_y_label_height_px = rotate_y_labels ?
Chris@1294 372 y_label_font_size :
Chris@1294 373 get_y_labels.max{|a,b|
Chris@1294 374 a.to_s.length<=>b.to_s.length
Chris@1294 375 }.to_s.length * y_label_font_size * 0.6
Chris@1294 376 @border_left += max_y_label_height_px if show_y_labels
Chris@1294 377 @border_left += max_y_label_height_px + 10 if stagger_y_labels
Chris@1294 378 @border_left += y_title_font_size + 5 if show_y_title
Chris@1294 379 end
Chris@1294 380
Chris@1294 381
Chris@1294 382 # Calculates the width of the widest Y label. This will be the
Chris@1294 383 # character height if the Y labels are rotated
Chris@1294 384 def max_y_label_width_px
Chris@1294 385 return font_size if rotate_y_labels
Chris@1294 386 end
Chris@1294 387
Chris@1294 388
Chris@1294 389 # Override this (and call super) to change the margin to the right
Chris@1294 390 # of the plot area. Results in @border_right being set.
Chris@1294 391 def calculate_right_margin
Chris@1294 392 @border_right = 7
Chris@1294 393 if key and key_position == :right
Chris@1294 394 val = keys.max { |a,b| a.length <=> b.length }
Chris@1294 395 @border_right += val.length * key_font_size * 0.6
Chris@1294 396 @border_right += KEY_BOX_SIZE
Chris@1294 397 @border_right += 10 # Some padding around the box
Chris@1294 398 end
Chris@1294 399 end
Chris@1294 400
Chris@1294 401
Chris@1294 402 # Override this (and call super) to change the margin to the top
Chris@1294 403 # of the plot area. Results in @border_top being set.
Chris@1294 404 def calculate_top_margin
Chris@1294 405 @border_top = 5
Chris@1294 406 @border_top += title_font_size if show_graph_title
Chris@1294 407 @border_top += 5
Chris@1294 408 @border_top += subtitle_font_size if show_graph_subtitle
Chris@1294 409 end
Chris@1294 410
Chris@1294 411
Chris@1294 412 # Adds pop-up point information to a graph.
Chris@1294 413 def add_popup( x, y, label )
Chris@1294 414 txt_width = label.length * font_size * 0.6 + 10
Chris@1294 415 tx = (x+txt_width > width ? x-5 : x+5)
Chris@1294 416 t = @foreground.add_element( "text", {
Chris@1294 417 "x" => tx.to_s,
Chris@1294 418 "y" => (y - font_size).to_s,
Chris@1294 419 "visibility" => "hidden",
Chris@1294 420 })
Chris@1294 421 t.attributes["style"] = "fill: #000; "+
Chris@1294 422 (x+txt_width > width ? "text-anchor: end;" : "text-anchor: start;")
Chris@1294 423 t.text = label.to_s
Chris@1294 424 t.attributes["id"] = t.object_id.to_s
Chris@1294 425
Chris@1294 426 @foreground.add_element( "circle", {
Chris@1294 427 "cx" => x.to_s,
Chris@1294 428 "cy" => y.to_s,
Chris@1294 429 "r" => "10",
Chris@1294 430 "style" => "opacity: 0",
Chris@1294 431 "onmouseover" =>
Chris@1294 432 "document.getElementById(#{t.object_id}).setAttribute('visibility', 'visible' )",
Chris@1294 433 "onmouseout" =>
Chris@1294 434 "document.getElementById(#{t.object_id}).setAttribute('visibility', 'hidden' )",
Chris@1294 435 })
Chris@1294 436
Chris@1294 437 end
Chris@1294 438
Chris@1294 439
Chris@1294 440 # Override this (and call super) to change the margin to the bottom
Chris@1294 441 # of the plot area. Results in @border_bottom being set.
Chris@1294 442 def calculate_bottom_margin
Chris@1294 443 @border_bottom = 7
Chris@1294 444 if key and key_position == :bottom
Chris@1294 445 @border_bottom += @data.size * (font_size + 5)
Chris@1294 446 @border_bottom += 10
Chris@1294 447 end
Chris@1294 448 if show_x_labels
Chris@1294 449 max_x_label_height_px = (not rotate_x_labels) ?
Chris@1294 450 x_label_font_size :
Chris@1294 451 get_x_labels.max{|a,b|
Chris@1294 452 a.to_s.length<=>b.to_s.length
Chris@1294 453 }.to_s.length * x_label_font_size * 0.6
Chris@1294 454 @border_bottom += max_x_label_height_px
Chris@1294 455 @border_bottom += max_x_label_height_px + 10 if stagger_x_labels
Chris@1294 456 end
Chris@1294 457 @border_bottom += x_title_font_size + 5 if show_x_title
Chris@1294 458 end
Chris@1294 459
Chris@1294 460
Chris@1294 461 # Draws the background, axis, and labels.
Chris@1294 462 def draw_graph
Chris@1294 463 @graph = @root.add_element( "g", {
Chris@1294 464 "transform" => "translate( #@border_left #@border_top )"
Chris@1294 465 })
Chris@1294 466
Chris@1294 467 # Background
Chris@1294 468 @graph.add_element( "rect", {
Chris@1294 469 "x" => "0",
Chris@1294 470 "y" => "0",
Chris@1294 471 "width" => @graph_width.to_s,
Chris@1294 472 "height" => @graph_height.to_s,
Chris@1294 473 "class" => "graphBackground"
Chris@1294 474 })
Chris@1294 475
Chris@1294 476 # Axis
Chris@1294 477 @graph.add_element( "path", {
Chris@1294 478 "d" => "M 0 0 v#@graph_height",
Chris@1294 479 "class" => "axis",
Chris@1294 480 "id" => "xAxis"
Chris@1294 481 })
Chris@1294 482 @graph.add_element( "path", {
Chris@1294 483 "d" => "M 0 #@graph_height h#@graph_width",
Chris@1294 484 "class" => "axis",
Chris@1294 485 "id" => "yAxis"
Chris@1294 486 })
Chris@1294 487
Chris@1294 488 draw_x_labels
Chris@1294 489 draw_y_labels
Chris@1294 490 end
Chris@1294 491
Chris@1294 492
Chris@1294 493 # Where in the X area the label is drawn
Chris@1294 494 # Centered in the field, should be width/2. Start, 0.
Chris@1294 495 def x_label_offset( width )
Chris@1294 496 0
Chris@1294 497 end
Chris@1294 498
Chris@1294 499 def make_datapoint_text( x, y, value, style="" )
Chris@1294 500 if show_data_values
Chris@1294 501 @foreground.add_element( "text", {
Chris@1294 502 "x" => x.to_s,
Chris@1294 503 "y" => y.to_s,
Chris@1294 504 "class" => "dataPointLabel",
Chris@1294 505 "style" => "#{style} stroke: #fff; stroke-width: 2;"
Chris@1294 506 }).text = value.to_s
Chris@1294 507 text = @foreground.add_element( "text", {
Chris@1294 508 "x" => x.to_s,
Chris@1294 509 "y" => y.to_s,
Chris@1294 510 "class" => "dataPointLabel"
Chris@1294 511 })
Chris@1294 512 text.text = value.to_s
Chris@1294 513 text.attributes["style"] = style if style.length > 0
Chris@1294 514 end
Chris@1294 515 end
Chris@1294 516
Chris@1294 517
Chris@1294 518 # Draws the X axis labels
Chris@1294 519 def draw_x_labels
Chris@1294 520 stagger = x_label_font_size + 5
Chris@1294 521 if show_x_labels
Chris@1294 522 label_width = field_width
Chris@1294 523
Chris@1294 524 count = 0
Chris@1294 525 for label in get_x_labels
Chris@1294 526 if step_include_first_x_label == true then
Chris@1294 527 step = count % step_x_labels
Chris@1294 528 else
Chris@1294 529 step = (count + 1) % step_x_labels
Chris@1294 530 end
Chris@1294 531
Chris@1294 532 if step == 0 then
Chris@1294 533 text = @graph.add_element( "text" )
Chris@1294 534 text.attributes["class"] = "xAxisLabels"
Chris@1294 535 text.text = label.to_s
Chris@1294 536
Chris@1294 537 x = count * label_width + x_label_offset( label_width )
Chris@1294 538 y = @graph_height + x_label_font_size + 3
Chris@1294 539 t = 0 - (font_size / 2)
Chris@1294 540
Chris@1294 541 if stagger_x_labels and count % 2 == 1
Chris@1294 542 y += stagger
Chris@1294 543 @graph.add_element( "path", {
Chris@1294 544 "d" => "M#{x} #@graph_height v#{stagger}",
Chris@1294 545 "class" => "staggerGuideLine"
Chris@1294 546 })
Chris@1294 547 end
Chris@1294 548
Chris@1294 549 text.attributes["x"] = x.to_s
Chris@1294 550 text.attributes["y"] = y.to_s
Chris@1294 551 if rotate_x_labels
Chris@1294 552 text.attributes["transform"] =
Chris@1294 553 "rotate( 90 #{x} #{y-x_label_font_size} )"+
Chris@1294 554 " translate( 0 -#{x_label_font_size/4} )"
Chris@1294 555 text.attributes["style"] = "text-anchor: start"
Chris@1294 556 else
Chris@1294 557 text.attributes["style"] = "text-anchor: middle"
Chris@1294 558 end
Chris@1294 559 end
Chris@1294 560
Chris@1294 561 draw_x_guidelines( label_width, count ) if show_x_guidelines
Chris@1294 562 count += 1
Chris@1294 563 end
Chris@1294 564 end
Chris@1294 565 end
Chris@1294 566
Chris@1294 567
Chris@1294 568 # Where in the Y area the label is drawn
Chris@1294 569 # Centered in the field, should be width/2. Start, 0.
Chris@1294 570 def y_label_offset( height )
Chris@1294 571 0
Chris@1294 572 end
Chris@1294 573
Chris@1294 574
Chris@1294 575 def field_width
Chris@1294 576 (@graph_width.to_f - font_size*2*right_font) /
Chris@1294 577 (get_x_labels.length - right_align)
Chris@1294 578 end
Chris@1294 579
Chris@1294 580
Chris@1294 581 def field_height
Chris@1294 582 (@graph_height.to_f - font_size*2*top_font) /
Chris@1294 583 (get_y_labels.length - top_align)
Chris@1294 584 end
Chris@1294 585
Chris@1294 586
Chris@1294 587 # Draws the Y axis labels
Chris@1294 588 def draw_y_labels
Chris@1294 589 stagger = y_label_font_size + 5
Chris@1294 590 if show_y_labels
Chris@1294 591 label_height = field_height
Chris@1294 592
Chris@1294 593 count = 0
Chris@1294 594 y_offset = @graph_height + y_label_offset( label_height )
Chris@1294 595 y_offset += font_size/1.2 unless rotate_y_labels
Chris@1294 596 for label in get_y_labels
Chris@1294 597 y = y_offset - (label_height * count)
Chris@1294 598 x = rotate_y_labels ? 0 : -3
Chris@1294 599
Chris@1294 600 if stagger_y_labels and count % 2 == 1
Chris@1294 601 x -= stagger
Chris@1294 602 @graph.add_element( "path", {
Chris@1294 603 "d" => "M#{x} #{y} h#{stagger}",
Chris@1294 604 "class" => "staggerGuideLine"
Chris@1294 605 })
Chris@1294 606 end
Chris@1294 607
Chris@1294 608 text = @graph.add_element( "text", {
Chris@1294 609 "x" => x.to_s,
Chris@1294 610 "y" => y.to_s,
Chris@1294 611 "class" => "yAxisLabels"
Chris@1294 612 })
Chris@1294 613 text.text = label.to_s
Chris@1294 614 if rotate_y_labels
Chris@1294 615 text.attributes["transform"] = "translate( -#{font_size} 0 ) "+
Chris@1294 616 "rotate( 90 #{x} #{y} ) "
Chris@1294 617 text.attributes["style"] = "text-anchor: middle"
Chris@1294 618 else
Chris@1294 619 text.attributes["y"] = (y - (y_label_font_size/2)).to_s
Chris@1294 620 text.attributes["style"] = "text-anchor: end"
Chris@1294 621 end
Chris@1294 622 draw_y_guidelines( label_height, count ) if show_y_guidelines
Chris@1294 623 count += 1
Chris@1294 624 end
Chris@1294 625 end
Chris@1294 626 end
Chris@1294 627
Chris@1294 628
Chris@1294 629 # Draws the X axis guidelines
Chris@1294 630 def draw_x_guidelines( label_height, count )
Chris@1294 631 if count != 0
Chris@1294 632 @graph.add_element( "path", {
Chris@1294 633 "d" => "M#{label_height*count} 0 v#@graph_height",
Chris@1294 634 "class" => "guideLines"
Chris@1294 635 })
Chris@1294 636 end
Chris@1294 637 end
Chris@1294 638
Chris@1294 639
Chris@1294 640 # Draws the Y axis guidelines
Chris@1294 641 def draw_y_guidelines( label_height, count )
Chris@1294 642 if count != 0
Chris@1294 643 @graph.add_element( "path", {
Chris@1294 644 "d" => "M0 #{@graph_height-(label_height*count)} h#@graph_width",
Chris@1294 645 "class" => "guideLines"
Chris@1294 646 })
Chris@1294 647 end
Chris@1294 648 end
Chris@1294 649
Chris@1294 650
Chris@1294 651 # Draws the graph title and subtitle
Chris@1294 652 def draw_titles
Chris@1294 653 if show_graph_title
Chris@1294 654 @root.add_element( "text", {
Chris@1294 655 "x" => (width / 2).to_s,
Chris@1294 656 "y" => (title_font_size).to_s,
Chris@1294 657 "class" => "mainTitle"
Chris@1294 658 }).text = graph_title.to_s
Chris@1294 659 end
Chris@1294 660
Chris@1294 661 if show_graph_subtitle
Chris@1294 662 y_subtitle = show_graph_title ?
Chris@1294 663 title_font_size + 10 :
Chris@1294 664 subtitle_font_size
Chris@1294 665 @root.add_element("text", {
Chris@1294 666 "x" => (width / 2).to_s,
Chris@1294 667 "y" => (y_subtitle).to_s,
Chris@1294 668 "class" => "subTitle"
Chris@1294 669 }).text = graph_subtitle.to_s
Chris@1294 670 end
Chris@1294 671
Chris@1294 672 if show_x_title
Chris@1294 673 y = @graph_height + @border_top + x_title_font_size
Chris@1294 674 if show_x_labels
Chris@1294 675 y += x_label_font_size + 5 if stagger_x_labels
Chris@1294 676 y += x_label_font_size + 5
Chris@1294 677 end
Chris@1294 678 x = width / 2
Chris@1294 679
Chris@1294 680 @root.add_element("text", {
Chris@1294 681 "x" => x.to_s,
Chris@1294 682 "y" => y.to_s,
Chris@1294 683 "class" => "xAxisTitle",
Chris@1294 684 }).text = x_title.to_s
Chris@1294 685 end
Chris@1294 686
Chris@1294 687 if show_y_title
Chris@1294 688 x = y_title_font_size + (y_title_text_direction==:bt ? 3 : -3)
Chris@1294 689 y = height / 2
Chris@1294 690
Chris@1294 691 text = @root.add_element("text", {
Chris@1294 692 "x" => x.to_s,
Chris@1294 693 "y" => y.to_s,
Chris@1294 694 "class" => "yAxisTitle",
Chris@1294 695 })
Chris@1294 696 text.text = y_title.to_s
Chris@1294 697 if y_title_text_direction == :bt
Chris@1294 698 text.attributes["transform"] = "rotate( -90, #{x}, #{y} )"
Chris@1294 699 else
Chris@1294 700 text.attributes["transform"] = "rotate( 90, #{x}, #{y} )"
Chris@1294 701 end
Chris@1294 702 end
Chris@1294 703 end
Chris@1294 704
Chris@1294 705 def keys
Chris@1294 706 return @data.collect{ |d| d[:title] }
Chris@1294 707 end
Chris@1294 708
Chris@1294 709 # Draws the legend on the graph
Chris@1294 710 def draw_legend
Chris@1294 711 if key
Chris@1294 712 group = @root.add_element( "g" )
Chris@1294 713
Chris@1294 714 key_count = 0
Chris@1294 715 for key_name in keys
Chris@1294 716 y_offset = (KEY_BOX_SIZE * key_count) + (key_count * 5)
Chris@1294 717 group.add_element( "rect", {
Chris@1294 718 "x" => 0.to_s,
Chris@1294 719 "y" => y_offset.to_s,
Chris@1294 720 "width" => KEY_BOX_SIZE.to_s,
Chris@1294 721 "height" => KEY_BOX_SIZE.to_s,
Chris@1294 722 "class" => "key#{key_count+1}"
Chris@1294 723 })
Chris@1294 724 group.add_element( "text", {
Chris@1294 725 "x" => (KEY_BOX_SIZE + 5).to_s,
Chris@1294 726 "y" => (y_offset + KEY_BOX_SIZE).to_s,
Chris@1294 727 "class" => "keyText"
Chris@1294 728 }).text = key_name.to_s
Chris@1294 729 key_count += 1
Chris@1294 730 end
Chris@1294 731
Chris@1294 732 case key_position
Chris@1294 733 when :right
Chris@1294 734 x_offset = @graph_width + @border_left + 10
Chris@1294 735 y_offset = @border_top + 20
Chris@1294 736 when :bottom
Chris@1294 737 x_offset = @border_left + 20
Chris@1294 738 y_offset = @border_top + @graph_height + 5
Chris@1294 739 if show_x_labels
Chris@1294 740 max_x_label_height_px = (not rotate_x_labels) ?
Chris@1294 741 x_label_font_size :
Chris@1294 742 get_x_labels.max{|a,b|
Chris@1294 743 a.to_s.length<=>b.to_s.length
Chris@1294 744 }.to_s.length * x_label_font_size * 0.6
Chris@1294 745 x_label_font_size
Chris@1294 746 y_offset += max_x_label_height_px
Chris@1294 747 y_offset += max_x_label_height_px + 5 if stagger_x_labels
Chris@1294 748 end
Chris@1294 749 y_offset += x_title_font_size + 5 if show_x_title
Chris@1294 750 end
Chris@1294 751 group.attributes["transform"] = "translate(#{x_offset} #{y_offset})"
Chris@1294 752 end
Chris@1294 753 end
Chris@1294 754
Chris@1294 755
Chris@1294 756 private
Chris@1294 757
Chris@1294 758 def sort_multiple( arrys, lo=0, hi=arrys[0].length-1 )
Chris@1294 759 if lo < hi
Chris@1294 760 p = partition(arrys,lo,hi)
Chris@1294 761 sort_multiple(arrys, lo, p-1)
Chris@1294 762 sort_multiple(arrys, p+1, hi)
Chris@1294 763 end
Chris@1294 764 arrys
Chris@1294 765 end
Chris@1294 766
Chris@1294 767 def partition( arrys, lo, hi )
Chris@1294 768 p = arrys[0][lo]
Chris@1294 769 l = lo
Chris@1294 770 z = lo+1
Chris@1294 771 while z <= hi
Chris@1294 772 if arrys[0][z] < p
Chris@1294 773 l += 1
Chris@1294 774 arrys.each { |arry| arry[z], arry[l] = arry[l], arry[z] }
Chris@1294 775 end
Chris@1294 776 z += 1
Chris@1294 777 end
Chris@1294 778 arrys.each { |arry| arry[lo], arry[l] = arry[l], arry[lo] }
Chris@1294 779 l
Chris@1294 780 end
Chris@1294 781
Chris@1294 782 def style
Chris@1294 783 if no_css
Chris@1294 784 styles = parse_css
Chris@1294 785 @root.elements.each("//*[@class]") { |el|
Chris@1294 786 cl = el.attributes["class"]
Chris@1294 787 style = styles[cl]
Chris@1294 788 style += el.attributes["style"] if el.attributes["style"]
Chris@1294 789 el.attributes["style"] = style
Chris@1294 790 }
Chris@1294 791 end
Chris@1294 792 end
Chris@1294 793
Chris@1294 794 def parse_css
Chris@1294 795 css = get_style
Chris@1294 796 rv = {}
Chris@1294 797 while css =~ /^(\.(\w+)(?:\s*,\s*\.\w+)*)\s*\{/m
Chris@1294 798 names_orig = names = $1
Chris@1294 799 css = $'
Chris@1294 800 css =~ /([^}]+)\}/m
Chris@1294 801 content = $1
Chris@1294 802 css = $'
Chris@1294 803
Chris@1294 804 nms = []
Chris@1294 805 while names =~ /^\s*,?\s*\.(\w+)/
Chris@1294 806 nms << $1
Chris@1294 807 names = $'
Chris@1294 808 end
Chris@1294 809
Chris@1294 810 content = content.tr( "\n\t", " ")
Chris@1294 811 for name in nms
Chris@1294 812 current = rv[name]
Chris@1294 813 current = current ? current+"; "+content : content
Chris@1294 814 rv[name] = current.strip.squeeze(" ")
Chris@1294 815 end
Chris@1294 816 end
Chris@1294 817 return rv
Chris@1294 818 end
Chris@1294 819
Chris@1294 820
Chris@1294 821 # Override and place code to add defs here
Chris@1294 822 def add_defs defs
Chris@1294 823 end
Chris@1294 824
Chris@1294 825
Chris@1294 826 def start_svg
Chris@1294 827 # Base document
Chris@1294 828 @doc = Document.new
Chris@1294 829 @doc << XMLDecl.new
Chris@1294 830 @doc << DocType.new( %q{svg PUBLIC "-//W3C//DTD SVG 1.0//EN" } +
Chris@1294 831 %q{"http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd"} )
Chris@1294 832 if style_sheet && style_sheet != ''
Chris@1294 833 @doc << Instruction.new( "xml-stylesheet",
Chris@1294 834 %Q{href="#{style_sheet}" type="text/css"} )
Chris@1294 835 end
Chris@1294 836 @root = @doc.add_element( "svg", {
Chris@1294 837 "width" => width.to_s,
Chris@1294 838 "height" => height.to_s,
Chris@1294 839 "viewBox" => "0 0 #{width} #{height}",
Chris@1294 840 "xmlns" => "http://www.w3.org/2000/svg",
Chris@1294 841 "xmlns:xlink" => "http://www.w3.org/1999/xlink",
Chris@1294 842 "xmlns:a3" => "http://ns.adobe.com/AdobeSVGViewerExtensions/3.0/",
Chris@1294 843 "a3:scriptImplementation" => "Adobe"
Chris@1294 844 })
Chris@1294 845 @root << Comment.new( " "+"\\"*66 )
Chris@1294 846 @root << Comment.new( " Created with SVG::Graph " )
Chris@1294 847 @root << Comment.new( " SVG::Graph by Sean E. Russell " )
Chris@1294 848 @root << Comment.new( " Losely based on SVG::TT::Graph for Perl by"+
Chris@1294 849 " Leo Lapworth & Stephan Morgan " )
Chris@1294 850 @root << Comment.new( " "+"/"*66 )
Chris@1294 851
Chris@1294 852 defs = @root.add_element( "defs" )
Chris@1294 853 add_defs defs
Chris@1294 854 if not(style_sheet && style_sheet != '') and !no_css
Chris@1294 855 @root << Comment.new(" include default stylesheet if none specified ")
Chris@1294 856 style = defs.add_element( "style", {"type"=>"text/css"} )
Chris@1294 857 style << CData.new( get_style )
Chris@1294 858 end
Chris@1294 859
Chris@1294 860 @root << Comment.new( "SVG Background" )
Chris@1294 861 @root.add_element( "rect", {
Chris@1294 862 "width" => width.to_s,
Chris@1294 863 "height" => height.to_s,
Chris@1294 864 "x" => "0",
Chris@1294 865 "y" => "0",
Chris@1294 866 "class" => "svgBackground"
Chris@1294 867 })
Chris@1294 868 end
Chris@1294 869
Chris@1294 870
Chris@1294 871 def calculate_graph_dimensions
Chris@1294 872 calculate_left_margin
Chris@1294 873 calculate_right_margin
Chris@1294 874 calculate_bottom_margin
Chris@1294 875 calculate_top_margin
Chris@1294 876 @graph_width = width - @border_left - @border_right
Chris@1294 877 @graph_height = height - @border_top - @border_bottom
Chris@1294 878 end
Chris@1294 879
Chris@1294 880 def get_style
Chris@1294 881 return <<EOL
Chris@1294 882 /* Copy from here for external style sheet */
Chris@1294 883 .svgBackground{
Chris@1294 884 fill:#ffffff;
Chris@1294 885 }
Chris@1294 886 .graphBackground{
Chris@1294 887 fill:#f0f0f0;
Chris@1294 888 }
Chris@1294 889
Chris@1294 890 /* graphs titles */
Chris@1294 891 .mainTitle{
Chris@1294 892 text-anchor: middle;
Chris@1294 893 fill: #000000;
Chris@1294 894 font-size: #{title_font_size}px;
Chris@1294 895 font-family: "Arial", sans-serif;
Chris@1294 896 font-weight: normal;
Chris@1294 897 }
Chris@1294 898 .subTitle{
Chris@1294 899 text-anchor: middle;
Chris@1294 900 fill: #999999;
Chris@1294 901 font-size: #{subtitle_font_size}px;
Chris@1294 902 font-family: "Arial", sans-serif;
Chris@1294 903 font-weight: normal;
Chris@1294 904 }
Chris@1294 905
Chris@1294 906 .axis{
Chris@1294 907 stroke: #000000;
Chris@1294 908 stroke-width: 1px;
Chris@1294 909 }
Chris@1294 910
Chris@1294 911 .guideLines{
Chris@1294 912 stroke: #666666;
Chris@1294 913 stroke-width: 1px;
Chris@1294 914 stroke-dasharray: 5 5;
Chris@1294 915 }
Chris@1294 916
Chris@1294 917 .xAxisLabels{
Chris@1294 918 text-anchor: middle;
Chris@1294 919 fill: #000000;
Chris@1294 920 font-size: #{x_label_font_size}px;
Chris@1294 921 font-family: "Arial", sans-serif;
Chris@1294 922 font-weight: normal;
Chris@1294 923 }
Chris@1294 924
Chris@1294 925 .yAxisLabels{
Chris@1294 926 text-anchor: end;
Chris@1294 927 fill: #000000;
Chris@1294 928 font-size: #{y_label_font_size}px;
Chris@1294 929 font-family: "Arial", sans-serif;
Chris@1294 930 font-weight: normal;
Chris@1294 931 }
Chris@1294 932
Chris@1294 933 .xAxisTitle{
Chris@1294 934 text-anchor: middle;
Chris@1294 935 fill: #ff0000;
Chris@1294 936 font-size: #{x_title_font_size}px;
Chris@1294 937 font-family: "Arial", sans-serif;
Chris@1294 938 font-weight: normal;
Chris@1294 939 }
Chris@1294 940
Chris@1294 941 .yAxisTitle{
Chris@1294 942 fill: #ff0000;
Chris@1294 943 text-anchor: middle;
Chris@1294 944 font-size: #{y_title_font_size}px;
Chris@1294 945 font-family: "Arial", sans-serif;
Chris@1294 946 font-weight: normal;
Chris@1294 947 }
Chris@1294 948
Chris@1294 949 .dataPointLabel{
Chris@1294 950 fill: #000000;
Chris@1294 951 text-anchor:middle;
Chris@1294 952 font-size: 10px;
Chris@1294 953 font-family: "Arial", sans-serif;
Chris@1294 954 font-weight: normal;
Chris@1294 955 }
Chris@1294 956
Chris@1294 957 .staggerGuideLine{
Chris@1294 958 fill: none;
Chris@1294 959 stroke: #000000;
Chris@1294 960 stroke-width: 0.5px;
Chris@1294 961 }
Chris@1294 962
Chris@1294 963 #{get_css}
Chris@1294 964
Chris@1294 965 .keyText{
Chris@1294 966 fill: #000000;
Chris@1294 967 text-anchor:start;
Chris@1294 968 font-size: #{key_font_size}px;
Chris@1294 969 font-family: "Arial", sans-serif;
Chris@1294 970 font-weight: normal;
Chris@1294 971 }
Chris@1294 972 /* End copy for external style sheet */
Chris@1294 973 EOL
Chris@1294 974 end
Chris@1294 975
Chris@1294 976 end
Chris@1294 977 end
Chris@1294 978 end