Class: Gruff::SideBar

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

Overview

Graph with individual horizontal bars instead of vertical bars.

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

g = Gruff::SideBar.new
g.title = 'SideBar Graph'
g.labels = {
  0 => '5/6',
  1 => '5/15',
  2 => '5/24',
  3 => '5/30',
}
g.group_spacing = 20
g.data :Art, [0, 5, 8, 15]
g.data :Philosophy, [10, 3, 2, 8]
g.data :Science, [2, 15, 8, 11]
g.write('sidebar.png')

Direct Known Subclasses

Mini::SideBar, SideStackedBar

Constant Summary

Constants inherited from Base

Base::DEFAULT_MARGIN, Base::DEFAULT_TARGET_WIDTH, Base::LABEL_MARGIN, 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=, #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

#initializeSideBar

Returns a new instance of SideBar.


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

def initialize(*)
  super
  @has_left_labels = true
end

Instance Attribute Details

#bar_spacing=(value) ⇒ Object (writeonly)

Spacing factor applied between bars.


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

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.


26
27
28
# File 'lib/gruff/side_bar.rb', line 26

def group_spacing=(value)
  @group_spacing = value
end

#hide_labels=(value) ⇒ Object (writeonly)

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


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

def hide_labels=(value)
  @hide_labels = value
end

#label_formatting=(value) ⇒ Object (writeonly)

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


30
31
32
# File 'lib/gruff/side_bar.rb', line 30

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.


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

def show_labels_for_bar_values=(value)
  @show_labels_for_bar_values = value
end

Instance Method Details

#use_data_label=(_value) ⇒ Object

Deprecated.

With Side Bars use the data label for the marker value to the left of the bar.


50
51
52
# File 'lib/gruff/side_bar.rb', line 50

def use_data_label=(_value)
  warn '#use_data_label is deprecated. It is no longer effective.'
end