diff options
| author | Randy Morgan <[email protected]> | 2011-12-01 14:11:42 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-12-01 14:11:42 +0900 |
| commit | 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 (patch) | |
| tree | 9c5a214c0ac49b56d08be769fbe0634ac1e5b0a4 /doc/Axlsx/TwoCellAnchor.html | |
| parent | 076be316935180341d7ee7a9335281a4b18d1fa9 (diff) | |
| download | caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip | |
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx/TwoCellAnchor.html')
| -rw-r--r-- | doc/Axlsx/TwoCellAnchor.html | 948 |
1 files changed, 0 insertions, 948 deletions
diff --git a/doc/Axlsx/TwoCellAnchor.html b/doc/Axlsx/TwoCellAnchor.html deleted file mode 100644 index 388b1e26..00000000 --- a/doc/Axlsx/TwoCellAnchor.html +++ /dev/null @@ -1,948 +0,0 @@ -<!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::TwoCellAnchor - - — AXLSX - -</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 (T)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">TwoCellAnchor</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::TwoCellAnchor - - - -</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::TwoCellAnchor</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/two_cell_anchor.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>The recommended way to manage drawings and charts is Worksheet#add_chart. -Anchors are specified by the :start_at and :end_at options to that method.</p> -</div> - </div> - - -<p>This class details the anchor points for drawings.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Worksheet#add_chart</a></span></li> - - </ul> - -</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="#drawing-instance_method" title="#drawing (instance method)">- (Drawing) <strong>drawing</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The drawing that holds this anchor.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#from-instance_method" title="#from (instance method)">- (Marker) <strong>from</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A marker that defines the from cell anchor.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#object-instance_method" title="#object (instance method)">- (Pic, GraphicFrame) <strong>object</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The object this anchor hosts.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#to-instance_method" title="#to (instance method)">- (Marker) <strong>to</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A marker that returns the to cell anchor.</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="#add_chart-instance_method" title="#add_chart (instance method)">- (Chart) <strong>add_chart</strong>(chart_type, options) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a graphic frame and chart object associated with this anchor.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this anchor in the drawing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (TwoCellAnchor) <strong>initialize</strong>(drawing, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new TwoCellAnchor object and sets up a reference to the from and -to markers in the graphic_frame’s chart.</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) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the two cell anchor.</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::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>) <strong>initialize</strong>(drawing, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>the chart_type parameter will be replaced with object in v. 2.0.0</p> -</div> - </div> - - -<p>Creates a new TwoCellAnchor object and sets up a reference to the from and -to markers in the graphic_frame’s chart. That means that you can do -stuff like c = worksheet.add_chart Axlsx::Chart c.start_at 5, 9</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>drawing</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span> - - - - </li> - - <li> - - <span class='name'>chart_type</span> - - - <span class='type'>(<tt>Class</tt>)</span> - - - - — - <div class='inline'> -<p>This is passed to the graphic frame for instantiation. must be Chart or a -subclass of Chart</p> -</div> - - </li> - - <li> - - <span class='name'>object</span> - - - <span class='type'></span> - - - - — - <div class='inline'> -<p>The object this anchor holds.</p> -</div> - - </li> - - <li> - - <span class='name'>options</span> - - - <span class='type'>(<tt>Hash</tt>)</span> - - - <em class="default">(defaults to: <tt>{}</tt>)</em> - - - — - <div class='inline'> -<p>a customizable set of options</p> -</div> - - </li> - -</ul> - - - - - - - <h3>Options Hash (<tt>options</tt>):</h3> - <ul class="option"> - - <li> - <span class="name">start_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>the col, row to start at</p> -</div> - </li> - - <li> - <span class="name">end_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>the col, row to end at</p> -</div> - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -38 -39 -40 -41 -42</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='drawing identifier id'>drawing</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> - <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span> - <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='@from ivar id'>@from</span><span class='comma token'>,</span> <span class='@to ivar id'>@to</span> <span class='assign token'>=</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:col</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='symbol val'>:row=</span><span class='gt op'>></span><span class='integer val'>10</span><span class='rparen token'>)</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=""></span> - <span id="drawing-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="drawing-instance_method"> - - - (<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>) <strong>drawing</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The drawing that holds this anchor</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 25</span> - -<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> - <span class='@drawing ivar id'>@drawing</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="from-instance_method"></span> - <div class="method_details "> - <p class="signature " id="from-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>from</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A marker that defines the from cell anchor. The default from column and row -are 0 and 0 respectively</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -9 -10 -11</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='from identifier id'>from</span> - <span class='@from ivar id'>@from</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="object-instance_method"></span> - <div class="method_details "> - <p class="signature " id="object-instance_method"> - - - (<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>, <tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>) <strong>object</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The object this anchor hosts</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>, <tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='object identifier id'>object</span> - <span class='@object ivar id'>@object</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="to-instance_method"></span> - <div class="method_details "> - <p class="signature " id="to-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>to</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A marker that returns the to cell anchor. The default to column and row are -5 and 10 respectively</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -12 -13 -14</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 12</span> - -<span class='def def kw'>def</span> <span class='to identifier id'>to</span> - <span class='@to ivar id'>@to</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="add_chart-instance_method"> - - - (<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>) <strong>add_chart</strong>(chart_type, options) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a graphic frame and chart object associated with this anchor</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -46 -47 -48 -49</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 46</span> - -<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@object ivar id'>@object</span> <span class='assign token'>=</span> <span class='GraphicFrame constant id'>GraphicFrame</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@object ivar id'>@object</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this anchor in the drawing</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -53 -54 -55</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 53</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@drawing ivar id'>@drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the two cell anchor</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> - -</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"> - - -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 59</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='rparen token'>)</span> - <span class='comment val'>#build it for now, break it down later!</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:twoCellAnchor'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:from'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='from identifier id'>from</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:to'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='to identifier id'>to</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='@object ivar id'>@object</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:clientData'</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Wed Nov 30 08:46:24 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 |