Class: Writexlsx::Package::Relationships

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

Constant Summary collapse

Schema_root = 
'http://schemas.openxmlformats.org'
Package_schema = 
Schema_root + '/package/2006/relationships'
Document_schema = 
Schema_root + '/officeDocument/2006/relationships'

Constants included from Utility

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

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

Returns a new instance of Relationships.



16
17
18
19
20
 
# File 'lib/write_xlsx/package/relationships.rb', line 16

def initialize
  @writer = Package::XMLWriterSimple.new
  @rels   = []
  @id     = 1
end

Instance Method Details

#add_document_relationship(type, target, target_mode = nil) ⇒ Object

Add container relationship to XLSX .rels xml files.



35
36
37
 
# File 'lib/write_xlsx/package/relationships.rb', line 35

def add_document_relationship(type, target, target_mode = nil)
  @rels.push([Document_schema + type, target, target_mode])
end

#add_ms_package_relationship(type, target) ⇒ Object

Add container relationship to XLSX .rels xml files. Uses MS schema.



49
50
51
52
 
# File 'lib/write_xlsx/package/relationships.rb', line 49

def add_ms_package_relationship(type, target)
  schema = 'http://schemas.microsoft.com/office/2006/relationships'
  @rels.push([schema + type, target])
end

#add_package_relationship(type, target) ⇒ Object

Add container relationship to XLSX .rels xml files.



42
43
44
 
# File 'lib/write_xlsx/package/relationships.rb', line 42

def add_package_relationship(type, target)
  @rels.push([Package_schema + type, target])
end

#add_rich_value_relationships ⇒ Object

Add relationships for RichValue files.



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/package/relationships.rb', line 64

def add_rich_value_relationships
  @rels << [
    'http://schemas.microsoft.com/office/2022/10/relationships/richValueRel',
    'richData/richValueRel.xml'
  ]

  @rels << [
    'http://schemas.microsoft.com/office/2017/06/relationships/rdRichValue',
    'richData/rdrichvalue.xml'
  ]

  @rels << [
    'http://schemas.microsoft.com/office/2017/06/relationships/rdRichValueStructure',
    'richData/rdrichvaluestructure.xml'
  ]

  @rels << [
    'http://schemas.microsoft.com/office/2017/06/relationships/rdRichValueTypes',
    'richData/rdRichValueTypes.xml'
  ]
end

#add_worksheet_relationship(type, target, target_mode = nil) ⇒ Object

Add worksheet relationship to sheet.rels xml files.



57
58
59
 
# File 'lib/write_xlsx/package/relationships.rb', line 57

def add_worksheet_relationship(type, target, target_mode = nil)
  @rels.push([Document_schema + type, target, target_mode])
end

#assemble_xml_file ⇒ Object 



26
27
28
29
30
 
# File 'lib/write_xlsx/package/relationships.rb', line 26

def assemble_xml_file
  write_xml_declaration do
    write_relationships
  end
end

#set_xml_writer(filename) ⇒ Object 



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

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