Class: Writexlsx::ChartArea

Inherits:
Object
  • Object
show all
Includes:
Gradient, Utility
Defined in:
lib/write_xlsx/chart.rb

Constant Summary

Constants included from Utility

Utility::CHAR_WIDTHS, Utility::COL_MAX, Utility::DEFAULT_COL_PIXELS, Utility::MAX_DIGIT_WIDTH, Utility::PADDING, Utility::PERL_TRUE_VALUES, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Gradient

#gradient_properties

Methods included from Utility

#absolute_char, #check_dimensions, #check_dimensions_and_update_max_min_values, #check_parameter, #color, #convert_date_time, #convert_font_args, #dash_types, delete_files, #escape_url, #fill_properties, #float_to_str, #get_font_latin_attributes, #get_font_style_attributes, #layout_properties, #legend_properties, #line_fill_properties, #line_properties, #palette_color_from_index, #params_to_font, #pattern_properties, #pixels_to_points, #ptrue?, #put_deprecate_message, #quote_sheetname, #r_id_attributes, #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, #value_or_raise, #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_a_solid_fill, #write_a_srgb_clr, #write_anchor, #write_auto_fill, #write_color, #write_comment_path, #write_def_rpr_r_pr_common, #write_div, #write_fill, #write_font, #write_stroke, #write_tx_pr, #write_xml_declaration, #xl_cell_to_rowcol, #xl_col_to_name, #xl_range, #xl_range_formula, #xl_rowcol_to_cell, #xl_string_pixel_width, #xml_str

Constructor Details

#initialize(params = {}) ⇒ ChartArea

Returns a new instance of ChartArea.



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
82
83
84
 
# File 'lib/write_xlsx/chart.rb', line 57

def initialize(params = {})
  @layout = layout_properties(params[:layout])

  # Allow 'border' as a synonym for 'line'.
  border = params_to_border(params)

  # Set the line properties for the chartarea.
  @line = line_properties(border || params[:line])

  # Set the pattern properties for the series.
  @pattern = pattern_properties(params[:pattern])

  # Set the gradient fill properties for the series.
  @gradient = gradient_properties(params[:gradient])

  # Map deprecated Spreadsheet::WriteExcel fill colour.
  fill = params[:color] ? { color: params[:color] } : params[:fill]
  @fill = fill_properties(fill)

  # Pattern fill overrides solid fill.
  @fill = nil if ptrue?(@pattern)

  # Gradient fill overrides solid and pattern fills.
  if ptrue?(@gradient)
    @pattern = nil
    @fill    = nil
  end
end

Instance Attribute Details

#fill ⇒ Object (readonly)

Returns the value of attribute fill.



55
56
57
 
# File 'lib/write_xlsx/chart.rb', line 55

def fill
  @fill
end

#gradient ⇒ Object (readonly)

Returns the value of attribute gradient.



55
56
57
 
# File 'lib/write_xlsx/chart.rb', line 55

def gradient
  @gradient
end

#layout ⇒ Object (readonly)

Returns the value of attribute layout.



55
56
57
 
# File 'lib/write_xlsx/chart.rb', line 55

def layout
  @layout
end

#line ⇒ Object (readonly)

Returns the value of attribute line.



55
56
57
 
# File 'lib/write_xlsx/chart.rb', line 55

def line
  @line
end

#pattern ⇒ Object (readonly)

Returns the value of attribute pattern.



55
56
57
 
# File 'lib/write_xlsx/chart.rb', line 55

def pattern
  @pattern
end