diff options
Diffstat (limited to 'doc/Axlsx/OneCellAnchor.html')
| -rw-r--r-- | doc/Axlsx/OneCellAnchor.html | 220 |
1 files changed, 126 insertions, 94 deletions
diff --git a/doc/Axlsx/OneCellAnchor.html b/doc/Axlsx/OneCellAnchor.html index eaec6d92..2952035f 100644 --- a/doc/Axlsx/OneCellAnchor.html +++ b/doc/Axlsx/OneCellAnchor.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage drawings, images and charts is -Worksheet#add_chart or Worksheet#add_image.</p> + <div class='inline'><p> +The recommended way to manage drawings, images and charts is +Worksheet#add_chart or Worksheet#add_image. +</p> </div> </div> - -<p>This class details a single cell anchor for drawings.</p> +<p> +This class details a single cell anchor for drawings. +</p> </div> @@ -145,8 +147,9 @@ Worksheet#add_chart or Worksheet#add_image.</p> - <span class="summary_desc"><div class='inline'> -<p>The drawing that holds this anchor.</p> + <span class="summary_desc"><div class='inline'><p> +The drawing that holds this anchor. +</p> </div></span> </li> @@ -171,8 +174,9 @@ Worksheet#add_chart or Worksheet#add_image.</p> - <span class="summary_desc"><div class='inline'> -<p>A marker that defines the from cell anchor.</p> + <span class="summary_desc"><div class='inline'><p> +A marker that defines the from cell anchor. +</p> </div></span> </li> @@ -197,9 +201,10 @@ Worksheet#add_chart or Worksheet#add_image.</p> - <span class="summary_desc"><div class='inline'> -<p>the height of the graphic object in pixels this is converted to EMU at a 92 -ppi resolution.</p> + <span class="summary_desc"><div class='inline'><p> +the height of the graphic object in pixels this is converted to EMU at a 92 +ppi resolution. +</p> </div></span> </li> @@ -224,8 +229,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>The object this anchor hosts.</p> + <span class="summary_desc"><div class='inline'><p> +The object this anchor hosts. +</p> </div></span> </li> @@ -250,8 +256,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>the width of the graphic object in pixels.</p> + <span class="summary_desc"><div class='inline'><p> +the width of the graphic object in pixels. +</p> </div></span> </li> @@ -286,8 +293,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this anchor in the drawing.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this anchor in the drawing. +</p> </div></span> </li> @@ -311,8 +319,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new OneCellAnchor object and an Pic associated with it.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new OneCellAnchor object and an Pic associated with it. +</p> </div></span> </li> @@ -334,8 +343,9 @@ ppi resolution.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the anchor.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the anchor. +</p> </div></span> </li> @@ -356,8 +366,9 @@ ppi resolution.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new OneCellAnchor object and an Pic associated with it.</p> + <p> +Creates a new OneCellAnchor object and an Pic associated with it. +</p> </div> @@ -389,8 +400,9 @@ ppi resolution.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -411,8 +423,9 @@ ppi resolution.</p> <span class="default"> </span> - — <div class='inline'> -<p>the col, row to start at</p> + — <div class='inline'><p> +the col, row to start at +</p> </div> </li> @@ -440,8 +453,9 @@ ppi resolution.</p> <span class="default"> </span> - — <div class='inline'> -<p>the file location of the image you will render</p> + — <div class='inline'><p> +the file location of the image you will render +</p> </div> </li> @@ -451,8 +465,9 @@ ppi resolution.</p> <span class="default"> </span> - — <div class='inline'> -<p>the name attribute for the rendered image</p> + — <div class='inline'><p> +the name attribute for the rendered image +</p> </div> </li> @@ -462,8 +477,9 @@ ppi resolution.</p> <span class="default"> </span> - — <div class='inline'> -<p>the description of the image rendered</p> + — <div class='inline'><p> +the description of the image rendered +</p> </div> </li> @@ -492,17 +508,18 @@ ppi resolution.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 39</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id drawing'>drawing</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@drawing</span> <span class='op'>=</span> <span class='id drawing'>drawing</span> - <span class='ivar'>@width</span> <span class='op'>=</span> <span class='int'>0</span> - <span class='ivar'>@height</span> <span class='op'>=</span> <span class='int'>0</span> - <span class='id drawing'>drawing</span><span class='period'>.</span><span class='id anchors'>anchors</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='ivar'>@from</span> <span class='op'>=</span> <span class='const'>Marker</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> - <span class='ivar'>@object</span> <span class='op'>=</span> <span class='const'>Pic</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<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='@width ivar id'>@width</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='@height ivar id'>@height</span> <span class='assign token'>=</span> <span class='integer val'>0</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='assign token'>=</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> + <span class='@object ivar id'>@object</span> <span class='assign token'>=</span> <span class='Pic constant id'>Pic</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='options identifier id'>options</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -525,8 +542,9 @@ ppi resolution.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The drawing that holds this anchor</p> + <p> +The drawing that holds this anchor +</p> </div> @@ -560,9 +578,10 @@ ppi resolution.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 18</span> -<span class='kw'>def</span> <span class='id drawing'>drawing</span> - <span class='ivar'>@drawing</span> -<span class='kw'>end</span></pre> +<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> @@ -580,9 +599,10 @@ ppi resolution.</p> </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> + <p> +A marker that defines the from cell anchor. The default from column and row +are 0 and 0 respectively +</p> </div> @@ -616,9 +636,10 @@ are 0 and 0 respectively</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 10</span> -<span class='kw'>def</span> <span class='id from'>from</span> - <span class='ivar'>@from</span> -<span class='kw'>end</span></pre> +<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> @@ -636,9 +657,10 @@ are 0 and 0 respectively</p> </p><div class="docstring"> <div class="discussion"> - -<p>the height of the graphic object in pixels this is converted to EMU at a 92 -ppi resolution</p> + <p> +the height of the graphic object in pixels this is converted to EMU at a 92 +ppi resolution +</p> </div> @@ -672,9 +694,10 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 28</span> -<span class='kw'>def</span> <span class='id height'>height</span> - <span class='ivar'>@height</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='height identifier id'>height</span> + <span class='@height ivar id'>@height</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -692,8 +715,9 @@ ppi resolution</p> </p><div class="docstring"> <div class="discussion"> - -<p>The object this anchor hosts</p> + <p> +The object this anchor hosts +</p> </div> @@ -727,9 +751,10 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 14</span> -<span class='kw'>def</span> <span class='id object'>object</span> - <span class='ivar'>@object</span> -<span class='kw'>end</span></pre> +<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> @@ -747,9 +772,10 @@ ppi resolution</p> </p><div class="docstring"> <div class="discussion"> - -<p>the width of the graphic object in pixels. this is converted to EMU at a 92 -ppi resolution</p> + <p> +the width of the graphic object in pixels. this is converted to EMU at a 92 +ppi resolution +</p> </div> @@ -783,9 +809,10 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 23</span> -<span class='kw'>def</span> <span class='id width'>width</span> - <span class='ivar'>@width</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='width identifier id'>width</span> + <span class='@width ivar id'>@width</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -807,8 +834,9 @@ ppi resolution</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this anchor in the drawing</p> + <p> +The index of this anchor in the drawing +</p> </div> @@ -842,9 +870,10 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 59</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@drawing</span><span class='period'>.</span><span class='id anchors'>anchors</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<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> @@ -859,8 +888,9 @@ ppi resolution</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the anchor</p> + <p> +Serializes the anchor +</p> </div> @@ -879,8 +909,9 @@ ppi resolution</p> — - <div class='inline'> -<p>The document builder instance this objects xml will be added to.</p> + <div class='inline'><p> +The document builder instance this objects xml will be added to. +</p> </div> </li> @@ -921,16 +952,17 @@ ppi resolution</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 66</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:oneCellAnchor</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:from</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id from'>from</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:ext</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id ext'>ext</span><span class='rparen'>)</span> - <span class='ivar'>@object</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xdr:clientData</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> -<span class='kw'>end</span></pre> +<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='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:oneCellAnchor'</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:ext'</span><span class='comma token'>,</span> <span class='ext identifier id'>ext</span><span class='rparen 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> @@ -941,9 +973,9 @@ ppi resolution</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:39 2011 by + Generated on Sun Nov 27 18:05:19 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> |