Class: Gruff::Base
- Inherits:
-
Object
- Object
- Gruff::Base
- Defined in:
- lib/gruff/base.rb
Overview
A common base class inherited from class of drawing a graph.
Direct Known Subclasses
Area, Bar, Bezier, Box, Bullet, Candlestick, Dot, Line, Net, Pie, Scatter, SideBar, Spider, StackedArea, StackedBar
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
-
#bottom_margin ⇒ Object
writeonly
Blank space below the graph.
-
#colors ⇒ Object
Get or set the list of colors that will be used to draw the bars or lines.
-
#hide_legend ⇒ Object
writeonly
Prevent drawing of the legend.
-
#hide_line_markers ⇒ Object
writeonly
Prevent drawing of line markers.
-
#hide_line_numbers ⇒ Object
writeonly
Prevent drawing of line numbers.
-
#hide_title ⇒ Object
writeonly
Prevent drawing of the title.
-
#label_max_size ⇒ Object
writeonly
Truncates labels if longer than max specified.
-
#label_truncation_style ⇒ Object
writeonly
How truncated labels visually appear if they exceed #label_max_size=.
-
#left_margin ⇒ Object
writeonly
Blank space to the left of the graph.
-
#legend_at_bottom ⇒ Object
writeonly
Display the legend under the graph.
-
#legend_box_size ⇒ Object
writeonly
Optionally set the size of the colored box by each item in the legend.
-
#legend_margin ⇒ Object
writeonly
Blank space below the legend.
-
#marker_color ⇒ Object
writeonly
Set the color of the auxiliary lines.
-
#marker_count ⇒ Object
writeonly
Set the number of horizontal lines shown for reference.
-
#marker_shadow_color ⇒ Object
writeonly
Set the shadow color of the auxiliary lines.
-
#maximum_value ⇒ Object
You can manually set a maximum value, such as a percentage-based graph that always goes to 100.
-
#minimum_value ⇒ Object
You can manually set a minimum value instead of having the values guessed for you.
-
#no_data_message ⇒ Object
writeonly
Set a message shown when there is no data.
-
#right_margin ⇒ Object
writeonly
Blank space to the right of the graph.
-
#sort ⇒ Object
writeonly
Set to
true
if you want the data sets sorted with largest avg values drawn first. -
#sorted_drawing ⇒ Object
writeonly
Set to
true
if you want the data sets drawn with largest avg values drawn first. -
#title_margin ⇒ Object
writeonly
Blank space below the title.
-
#top_margin ⇒ Object
writeonly
Blank space above the graph.
-
#x_axis_increment ⇒ Object
writeonly
Set increment of the vertical marking lines.
-
#x_axis_label ⇒ Object
writeonly
Set a label for the bottom of the graph.
-
#x_axis_label_format ⇒ Object
writeonly
Allow passing lambda to format labels for x axis.
-
#y_axis_increment ⇒ Object
writeonly
Set increment of the horizontal marking lines.
-
#y_axis_label ⇒ Object
writeonly
Set a label for the left side of the graph.
-
#y_axis_label_format ⇒ Object
writeonly
Allow passing lambda to format labels for y axis.
Instance Method Summary collapse
-
#add_color(colorname) ⇒ Object
Add a color to the list of available colors for lines.
-
#bold_title=(value) ⇒ Object
Specifies whether to draw the title bolded or not.
-
#data(name, data_points = [], color = nil) ⇒ Object
Input the data in the graph.
-
#draw ⇒ Object
Draw a graph.
-
#font=(font_path) ⇒ Object
Sets the font for graph text to the font at
font_path
. -
#font_color=(value) ⇒ Object
Specifies the text color.
-
#initialize(target_width = DEFAULT_TARGET_WIDTH) ⇒ Base
constructor
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.). -
#label_rotation=(rotation) ⇒ Object
Set a rotation for labels.
- #label_stagger_height=(_value) ⇒ Object deprecated Deprecated.
-
#labels=(labels) ⇒ Object
A hash of names for the individual columns, where the key is the array index for the column this label represents.
-
#legend_font_size=(value) ⇒ Object
Optionally set the size of the font.
-
#margins=(margin) ⇒ Object
Sets the top, bottom, left and right margins to
margin
. -
#marker_font_size=(value) ⇒ Object
The font size of the labels around the graph.
-
#replace_colors(color_list = []) ⇒ Object
Replace the entire color list with a new array of colors.
-
#theme=(options) ⇒ Object
You can set a theme manually.
-
#theme_37signals ⇒ Object
Apply 37signals theme.
-
#theme_greyscale ⇒ Object
Apply greyscale theme.
-
#theme_keynote ⇒ Object
Apply Apple’s keynote theme.
-
#theme_odeo ⇒ Object
Apply Odeo theme.
-
#theme_pastel ⇒ Object
Apply pastel theme.
-
#theme_rails_keynote ⇒ Object
Apply Rails theme.
-
#title=(title) ⇒ Object
Set the large title of the graph displayed at the top.
-
#title_font=(font_path) ⇒ Object
Same as #font= but for the title.
-
#title_font_size=(value) ⇒ Object
Set the font size of the large title at the top of the graph.
-
#to_blob(image_format = 'PNG') ⇒ Object
deprecated
Deprecated.
Please use
to_image.to_blob
instead. -
#to_image ⇒ Magick::Image
Return a rendered graph image.
-
#write(file_name = 'graph.png') ⇒ Object
Writes the graph to a file.
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’).
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 |
# File 'lib/gruff/base.rb', line 129 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 |
#colors ⇒ Object
Get or set the list of colors that will be used to draw the bars or lines.
77 78 79 |
# File 'lib/gruff/base.rb', line 77 def colors @colors end |
#hide_legend=(value) ⇒ Object (writeonly)
Prevent drawing of the legend. Default is false
.
83 84 85 |
# File 'lib/gruff/base.rb', line 83 def hide_legend=(value) @hide_legend = value end |
#hide_line_markers=(value) ⇒ Object (writeonly)
Prevent drawing of line markers. Default is false
.
80 81 82 |
# File 'lib/gruff/base.rb', line 80 def hide_line_markers=(value) @hide_line_markers = value end |
#hide_line_numbers=(value) ⇒ Object (writeonly)
Prevent drawing of line numbers. Default is false
.
89 90 91 |
# File 'lib/gruff/base.rb', line 89 def hide_line_numbers=(value) @hide_line_numbers = value end |
#hide_title=(value) ⇒ Object (writeonly)
Prevent drawing of the title. Default is false
.
86 87 88 |
# File 'lib/gruff/base.rb', line 86 def hide_title=(value) @hide_title = value end |
#label_max_size=(value) ⇒ Object (writeonly)
Truncates labels if longer than max specified.
49 50 51 |
# File 'lib/gruff/base.rb', line 49 def label_max_size=(value) @label_max_size = 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).
56 57 58 |
# File 'lib/gruff/base.rb', line 56 def label_truncation_style=(value) @label_truncation_style = 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
.
113 114 115 |
# File 'lib/gruff/base.rb', line 113 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.
119 120 121 |
# File 'lib/gruff/base.rb', line 119 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.
96 97 98 |
# File 'lib/gruff/base.rb', line 96 def marker_color=(value) @marker_color = value end |
#marker_count=(value) ⇒ Object
Set the number of horizontal lines shown for reference.
102 103 104 |
# File 'lib/gruff/base.rb', line 102 def marker_count=(value) @marker_count = value end |
#marker_shadow_color=(value) ⇒ Object (writeonly)
Set the shadow color of the auxiliary lines.
99 100 101 |
# File 'lib/gruff/base.rb', line 99 def marker_shadow_color=(value) @marker_shadow_color = value end |
#maximum_value ⇒ Object
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.
482 483 484 |
# File 'lib/gruff/base.rb', line 482 def maximum_value (@maximum_value || store.max).to_f end |
#minimum_value ⇒ Object
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.
471 472 473 474 |
# File 'lib/gruff/base.rb', line 471 def minimum_value min = [0.0, store.min.to_f].min (@minimum_value || 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.”.
93 94 95 |
# File 'lib/gruff/base.rb', line 93 def (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
.
106 107 108 |
# File 'lib/gruff/base.rb', line 106 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
.
110 111 112 |
# File 'lib/gruff/base.rb', line 110 def sorted_drawing=(value) @sorted_drawing = 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.
71 72 73 |
# File 'lib/gruff/base.rb', line 71 def x_axis_increment=(value) @x_axis_increment = value end |
#x_axis_label=(value) ⇒ Object
Set a label for the bottom of the graph.
59 60 61 |
# File 'lib/gruff/base.rb', line 59 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.
65 66 67 |
# File 'lib/gruff/base.rb', line 65 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.
74 75 76 |
# File 'lib/gruff/base.rb', line 74 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.
62 63 64 |
# File 'lib/gruff/base.rb', line 62 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.
68 69 70 |
# File 'lib/gruff/base.rb', line 68 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.
343 344 345 |
# File 'lib/gruff/base.rb', line 343 def add_color(colorname) @colors << colorname end |
#bold_title=(value) ⇒ Object
Specifies whether to draw the title bolded or not. Default is true
.
323 324 325 |
# File 'lib/gruff/base.rb', line 323 def bold_title=(value) @title_font.bold = value end |
#data(name, data_points = [], color = nil) ⇒ Object
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.
463 464 465 |
# File 'lib/gruff/base.rb', line 463 def data(name, data_points = [], color = nil) store.add(name, data_points, color) end |
#draw ⇒ Object
Draw a graph.
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 |
# File 'lib/gruff/base.rb', line 530 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
.
278 279 280 281 282 |
# File 'lib/gruff/base.rb', line 278 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.
331 332 333 334 335 |
# File 'lib/gruff/base.rb', line 331 def font_color=(value) @title_font.color = value @marker_font.color = value @legend_font.color = value end |
#label_rotation=(rotation) ⇒ Object
Set a rotation for labels. You can use Default is 0
. You can use a rotation between 0.0
and 45.0
, or between 0.0
and -45.0
.
234 235 236 237 238 |
# File 'lib/gruff/base.rb', line 234 def label_rotation=(rotation) raise ArgumentError, 'rotation must be between 0.0 and 45.0 or between 0.0 and -45.0' if rotation > 45.0 || rotation < -45.0 @label_rotation = rotation.to_f end |
#label_stagger_height=(_value) ⇒ Object
Height of staggering between labels.
242 243 244 |
# File 'lib/gruff/base.rb', line 242 def label_stagger_height=(_value) warn '#label_stagger_height= is deprecated. It is no longer effective.' end |
#labels=(labels) ⇒ Object
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 with hash.
Or, an array corresponding to the data values.
219 220 221 222 223 224 225 226 227 |
# File 'lib/gruff/base.rb', line 219 def labels=(labels) if labels.is_a?(Array) labels = labels.each_with_index.with_object({}) do |(label, index), hash| hash[index] = label end end @labels = labels 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.
315 316 317 |
# File 'lib/gruff/base.rb', line 315 def legend_font_size=(value) @legend_font.size = value end |
#margins=(margin) ⇒ Object
Sets the top, bottom, left and right margins to margin
.
270 271 272 |
# File 'lib/gruff/base.rb', line 270 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
.
304 305 306 |
# File 'lib/gruff/base.rb', line 304 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.
362 363 364 |
# File 'lib/gruff/base.rb', line 362 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.
g = Gruff::Bar.new
g.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.)
391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
# File 'lib/gruff/base.rb', line 391 def theme=() 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 self.marker_color = @theme_options[:marker_color] self.font_color = @theme_options[:font_color] || @marker_color @colors = @theme_options[:colors].dup @marker_shadow_color = @theme_options[:marker_shadow_color] @renderer = Gruff::Renderer.new(@columns, @rows, @scale, @theme_options) end |
#theme_37signals ⇒ Object
Apply 37signals theme.
419 420 421 |
# File 'lib/gruff/base.rb', line 419 def theme_37signals self.theme = Themes::THIRTYSEVEN_SIGNALS end |
#theme_greyscale ⇒ Object
Apply greyscale theme.
439 440 441 |
# File 'lib/gruff/base.rb', line 439 def theme_greyscale self.theme = Themes::GREYSCALE end |
#theme_keynote ⇒ Object
Apply Apple’s keynote theme.
414 415 416 |
# File 'lib/gruff/base.rb', line 414 def theme_keynote self.theme = Themes::KEYNOTE end |
#theme_odeo ⇒ Object
Apply Odeo theme.
429 430 431 |
# File 'lib/gruff/base.rb', line 429 def theme_odeo self.theme = Themes::ODEO end |
#theme_pastel ⇒ Object
Apply pastel theme.
434 435 436 |
# File 'lib/gruff/base.rb', line 434 def theme_pastel self.theme = Themes::PASTEL end |
#theme_rails_keynote ⇒ Object
Apply Rails theme.
424 425 426 |
# File 'lib/gruff/base.rb', line 424 def theme_rails_keynote self.theme = Themes::RAILS_KEYNOTE end |
#title=(title) ⇒ Object
Set the large title of the graph displayed at the top. You can draw a multi-line title by putting a line break in the string or by setting an array as argument.
258 259 260 261 262 263 264 |
# File 'lib/gruff/base.rb', line 258 def title=(title) if title.is_a?(Array) title = title.join("\n") end @title = title end |
#title_font=(font_path) ⇒ Object
Same as #font= but for the title.
288 289 290 |
# File 'lib/gruff/base.rb', line 288 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
.
296 297 298 |
# File 'lib/gruff/base.rb', line 296 def title_font_size=(value) @title_font.size = value end |
#to_blob(image_format = 'PNG') ⇒ Object
Please use to_image.to_blob
instead.
Return the graph as a rendered binary blob.
523 524 525 526 527 |
# File 'lib/gruff/base.rb', line 523 def to_blob(image_format = 'PNG') warn '#to_blob is deprecated. Please use `to_image.to_blob` instead' to_image.format = image_format to_image.to_blob end |
#to_image ⇒ Magick::Image
Return a rendered graph image. This can use RMagick’s methods to adjust the image before saving.
510 511 512 513 514 515 516 |
# File 'lib/gruff/base.rb', line 510 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’
493 494 495 |
# File 'lib/gruff/base.rb', line 493 def write(file_name = 'graph.png') to_image.write(file_name) end |