Class: Writexlsx::Package::RichValueStructure

Inherits:
Object
  • Object
show all
Includes:
Utility
Defined in:
lib/write_xlsx/package/rich_value_structure.rb

Overview

RichValueStructure - A class for writing the Excel XLSX rdrichvaluestructure.xml file.

Used in conjunction with Excel::Writer::XLSX

Copyright 2000-2024, John McNamara, [email protected]

Convert to Ruby by Hideo NAKAMURA, [email protected]

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

#initializeRichValueStructure

Returns a new instance of RichValueStructure.



24
25
26
27
# File 'lib/write_xlsx/package/rich_value_structure.rb', line 24

def initialize
  @writer = Package::XMLWriterSimple.new
  @has_embedded_descriptions = false
end

Instance Attribute Details

#has_embedded_descriptions=(value) ⇒ Object (writeonly)

Sets the attribute has_embedded_descriptions

Parameters:

  • value

    the value to set the attribute has_embedded_descriptions to.



22
23
24
# File 'lib/write_xlsx/package/rich_value_structure.rb', line 22

def has_embedded_descriptions=(value)
  @has_embedded_descriptions = value
end

Instance Method Details

#assemble_xml_fileObject



33
34
35
36
37
# File 'lib/write_xlsx/package/rich_value_structure.rb', line 33

def assemble_xml_file
  write_xml_declaration do
    write_rv_structures
  end
end

#set_xml_writer(filename) ⇒ Object



29
30
31
# File 'lib/write_xlsx/package/rich_value_structure.rb', line 29

def set_xml_writer(filename)
  @writer.set_xml_writer(filename)
end