Class: Gruff::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/gruff/base.rb,
lib/gruff.rb

Overview

A common base class inherited from class of drawing a graph.

Constant Summary collapse

LEGEND_MARGIN =

Space around text elements. Mostly used for vertical spacing.

TITLE_MARGIN = 20.0
LABEL_MARGIN =
15.0
DEFAULT_MARGIN =
20.0
DEFAULT_TARGET_WIDTH =
800.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(target_width = DEFAULT_TARGET_WIDTH) ⇒ Base

If one numerical argument is given, the graph is drawn at 4/3 ratio according to the given width (800 results in 800x600, 400 gives 400x300, etc.).

Or, send a geometry string for other ratios ( '800x400', '400x225').

Parameters:

  • target_width (Numeric, String) (defaults to: DEFAULT_TARGET_WIDTH)

    The graph image width.


144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/gruff/base.rb', line 144

def initialize(target_width = DEFAULT_TARGET_WIDTH)
  if target_width.is_a?(String)
    @columns, @rows = target_width.split('x').map(&:to_f)
  else
    @columns = target_width.to_f
    @rows = target_width.to_f * 0.75
  end
  @columns.freeze
  @rows.freeze

  @has_left_labels = false
  @center_labels_over_point = true

  initialize_graph_scale
  initialize_attributes
  initialize_store

  self.theme = Themes::KEYNOTE
end

Instance Attribute Details

#bottom_margin=(value) ⇒ Object (writeonly)

Blank space below the graph. Default is 20.


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

def bottom_margin=(value)
  @bottom_margin = value
end

#colorsObject

Get or set the list of colors that will be used to draw the bars or lines.


89
90
91
# File 'lib/gruff/base.rb', line 89

def colors
  @colors
end

#hide_legend=(value) ⇒ Object (writeonly)

Prevent drawing of the legend. Default is false.


98
99
100
# File 'lib/gruff/base.rb', line 98

def hide_legend=(value)
  @hide_legend = value
end

#hide_line_markers=(value) ⇒ Object (writeonly)

Prevent drawing of line markers. Default is false.


95
96
97
# File 'lib/gruff/base.rb', line 95

def hide_line_markers=(value)
  @hide_line_markers = value
end

#hide_line_numbers=(value) ⇒ Object (writeonly)

Prevent drawing of line numbers. Default is false.


104
105
106
# File 'lib/gruff/base.rb', line 104

def hide_line_numbers=(value)
  @hide_line_numbers = value
end

#hide_title=(value) ⇒ Object (writeonly)

Prevent drawing of the title. Default is false.


101
102
103
# File 'lib/gruff/base.rb', line 101

def hide_title=(value)
  @hide_title = value
end

#label_max_size=(value) ⇒ Object (writeonly)

Truncates labels if longer than max specified.


58
59
60
# File 'lib/gruff/base.rb', line 58

def label_max_size=(value)
  @label_max_size = value
end

#label_stagger_height=(value) ⇒ Object (writeonly)

Height of staggering between labels.


68
69
70
# File 'lib/gruff/base.rb', line 68

def label_stagger_height=(value)
  @label_stagger_height = value
end

#label_truncation_style=(value) ⇒ Object (writeonly)

How truncated labels visually appear if they exceed #label_max_size=.

  • :absolute - does not show trailing dots to indicate truncation. This is the default.

  • :trailing_dots - shows trailing dots to indicate truncation (note that #label_max_size= must be greater than 3).


65
66
67
# File 'lib/gruff/base.rb', line 65

def label_truncation_style=(value)
  @label_truncation_style = value
end

#labels=(value) ⇒ Object (writeonly)

A hash of names for the individual columns, where the key is the array index for the column this label represents.

Not all columns need to be named.

Examples:

{ 0 => 2005, 3 => 2006, 5 => 2007, 7 => 2008 }

55
56
57
# File 'lib/gruff/base.rb', line 55

def labels=(value)
  @labels = value
end

#left_margin=(value) ⇒ Object (writeonly)

Blank space to the left of the graph. Default is 20.


40
41
42
# File 'lib/gruff/base.rb', line 40

def left_margin=(value)
  @left_margin = value
end

#legend_at_bottom=(value) ⇒ Object (writeonly)

Display the legend under the graph. Default is false.


128
129
130
# File 'lib/gruff/base.rb', line 128

def legend_at_bottom=(value)
  @legend_at_bottom = value
end

#legend_box_size=(value) ⇒ Object (writeonly)

Optionally set the size of the colored box by each item in the legend. Default is 20.0.

Will be scaled down if graph is smaller than 800px wide.


134
135
136
# File 'lib/gruff/base.rb', line 134

def legend_box_size=(value)
  @legend_box_size = value
end

#legend_margin=(value) ⇒ Object (writeonly)

Blank space below the legend. Default is 20.


46
47
48
# File 'lib/gruff/base.rb', line 46

def legend_margin=(value)
  @legend_margin = value
end

#marker_color=(value) ⇒ Object (writeonly)

Set the color of the auxiliary lines.


111
112
113
# File 'lib/gruff/base.rb', line 111

def marker_color=(value)
  @marker_color = value
end

#marker_count=(value) ⇒ Object

Set the number of horizontal lines shown for reference.


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

def marker_count=(value)
  @marker_count = value
end

#marker_shadow_color=(value) ⇒ Object (writeonly)

Set the shadow color of the auxiliary lines.


114
115
116
# File 'lib/gruff/base.rb', line 114

def marker_shadow_color=(value)
  @marker_shadow_color = value
end

#maximum_valueObject

You can manually set a maximum value, such as a percentage-based graph that always goes to 100.

If you use this, you must set it after you have given all your data to the graph object.


434
435
436
# File 'lib/gruff/base.rb', line 434

def maximum_value
  (@maximum_value || store.max).to_f
end

#minimum_valueObject

You can manually set a minimum value instead of having the values guessed for you.

Set it after you have given all your data to the graph object.


424
425
426
# File 'lib/gruff/base.rb', line 424

def minimum_value
  (@minimum_value || store.min).to_f
end

#no_data_message=(value) ⇒ Object (writeonly)

Set a message shown when there is no data. Fits up to 20 characters. Defaults to “No Data.”.


108
109
110
# File 'lib/gruff/base.rb', line 108

def no_data_message=(value)
  @no_data_message = value
end

#right_margin=(value) ⇒ Object (writeonly)

Blank space to the right of the graph. Default is 20.


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

def right_margin=(value)
  @right_margin = value
end

#sort=(value) ⇒ Object (writeonly)

Set to true if you want the data sets sorted with largest avg values drawn first. Default is false.


121
122
123
# File 'lib/gruff/base.rb', line 121

def sort=(value)
  @sort = value
end

#sorted_drawing=(value) ⇒ Object (writeonly)

Set to true if you want the data sets drawn with largest avg values drawn first. This does not affect the legend. Default is false.


125
126
127
# File 'lib/gruff/base.rb', line 125

def sorted_drawing=(value)
  @sorted_drawing = value
end

#title=(value) ⇒ Object (writeonly)

Set the large title of the graph displayed at the top.


92
93
94
# File 'lib/gruff/base.rb', line 92

def title=(value)
  @title = value
end

#title_margin=(value) ⇒ Object (writeonly)

Blank space below the title. Default is 20.


43
44
45
# File 'lib/gruff/base.rb', line 43

def title_margin=(value)
  @title_margin = value
end

#top_margin=(value) ⇒ Object (writeonly)

Blank space above the graph. Default is 20.


31
32
33
# File 'lib/gruff/base.rb', line 31

def top_margin=(value)
  @top_margin = value
end

#x_axis_increment=(value) ⇒ Object (writeonly)

Set increment of the vertical marking lines.


83
84
85
# File 'lib/gruff/base.rb', line 83

def x_axis_increment=(value)
  @x_axis_increment = value
end

#x_axis_label=(value) ⇒ Object

Set a label for the bottom of the graph.


71
72
73
# File 'lib/gruff/base.rb', line 71

def x_axis_label=(value)
  @x_axis_label = value
end

#x_axis_label_format=(value) ⇒ Object (writeonly)

Allow passing lambda to format labels for x axis.


77
78
79
# File 'lib/gruff/base.rb', line 77

def x_axis_label_format=(value)
  @x_axis_label_format = value
end

#y_axis_increment=(value) ⇒ Object (writeonly)

Set increment of the horizontal marking lines.


86
87
88
# File 'lib/gruff/base.rb', line 86

def y_axis_increment=(value)
  @y_axis_increment = value
end

#y_axis_label=(value) ⇒ Object

Set a label for the left side of the graph.


74
75
76
# File 'lib/gruff/base.rb', line 74

def y_axis_label=(value)
  @y_axis_label = value
end

#y_axis_label_format=(value) ⇒ Object (writeonly)

Allow passing lambda to format labels for y axis.


80
81
82
# File 'lib/gruff/base.rb', line 80

def y_axis_label_format=(value)
  @y_axis_label_format = value
end

Instance Method Details

#add_color(colorname) ⇒ Object

Add a color to the list of available colors for lines.

Examples:

add_color('#c0e9d3')

Parameters:

  • colorname (String)

    The color.


297
298
299
# File 'lib/gruff/base.rb', line 297

def add_color(colorname)
  @colors << colorname
end

#bold_title=(value) ⇒ Object

Specifies whether to draw the title bolded or not. Default is true.

Parameters:

  • value (Boolean)

    specifies whether to draw the title bolded or not.


277
278
279
# File 'lib/gruff/base.rb', line 277

def bold_title=(value)
  @title_font.bold = value
end

#data(name, data_points = [], color = nil) ⇒ Object

Note:

If you want to use a preset theme, you must set it before calling #data.

Input the data in the graph.

Parameters are an array where the first element is the name of the dataset and the value is an array of values to plot.

Can be called multiple times with different datasets for a multi-valued graph.

If the color argument is nil, the next color from the default theme will be used.

Examples:

data("Bart S.", [95, 45, 78, 89, 88, 76], '#ffcc00')

Parameters:

  • name (String, Symbol)

    The name of the dataset.

  • data_points (Array) (defaults to: [])

    The array of dataset.

  • color (String) (defaults to: nil)

    The color for drawing graph of dataset.


416
417
418
# File 'lib/gruff/base.rb', line 416

def data(name, data_points = [], color = nil)
  store.add(name, data_points, color)
end

#drawObject

Draw a graph.


483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
# File 'lib/gruff/base.rb', line 483

def draw
  setup_data

  # Maybe should be done in one of the following functions for more granularity.
  unless data_given?
    draw_no_data
    return
  end

  setup_drawing

  draw_legend
  draw_line_markers
  draw_axis_labels
  draw_title
  draw_graph
end

#font=(font_path) ⇒ Object

Sets the font for graph text to the font at font_path.

Parameters:

  • font_path (String)

    The path to font.


232
233
234
235
236
# File 'lib/gruff/base.rb', line 232

def font=(font_path)
  @title_font.path = font_path unless @title_font.path
  @marker_font.path = font_path
  @legend_font.path = font_path
end

#font_color=(value) ⇒ Object

Specifies the text color.

Parameters:

  • value (String)

    color


285
286
287
288
289
# File 'lib/gruff/base.rb', line 285

def font_color=(value)
  @title_font.color = value
  @marker_font.color = value
  @legend_font.color = value
end

#legend_font_size=(value) ⇒ Object

Optionally set the size of the font. Based on an 800x600px graph. Default is 20.

Will be scaled down if the graph is smaller than 800px wide.

Parameters:

  • value (Numeric)

    legend font size


269
270
271
# File 'lib/gruff/base.rb', line 269

def legend_font_size=(value)
  @legend_font.size = value
end

#margins=(margin) ⇒ Object

Sets the top, bottom, left and right margins to margin.

Parameters:

  • margin (Numeric)

    The margin size.


224
225
226
# File 'lib/gruff/base.rb', line 224

def margins=(margin)
  @top_margin = @left_margin = @right_margin = @bottom_margin = margin
end

#marker_font_size=(value) ⇒ Object

The font size of the labels around the graph. Default is 21.

Parameters:

  • value (Numeric)

    marker font size


258
259
260
# File 'lib/gruff/base.rb', line 258

def marker_font_size=(value)
  @marker_font.size = value
end

#replace_colors(color_list = []) ⇒ Object

Replace the entire color list with a new array of colors. Also aliased as the #colors= setter method.

If you specify fewer colors than the number of datasets you intend to draw, it will cycle through the array, reusing colors as needed.

Note that (as with the #theme= method), you should set up your color list before you send your data (via the #data method). Calls to the #data method made prior to this call will use whatever color scheme was in place at the time data was called.

Examples:

replace_colors ['#cc99cc', '#d9e043', '#34d8a2']

Parameters:

  • color_list (Array) (defaults to: [])

    The array of colors.


316
317
318
# File 'lib/gruff/base.rb', line 316

def replace_colors(color_list = [])
  @colors = color_list
end

#theme=(options) ⇒ Object

You can set a theme manually. Assign a hash to this method before you send your data.

graph.theme = {
  colors: %w(orange purple green white red),
  marker_color: 'blue',
  background_colors: ['black', 'grey'],
  background_direction: :top_bottom
}

background_image: 'squirrel.png' is also possible.

background_direction accepts one of following parameters.

  • :top_bottom

  • :bottom_top

  • :left_right

  • :right_left

  • :topleft_bottomright

  • :topright_bottomleft

(Or hopefully something better looking than that.)

Parameters:

  • options (Hash)

    The optional setting for theme


344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/gruff/base.rb', line 344

def theme=(options)
  reset_themes

  defaults = {
    colors: %w[black white],
    marker_color: 'white',
    marker_shadow_color: nil,
    font_color: 'black',
    background_colors: nil,
    background_image: nil
  }
  @theme_options = defaults.merge options

  self.marker_color = @theme_options[:marker_color]
  self.font_color = @theme_options[:font_color] || @marker_color

  @colors = @theme_options[:colors]
  @marker_shadow_color = @theme_options[:marker_shadow_color]

  @renderer = Gruff::Renderer.new(@columns, @rows, @scale, @theme_options)
end

#theme_37signalsObject

Apply 37signals theme.


372
373
374
# File 'lib/gruff/base.rb', line 372

def theme_37signals
  self.theme = Themes::THIRTYSEVEN_SIGNALS
end

#theme_greyscaleObject

Apply greyscale theme.


392
393
394
# File 'lib/gruff/base.rb', line 392

def theme_greyscale
  self.theme = Themes::GREYSCALE
end

#theme_keynoteObject

Apply Apple's keynote theme.


367
368
369
# File 'lib/gruff/base.rb', line 367

def theme_keynote
  self.theme = Themes::KEYNOTE
end

#theme_odeoObject

Apply Odeo theme.


382
383
384
# File 'lib/gruff/base.rb', line 382

def theme_odeo
  self.theme = Themes::ODEO
end

#theme_pastelObject

Apply pastel theme.


387
388
389
# File 'lib/gruff/base.rb', line 387

def theme_pastel
  self.theme = Themes::PASTEL
end

#theme_rails_keynoteObject

Apply Rails theme.


377
378
379
# File 'lib/gruff/base.rb', line 377

def theme_rails_keynote
  self.theme = Themes::RAILS_KEYNOTE
end

#title_font=(font_path) ⇒ Object

Same as #font= but for the title.

Parameters:

  • font_path (String)

    The path to font.


242
243
244
# File 'lib/gruff/base.rb', line 242

def title_font=(font_path)
  @title_font.path = font_path
end

#title_font_size=(value) ⇒ Object

Set the font size of the large title at the top of the graph. Default is 36.

Parameters:

  • value (Numeric)

    title font size


250
251
252
# File 'lib/gruff/base.rb', line 250

def title_font_size=(value)
  @title_font.size = value
end

#to_blob(image_format = 'PNG') ⇒ Object

Deprecated.

Please use to_image.to_blob instead.

Return the graph as a rendered binary blob.

Parameters:

  • image_format (String) (defaults to: 'PNG')

    The image format of binary blob.


475
476
477
478
479
480
# File 'lib/gruff/base.rb', line 475

def to_blob(image_format = 'PNG')
  warn '#to_blob is deprecated. Please use `to_image.to_blob` instead'
  to_image.to_blob do
    self.format = image_format
  end
end

#to_imageMagick::Image

Return a rendered graph image. This can use RMagick's methods to adjust the image before saving.

Examples:

g = Gruff::Line.new
g.data :Jimmy, [25, 36, 86, 39, 25, 31, 79, 88]
g.data :Charles, [80, 54, 67, 54, 68, 70, 90, 95]
image = g.to_image
image = image.resize(400, 300).quantize(128, Magick::RGBColorspace)
image.write('test.png')

Returns:

  • (Magick::Image)

    The rendered image.


462
463
464
465
466
467
468
# File 'lib/gruff/base.rb', line 462

def to_image
  @to_image ||= begin
    draw
    renderer.finish
    renderer.image
  end
end

#write(file_name = 'graph.png') ⇒ Object

Writes the graph to a file. Defaults to 'graph.png'

Examples:

write('graphs/my_pretty_graph.png')

Parameters:

  • file_name (String) (defaults to: 'graph.png')

    The file name of output image.


445
446
447
# File 'lib/gruff/base.rb', line 445

def write(file_name = 'graph.png')
  to_image.write(file_name)
end