Class: Writexlsx::Chart::Stock

Inherits:
Writexlsx::Chart show all
Includes:
Utility::XmlPrimitives
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::ChartFormatting

Utility::ChartFormatting::PATTERN_TYPES

Constants included from Utility::Common

Utility::Common::PERL_TRUE_VALUES

Instance Attribute Summary

Attributes inherited from Writexlsx::Chart

#already_inserted, #axis2_ids, #combined, #date_category, #embedded, #formula_data, #formula_ids, #height, #id, #index, #label_position_default, #label_positions, #name, #palette, #protection, #series_index, #width, #writer, #x2_axis, #x_offset, #x_scale, #y2_axis, #y_offset, #y_scale

Instance Method Summary collapse

Methods included from Utility::XmlPrimitives

#r_id_attributes, #write_color, #write_xml_declaration, #xml_str

Methods inherited from Writexlsx::Chart

#already_inserted?, factory, #is_secondary?, #set_xml_writer, #write_bar_chart

Methods included from AxisWriter

#write_val_axis

Methods included from XmlWriter

#assemble_xml_file

Methods included from SeriesData

#data_id, #process_names

Methods included from Settings

#add_series, #combine, #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_y2_axis, #set_y_axis, #show_blanks_as, #show_hidden_data, #show_na_as_empty_cell

Methods included from Gradient

#gradient_properties

Methods included from Utility::RichText

#convert_font_args, #get_font_latin_attributes, #get_font_style_attributes, #params_to_font, #underline_attributes, #write_a_body_pr, #write_a_def_rpr, #write_a_end_para_rpr, #write_a_lst_style, #write_a_p_formula, #write_a_p_pr_formula, #write_def_rpr_r_pr_common, #write_tx_pr

Methods included from Utility::ChartFormatting

#color, #dash_types, #fill_properties, #layout_properties, #legend_properties, #line_fill_properties, #line_properties, #palette_color_from_index, #pattern_properties, #value_or_raise, #write_a_solid_fill, #write_a_srgb_clr

Methods included from Utility::Common

#absolute_char, #check_parameter, #float_to_str, #ptrue?, #put_deprecate_message

Constructor Details

#initialize(subtype) ⇒ Stock

Returns a new instance of Stock.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/write_xlsx/chart/stock.rb', line 29

def initialize(subtype)
  super
  @show_crosses  = false
  @hi_low_lines  = Chartline.new({})
  @date_category = true

  # 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

  # Set the available data label positions for this chart type.
  @label_position_default = 'right'
  @label_positions = {
    'center' => 'ctr',
    'right'  => 'r',
    'left'   => 'l',
    'above'  => 't',
    'below'  => 'b',
    # For backward compatibility.
    'top'    => 't',
    'bottom' => 'b'
  }
end

Instance Method Details

#modify_series_formatting ⇒ Object

Add default formatting to the series data.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/write_xlsx/chart/stock.rb', line 102

def modify_series_formatting
  array = []
  @series.each_with_index do |series, index|
    if index % 4 != 3
      unless series.line_defined?
        series.line = {
          width:    2.25,
          none:     1,
          _defined: 1
        }
      end

      unless ptrue?(series.marker)
        series.marker = if index % 4 == 2
                          Marker.new(type: 'dot', size: 3)
                        else
                          Marker.new(type: 'none')
                        end
      end
    end
    array << series
  end
  @series = array
end

#write_chart_type(params) ⇒ Object

Override the virtual superclass method with a chart specific method.



58
59
60
61
 
# File 'lib/write_xlsx/chart/stock.rb', line 58

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

#write_stock_chart(params) ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/write_xlsx/chart/stock.rb', line 67

def write_stock_chart(params)
  series = if params[:primary_axes] == 1
             get_primary_axes_series
           else
             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