Class: Writexlsx::Chart::Caption

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

Direct Known Subclasses

Axis

Constant Summary

Constants included from Utility

Utility::CHAR_WIDTHS, Utility::COL_MAX, Utility::PERL_TRUE_VALUES, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary collapse

Instance Method Summary collapse

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, #get_image_properties, #layout_properties, #legend_properties, #line_fill_properties, #line_properties, #palette_color, #params_to_font, #pattern_properties, #pixels_to_points, #process_bmp, #process_gif, #process_jpg, #process_png, #process_workbook_options, #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(chart) ⇒ Caption

Returns a new instance of Caption.



12
13
14
 
# File 'lib/write_xlsx/chart/caption.rb', line 12

def initialize(chart)
  @chart = chart
end

Instance Attribute Details

#data_id ⇒ Object

Returns the value of attribute data_id.



9
10
11
 
# File 'lib/write_xlsx/chart/caption.rb', line 9

def data_id
  @data_id
end

#formula ⇒ Object

Returns the value of attribute formula.



9
10
11
 
# File 'lib/write_xlsx/chart/caption.rb', line 9

def formula
  @formula
end

#layout ⇒ Object (readonly)

Returns the value of attribute layout.



10
11
12
 
# File 'lib/write_xlsx/chart/caption.rb', line 10

def layout
  @layout
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'lib/write_xlsx/chart/caption.rb', line 9

def name
  @name
end

#name_font ⇒ Object

Returns the value of attribute name_font.



9
10
11
 
# File 'lib/write_xlsx/chart/caption.rb', line 9

def name_font
  @name_font
end

#none ⇒ Object (readonly)

Returns the value of attribute none.



10
11
12
 
# File 'lib/write_xlsx/chart/caption.rb', line 10

def none
  @none
end

#overlay ⇒ Object (readonly)

Returns the value of attribute overlay.



10
11
12
 
# File 'lib/write_xlsx/chart/caption.rb', line 10

def overlay
  @overlay
end

Instance Method Details

#merge_with_hash(params) ⇒ Object

:nodoc:



16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/write_xlsx/chart/caption.rb', line 16

def merge_with_hash(params) # :nodoc:
  @name, @formula = @chart.process_names(params[:name], params[:name_formula])
  @data_id        = @chart.data_id(@formula, params[:data])
  @name_font      = convert_font_args(params[:name_font])
  @layout   = @chart.layout_properties(params[:layout], 1)

  # Set the title overlay option.
  @overlay  = params[:overlay]

  # Set the no automatic title option.
  @none = params[:none]
end