diff options
Diffstat (limited to 'doc/Axlsx/Relationship.html')
| -rw-r--r-- | doc/Axlsx/Relationship.html | 554 |
1 files changed, 554 insertions, 0 deletions
diff --git a/doc/Axlsx/Relationship.html b/doc/Axlsx/Relationship.html new file mode 100644 index 00000000..9d94f557 --- /dev/null +++ b/doc/Axlsx/Relationship.html @@ -0,0 +1,554 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Class: Axlsx::Relationship + + — Documentation by YARD 0.7.3 + +</title> + + <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + relpath = '..'; + if (relpath != '') relpath += '/'; +</script> + + <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> + + + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> + + <div id="header"> + <div id="menu"> + + <a href="../_index.html">Index (R)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Relationship</span> + + + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> + + <div id="search"> + + <a id="class_list_link" href="#">Class List</a> + + <a id="method_list_link" href="#">Method List</a> + + <a id="file_list_link" href="#">File List</a> + +</div> + <div class="clear"></div> + </div> + + <iframe id="search_frame"></iframe> + + <div id="content"><h1>Class: Axlsx::Relationship + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Axlsx::Relationship</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/rels/relationship.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +Packages automatcially manage relationships. +</p> +</div> + </div> + +<p> +A relationship defines a reference between package parts. +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + + <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#Target-instance_method" title="#Target (instance method)">- (String) <strong>Target</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The location of the relationship target. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#Type-instance_method" title="#Type (instance method)">- (String) <strong>Type</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The type of relationship. +</p> +</div></span> + +</li> + + + </ul> + + + + + + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> + + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Relationship) <strong>initialize</strong>(type, target) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A new instance of Relationship. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml, rId) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the relationship TODO: use object.rId to get this infomation. +</p> +</div></span> + +</li> + + + </ul> + + +<div id="constructor_details" class="method_details_list"> + <h2>Constructor Details</h2> + + <div class="method_details first"> + <p class="signature first" id="initialize-instance_method"> + + - (<tt><span class='object_link'><a href="" title="Axlsx::Relationship (class)">Relationship</a></span></tt>) <strong>initialize</strong>(type, target) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A new instance of Relationship +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +24 +25 +26 +27</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 24</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='type identifier id'>type</span><span class='comma token'>,</span> <span class='target identifier id'>target</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='Target constant id'>Target</span><span class='assign token'>=</span><span class='target identifier id'>target</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='Type constant id'>Type</span><span class='assign token'>=</span><span class='type identifier id'>type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + +</div> + + <div id="instance_attr_details" class="attr_details"> + <h2>Instance Attribute Details</h2> + + + <span id="Target=-instance_method"></span> + <span id="Target-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="Target-instance_method"> + + - (<tt>String</tt>) <strong>Target</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The location of the relationship target +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +8 +9 +10</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 8</span> + +<span class='def def kw'>def</span> <span class='Target constant id'>Target</span> + <span class='@Target ivar id'>@Target</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="Type=-instance_method"></span> + <span id="Type-instance_method"></span> + <div class="method_details "> + <p class="signature " id="Type-instance_method"> + + - (<tt>String</tt>) <strong>Type</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'><p> +Supported types are defined as constants in Axlsx: +</p> +</div> + </div> + +<p> +The type of relationship +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="../Axlsx.html#XML_NS_R-constant" title="Axlsx::XML_NS_R (constant)">XML_NS_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#TABLE_R-constant" title="Axlsx::TABLE_R (constant)">TABLE_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#WORKBOOK_R-constant" title="Axlsx::WORKBOOK_R (constant)">WORKBOOK_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#WORKSHEET_R-constant" title="Axlsx::WORKSHEET_R (constant)">WORKSHEET_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#APP_R-constant" title="Axlsx::APP_R (constant)">APP_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#RELS_R-constant" title="Axlsx::RELS_R (constant)">Axlsx::RELS_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#CORE_R-constant" title="Axlsx::CORE_R (constant)">CORE_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#STYLES_R-constant" title="Axlsx::STYLES_R (constant)">STYLES_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#CHART_R-constant" title="Axlsx::CHART_R (constant)">CHART_R</a></span></li> + + <li><span class='object_link'><a href="../Axlsx.html#DRAWING_R-constant" title="Axlsx::DRAWING_R (constant)">DRAWING_R</a></span></li> + + </ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +23 +24 +25</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 23</span> + +<span class='def def kw'>def</span> <span class='Type constant id'>Type</span> + <span class='@Type ivar id'>@Type</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + + + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> + + + <div class="method_details first"> + <p class="signature first" id="to_xml-instance_method"> + + - (<tt>String</tt>) <strong>to_xml</strong>(xml, rId) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the relationship TODO: use object.rId to get this infomation +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>xml</span> + + + <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span> + + + + — + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> +</div> + + </li> + + <li> + + <span class='name'>rId</span> + + + <span class='type'>(<tt>String</tt>)</span> + + + + — + <div class='inline'><p> +the reference id of the object. +</p> +</div> + + </li> + +</ul> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +37 +38 +39 +40 +41</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 37</span> + +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='comma token'>,</span> <span class='rId identifier id'>rId</span><span class='rparen token'>)</span> + <span class='h identifier id'>h</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span> + <span class='h identifier id'>h</span><span class='lbrack token'>[</span><span class='symbol val'>:Id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rId identifier id'>rId</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationship constant id'>Relationship</span><span class='lparen token'>(</span><span class='h identifier id'>h</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:43:54 2011 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.7.3 (ruby-1.8.7). +</div> + + </body> +</html>
\ No newline at end of file |