Class: Writexlsx::Package::Relationships

Inherits:
Object
  • Object
show all
Includes:
Utility::XmlPrimitives
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'

Instance Method Summary collapse

Methods included from Utility::XmlPrimitives

#r_id_attributes, #write_color, #write_xml_declaration, #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