Class: Writexlsx::Package::Metadata

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

Overview

Metadata - A class for writing the Excel XLSX metadata.xml file.

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(workbook) ⇒ Metadata

Returns a new instance of Metadata.



18
19
20
21
22
23
24
 
# File 'lib/write_xlsx/package/metadata.rb', line 18

def initialize(workbook)
  @writer = Package::XMLWriterSimple.new
  @workbook = workbook
  @has_dynamic_functions = false
  @has_embedded_images   = false
  @num_embedded_images   = 0
end

Instance Attribute Details

#has_dynamic_functions=(value) ⇒ Object (writeonly)

Sets the attribute has_dynamic_functions

Parameters:

  • value —

    the value to set the attribute has_dynamic_functions to.



15
16
17
 
# File 'lib/write_xlsx/package/metadata.rb', line 15

def has_dynamic_functions=(value)
  @has_dynamic_functions = value
end

#num_embedded_images=(value) ⇒ Object (writeonly)

Sets the attribute num_embedded_images

Parameters:

  • value —

    the value to set the attribute num_embedded_images to.



16
17
18
 
# File 'lib/write_xlsx/package/metadata.rb', line 16

def num_embedded_images=(value)
  @num_embedded_images = value
end

Instance Method Details

#assemble_xml_file ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/write_xlsx/package/metadata.rb', line 30

def assemble_xml_file
  @has_embedded_images = true if @num_embedded_images > 0

  write_xml_declaration do
    # Write the metadata element.
    write_metadata

    # Write the metadataTypes element.
    write_metadata_types

    # Write the futureMetadata element.
    write_cell_future_metadata  if @has_dynamic_functions
    write_value_future_metadata if @has_embedded_images

    # Write the cellMetadata element.
    write_cell_metadata  if @has_dynamic_functions
    write_value_metadata if @has_embedded_images

    @writer.end_tag('metadata')
  end
end

#set_xml_writer(filename) ⇒ Object 



26
27
28
 
# File 'lib/write_xlsx/package/metadata.rb', line 26

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