Class: Writexlsx::Chart::Stock

Inherits:
Writexlsx::Chart show all
Includes:
Utility
Defined in:
lib/write_xlsx/chart/stock.rb

Overview

The default Stock chart is an High-Low-Close chart. A series must be added for each of these data sources.

Constant Summary

Constants included from Utility

Utility::COL_MAX, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary

Attributes inherited from Writexlsx::Chart

#embedded, #formula_data, #formula_ids, #height, #id, #index, #name, #palette, #protection, #width, #x_offset, #x_scale, #y_offset, #y_scale

Instance Method Summary collapse

Methods included from Utility

#absolute_char, #check_dimensions, #check_dimensions_and_update_max_min_values, #check_parameter, #convert_date_time, delete_files, #float_to_str, #pixels_to_points, #ptrue?, #put_deprecate_message, #row_col_notation, #shape_style_base, #store_col_max_min_values, #store_row_max_min_values, #substitute_cellref, #underline_attributes, #v_shape_attributes_base, #v_shape_style_base, #write_anchor, #write_auto_fill, #write_color, #write_comment_path, #write_div, #write_fill, #write_font, #write_stroke, #xl_cell_to_rowcol, #xl_col_to_name, #xl_range, #xl_range_formula, #xl_rowcol_to_cell, #xml_str

Methods inherited from Writexlsx::Chart

#add_series, #assemble_xml_file, #convert_font_args, factory, #get_data_id, #line_properties, #process_names, #set_chartarea, #set_drop_lines, #set_embedded_config_data, #set_high_low_lines, #set_legend, #set_plotarea, #set_size, #set_style, #set_table, #set_title, #set_up_down_bars, #set_x2_axis, #set_x_axis, #set_xml_writer, #set_y2_axis, #set_y_axis, #show_blanks_as, #show_hidden_data, #write_bar_chart

Constructor Details

#initialize(subtype) ⇒ Stock

Returns a new instance of Stock.



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/write_xlsx/chart/stock.rb', line 27

def initialize(subtype)
  super(subtype)
  @show_crosses = false
  @hi_low_lines = {}

  # Override and reset the default axis values.
  @x_axis.defaults[:num_format] = 'dd/mm/yyyy'
  @x2_axis.defaults[:num_format] = 'dd/mm/yyyy'
  set_x_axis
  set_x2_axis
end

Instance Method Details

#modify_series_formatting ⇒ Object

Add default formatting to the series data.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/write_xlsx/chart/stock.rb', line 93

def modify_series_formatting
  index = 0
  array = []
  @series.each do |series|
    if index % 4 != 3
      if series[:_line][:_defined].nil? || series[:_line][:_defined] == 0
        series[:_line] = {
          :width    => 2.25,
          :none     => 1,
          :_defined => 1
        }
      end

      if series[:_marker].nil? || series[:_marker] == 0
        if index % 4 == 2
          series[:_marker] = { :type => 'dot', :size => 3 }
        else
          series[:_marker] = { :type => 'none' }
        end
      end
    end
    index += 1
    array << series
  end
  @series = array
end

#write_chart_type(params) ⇒ Object

Override the virtual superclass method with a chart specific method.



42
43
44
45
 
# File 'lib/write_xlsx/chart/stock.rb', line 42

def write_chart_type(params)
  # Write the c:areaChart element.
  write_stock_chart(params)
end

#write_plot_area ⇒ Object

Overridden to use write_date_axis() instead of write_cat_axis().



86
87
88
 
# File 'lib/write_xlsx/chart/stock.rb', line 86

def write_plot_area
  write_plot_area_base(:stock)
end

#write_stock_chart(params) ⇒ Object

Write the <c:stockChart> element. Overridden to add hi_low_lines(). TODO. Refactor up into the SUPER class



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/write_xlsx/chart/stock.rb', line 51

def write_stock_chart(params)
  if params[:primary_axes] == 1
    series = get_primary_axes_series
  else
    series = get_secondary_axes_series
  end
  return if series.empty?

  # Add default formatting to the series data.
  modify_series_formatting

  @writer.tag_elements('c:stockChart') do
    # Write the series elements.
    series.each {|s| write_series(s)}

    # Write the c:dtopLines element.
    write_drop_lines

    # Write the c:hiLowLines element.
    write_hi_low_lines if ptrue?(params[:primary_axes])

    # Write the c:upDownBars element.
    write_up_down_bars

    # Write the c:marker element.
    write_marker_value

    # Write the c:axId elements
    write_axis_ids(params)
  end
end