Class: Gruff::Bar

Inherits:
Base
  • Object
show all
Defined in:
lib/gruff/bar.rb

Overview

Gruff::Bar provide a bar graph that presents categorical data with rectangular bars.

Here's how to set up a Gruff::Bar.

g = Gruff::Bar.new
g.title = 'Bar Graph With Manual Colors'
g.spacing_factor = 0.1
g.group_spacing = 20
g.data :Art, [0, 5, 8, 15], '#990000'
g.data :Philosophy, [10, 3, 2, 8], '#009900'
g.data :Science, [2, 15, 8, 11], '#990099'
g.write('bar.png')

Direct Known Subclasses

Histogram, Mini::Bar

Constant Summary

Constants inherited from Base

Gruff::Base::DEFAULT_MARGIN, Gruff::Base::DEFAULT_TARGET_WIDTH, Gruff::Base::LABEL_MARGIN, Gruff::Base::LEGEND_MARGIN

Instance Attribute Summary collapse

Attributes inherited from Base

#bottom_margin, #colors, #hide_legend, #hide_line_markers, #hide_line_numbers, #hide_title, #label_max_size, #label_stagger_height, #label_truncation_style, #labels, #left_margin, #legend_at_bottom, #legend_box_size, #legend_margin, #marker_color, #marker_shadow_color, #maximum_value, #minimum_value, #no_data_message, #right_margin, #sort, #sorted_drawing, #title, #title_margin, #top_margin, #x_axis_increment, #x_axis_label_format, #y_axis_increment, #y_axis_label_format

Instance Method Summary collapse

Methods inherited from Base

#add_color, #bold_title=, #data, #draw, #font=, #font_color=, #initialize, #legend_font_size=, #margins=, #marker_font_size=, #replace_colors, #theme=, #theme_37signals, #theme_greyscale, #theme_keynote, #theme_odeo, #theme_pastel, #theme_rails_keynote, #title_font=, #title_font_size=, #to_blob, #to_image, #write

Constructor Details

This class inherits a constructor from Gruff::Base

Instance Attribute Details

#bar_spacing=(value) ⇒ Object (writeonly)

Spacing factor applied between bars.


20
21
22
# File 'lib/gruff/bar.rb', line 20

def bar_spacing=(value)
  @bar_spacing = value
end

#group_spacing=(value) ⇒ Object (writeonly)

Spacing factor applied between a group of bars belonging to the same label.


23
24
25
# File 'lib/gruff/bar.rb', line 23

def group_spacing=(value)
  @group_spacing = value
end

#hide_labels=(value) ⇒ Object (writeonly)

Prevent drawing of column labels below a bar graph. Default is false.


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

def hide_labels=(value)
  @hide_labels = value
end

#label_formatting=(value) ⇒ Object (writeonly)

Set the number output format string or lambda. Default is “%.2f”.


27
28
29
# File 'lib/gruff/bar.rb', line 27

def label_formatting=(value)
  @label_formatting = value
end

#show_labels_for_bar_values=(value) ⇒ Object (writeonly)

Output the values for the bars on a bar graph. Default is false.


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

def show_labels_for_bar_values=(value)
  @show_labels_for_bar_values = value
end

Instance Method Details

#spacing_factor=(space_percent) ⇒ Object

Can be used to adjust the spaces between the bars. Accepts values between 0.00 and 1.00 where 0.00 means no spacing at all and 1 means that each bars' width is nearly 0 (so each bar is a simple line with no x dimension).

Default value is 0.9.

Raises:

  • (ArgumentError)

46
47
48
49
50
# File 'lib/gruff/bar.rb', line 46

def spacing_factor=(space_percent)
  raise ArgumentError, 'spacing_factor must be between 0.00 and 1.00' unless (space_percent >= 0) && (space_percent <= 1)

  @spacing_factor = (1 - space_percent)
end