Class: Gruff::Candlestick

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

Overview

Here’s how to set up a Gruff::Candlestick.

g = Gruff::Candlestick.new
g.data low:  79.30, high:  93.10, open:  79.44, close:  91.20
g.data low:  89.14, high: 106.42, open:  91.28, close: 106.26
g.data low: 107.89, high: 131.00, open: 108.20, close: 129.04
g.data low: 103.10, high: 137.98, open: 132.76, close: 115.81
g.write("candlestick.png")

Constant Summary

Constants inherited from Base

Base::DEFAULT_MARGIN, Base::DEFAULT_TARGET_WIDTH, Base::LABEL_MARGIN, Base::LEGEND_MARGIN, Base::TITLE_MARGIN

Instance Attribute Summary collapse

Attributes inherited from Base

#bottom_margin, #colors, #hide_legend, #hide_line_markers, #hide_line_numbers, #hide_title, #label_margin, #label_max_size, #label_truncation_style, #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_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=, #draw, #font=, #font_color=, #initialize, #label_rotation=, #label_stagger_height=, #labels=, #legend_font_size=, #margins=, #marker_font_size=, #no_data_font_size=, #replace_colors, #theme=, #theme_37signals, #theme_greyscale, #theme_keynote, #theme_odeo, #theme_pastel, #theme_rails_keynote, #title=, #title_font=, #title_font_size=, #to_blob, #to_image, #transparent_background=, #write

Constructor Details

This class inherits a constructor from Gruff::Base

Instance Attribute Details

#down_color=(value) ⇒ Object (writeonly)

Specifies the color with down bar. Default is ‘#eb5242’.



29
30
31
 
# File 'lib/gruff/candlestick.rb', line 29

def down_color=(value)
  @down_color = value
end

#fill_opacity=(value) ⇒ Object (writeonly)

Specifies the filling opacity in area graph. Default is 0.4.



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

def fill_opacity=(value)
  @fill_opacity = value
end

#show_vertical_markers=(value) ⇒ Object (writeonly)

Allow for vertical marker lines.



17
18
19
 
# File 'lib/gruff/candlestick.rb', line 17

def show_vertical_markers=(value)
  @show_vertical_markers = value
end

#stroke_width=(value) ⇒ Object (writeonly)

Specifies the stroke width in line. Default is 2.0.



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

def stroke_width=(value)
  @stroke_width = value
end

#up_color=(value) ⇒ Object (writeonly)

Specifies the color with up bar. Default is ‘#579773’.



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

def up_color=(value)
  @up_color = value
end

Instance Method Details

#data(low:, high:, open:, close:) ⇒ Object 



59
60
61
 
# File 'lib/gruff/candlestick.rb', line 59

def data(low:, high:, open:, close:)
  super('', [low, high, open, close])
end

#sort=(_value) ⇒ Object

The sort feature is not supported in this graph.



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

def sort=(_value)
  raise 'Not support #sort= in Gruff::Candlestick'
end

#sorted_drawing=(_value) ⇒ Object

The sort feature is not supported in this graph.



51
52
53
 
# File 'lib/gruff/candlestick.rb', line 51

def sorted_drawing=(_value)
  raise 'Not support #sorted_drawing= in Gruff::Candlestick'
end

#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) 


39
40
41
42
43
 
# File 'lib/gruff/candlestick.rb', line 39

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

  @spacing_factor = (1.0 - space_percent)
end