Class: Scruffy::Layers::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/scruffy/layers/base.rb

Overview

Scruffy::Layers::Base

Author

Brasten Sager

Extended By

A.J. Ostman

Created

August 5th, 2006

Last Modified

August 27, 2006

Scruffy::Layers::Base contains the basic functionality needed by the various types of graphs. The Base class is responsible holding layer information such as the title and data points.

When the graph is rendered, the graph renderer calls Base#render. Base#render sets up some standard information, and calculates the x,y coordinates of each data point. The draw() method, which should have been overridden by the current instance, is then called. The actual rendering of the graph takes place there.

Create New Graph Types

Assuming the information generated by Scruffy::Layers::Base is sufficient, you can create a new graph type simply by overriding the draw() method. See Base#draw for arguments.

Direct Known Subclasses

AllSmiles, Area, Average, Bar, Line, Pie, PieSlice, Scatter, SparklineBar, Stacked

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Base

Returns a new Base object.

Any options other that those specified below are stored in the @options variable for possible later use. This would be a good place to store options needed for a custom graph.

Options:

title

Name/title of data group

points

Array of data points

preferred_color

Color used to render this graph, overrides theme color.

relevant_data

Rarely used - indicates the data on this graph should not included in any graph data aggregations, such as averaging data points.



52
53
54
55
56
57
58
59
60
 
# File 'lib/scruffy/layers/base.rb', line 52

def initialize(options = {})
  @title              = options.delete(:title) || ''
  @preferred_color    = options.delete(:preferred_color)
  @relevant_data      = options.delete(:relevant_data) || true
  @points             = options.delete(:points) || []
  @points.extend Scruffy::Helpers::PointContainer unless @points.kind_of? Scruffy::Helpers::PointContainer
  
  @options            = options
end

Instance Attribute Details

#color ⇒ Object (readonly)

Returns the value of attribute color.



36
37
38
 
# File 'lib/scruffy/layers/base.rb', line 36

def color
  @color
end

#complexity ⇒ Object (readonly)

Returns the value of attribute complexity.



38
39
40
 
# File 'lib/scruffy/layers/base.rb', line 38

def complexity
  @complexity
end

#height ⇒ Object (readonly)

The following attributes are set during the layer’s render process, and act more as a record of what just happened for later processes. height, width, min_value, max_value, color, opacity, complexity



34
35
36
 
# File 'lib/scruffy/layers/base.rb', line 34

def height
  @height
end

#max_value ⇒ Object (readonly)

Returns the value of attribute max_value.



35
36
37
 
# File 'lib/scruffy/layers/base.rb', line 35

def max_value
  @max_value
end

#min_value ⇒ Object (readonly)

Returns the value of attribute min_value.



35
36
37
 
# File 'lib/scruffy/layers/base.rb', line 35

def min_value
  @min_value
end

#opacity ⇒ Object (readonly)

Returns the value of attribute opacity.



37
38
39
 
# File 'lib/scruffy/layers/base.rb', line 37

def opacity
  @opacity
end

#options ⇒ Object

On-the-fly values for easy customization / acts as attributes.



29
30
31
 
# File 'lib/scruffy/layers/base.rb', line 29

def options
  @options
end

#points ⇒ Object

Returns the value of attribute points.



26
27
28
 
# File 'lib/scruffy/layers/base.rb', line 26

def points
  @points
end

#preferred_color ⇒ Object

Returns the value of attribute preferred_color.



28
29
30
 
# File 'lib/scruffy/layers/base.rb', line 28

def preferred_color
  @preferred_color
end

#relevant_data ⇒ Object

Returns the value of attribute relevant_data.



27
28
29
 
# File 'lib/scruffy/layers/base.rb', line 27

def relevant_data
  @relevant_data
end

#title ⇒ Object

The following attributes are user-definable at any time. title, points, relevant_data, preferred_color, options



25
26
27
 
# File 'lib/scruffy/layers/base.rb', line 25

def title
  @title
end

#width ⇒ Object (readonly)

The following attributes are set during the layer’s render process, and act more as a record of what just happened for later processes. height, width, min_value, max_value, color, opacity, complexity



34
35
36
 
# File 'lib/scruffy/layers/base.rb', line 34

def width
  @width
end

Instance Method Details

#bottom_value ⇒ Object

The lowest data point on this layer, or nil if relevant_data == false



112
113
114
 
# File 'lib/scruffy/layers/base.rb', line 112

def bottom_value
   @relevant_data ? points.minimum_value : nil
end

#draw(svg, coords, options = {}) ⇒ Object

The method called by Base#draw to render the graph.

svg

a Builder object to use for creating SVG code.

coords

An array of coordinates relating to the graph’s data points. ie: [[100, 120], [200, 140], [300, 40]]

options

Optional arguments.

Raises:



79
80
81
 
# File 'lib/scruffy/layers/base.rb', line 79

def draw(svg, coords, options={})
  raise RenderError, "You must override the Base#draw method."
end

#legend_data ⇒ Object

Returns a hash with information to be used by the legend.

Alternatively, returns nil if you don’t want this layer to be in the legend, or an array of hashes if this layer should have multiple legend entries (stacked?)

By default, #legend_data returns nil automatically if relevant_data is set to false or the @color attribute is nil. @color is set when the layer is rendered, so legends must be rendered AFTER layers.



91
92
93
94
95
96
97
98
99
 
# File 'lib/scruffy/layers/base.rb', line 91

def legend_data
  if relevant_data? && @color
    {:title => title, 
     :color => @color,
     :priority => :normal}
  else
    nil
  end
end

#relevant_data? ⇒ Boolean

Returns the value of relevant_data

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/scruffy/layers/base.rb', line 102

def relevant_data?
  @relevant_data
end

#render(svg, options = {}) ⇒ Object

Builds SVG code for this graph using the provided Builder object. This method actually generates data needed by this graph, then passes the rendering responsibilities to Base#draw.

svg

a Builder object used to create SVG code.



67
68
69
70
71
72
 
# File 'lib/scruffy/layers/base.rb', line 67

def render(svg, options = {})
  setup_variables(options)
  coords = generate_coordinates(options)

  draw(svg, coords, options)
end

#sum_values ⇒ Object

The sum of all values



117
118
119
 
# File 'lib/scruffy/layers/base.rb', line 117

def sum_values
  points.sum
end

#top_value ⇒ Object

The highest data point on this layer, or nil if relevant_data == false



107
108
109
 
# File 'lib/scruffy/layers/base.rb', line 107

def top_value
  @relevant_data ? points.maximum_value : nil
end