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/Pic.html | |
| parent | 076be316935180341d7ee7a9335281a4b18d1fa9 (diff) | |
| download | caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip | |
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx/Pic.html')
| -rw-r--r-- | doc/Axlsx/Pic.html | 1594 |
1 files changed, 0 insertions, 1594 deletions
diff --git a/doc/Axlsx/Pic.html b/doc/Axlsx/Pic.html deleted file mode 100644 index cb791160..00000000 --- a/doc/Axlsx/Pic.html +++ /dev/null @@ -1,1594 +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::Pic - - — 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 (P)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Pic</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::Pic - - - -</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::Pic</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/pic.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>a Pic object represents an image in your worksheet Worksheet#add_image is -the recommended way to manage images in your sheets</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</a></span></li> - - </ul> - -</div> - <h2>Constant Summary</h2> - - <dl class="constants"> - - <dt id="ALLOWED_EXTENSIONS-constant" class="">ALLOWED_EXTENSIONS = - <div class="docstring"> - <div class="discussion"> - -<p>allowed file extenstions</p> - - - </div> -</div> -<div class="tags"> - - -</div> - </dt> - <dd><pre class="code"><span class='lbrack token'>[</span><span class='string val'>'gif'</span><span class='comma token'>,</span> <span class='string val'>'jpeg'</span><span class='comma token'>,</span> <span class='string val'>'png'</span><span class='comma token'>,</span> <span class='string val'>'jpg'</span><span class='rbrack token'>]</span> -</pre></dd> - - </dl> - - - - <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="#anchor-instance_method" title="#anchor (instance method)">- (OneCellAnchor) <strong>anchor</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The anchor for this image.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#descr-instance_method" title="#descr (instance method)">- (String) <strong>descr</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A description of the picture.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#image_src-instance_method" title="#image_src (instance method)">- (String) <strong>image_src</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The path to the image you want to include Only local images are supported -at this time and only jpg support.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name to use for this picture.</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="#extname-instance_method" title="#extname (instance method)">- (String) <strong>extname</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>returns the extension of image_src without the preceeding ‘.’.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#file_name-instance_method" title="#file_name (instance method)">- (String) <strong>file_name</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The file name of image_src without any path information.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#height-instance_method" title="#height (instance method)">- (Object) <strong>height</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>providing access to update the anchor’s height attribute.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#height%3D-instance_method" title="#height= (instance method)">- (Object) <strong>height=</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'></div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Index) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this image in the workbooks images collections.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Pic) <strong>initialize</strong>(anchor, options = {}) {|_self| ... }</a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Pic(ture) object.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The part name for this image used in serialization and relationship -building.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#start_at-instance_method" title="#start_at (instance method)">- (Marker) <strong>start_at</strong>(x, y) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the start anchor position If you need -finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff.</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 picture.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#width-instance_method" title="#width (instance method)">- (Object) <strong>width</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>providing access to the anchor’s width attribute.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#width%3D-instance_method" title="#width= (instance method)">- (Object) <strong>width=</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'></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::Pic (class)">Pic</a></span></tt>) <strong>initialize</strong>(anchor, options = {}) {|_self| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Pic(ture) object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>anchor</span> - - - <span class='type'>(<tt>Anchor</tt>)</span> - - - - — - <div class='inline'> -<p>the anchor that holds this image</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">name</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">descr</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">image_src</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">start_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">width</span> - <span class="type">(<tt>Intger</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">height</span> - <span class="type">(<tt>Intger</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>_self</tt>)</span> - - - - </li> - -</ul> -<h3>Yield Parameters:</h3> -<ul class="yieldparam"> - - <li> - - <span class='name'>_self</span> - - - <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Pic (class)">Axlsx::Pic</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>the object that the method was called on</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -38 -39 -40 -41 -42 -43 -44 -45 -46</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.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='anchor identifier id'>anchor</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='@anchor ivar id'>@anchor</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</span> <span class='lshft op'><<</span> <span class='self self kw'>self</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='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> - <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</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="anchor-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="anchor-instance_method"> - - - (<tt><span class='object_link'><a href="OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span></tt>) <strong>anchor</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The anchor for this image</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -27 -28 -29</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 27</span> - -<span class='def def kw'>def</span> <span class='anchor identifier id'>anchor</span> - <span class='@anchor ivar id'>@anchor</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="descr=-instance_method"></span> - <span id="descr-instance_method"></span> - <div class="method_details "> - <p class="signature " id="descr-instance_method"> - - - (<tt>String</tt>) <strong>descr</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A description of the picture</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"> - - -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='descr identifier id'>descr</span> - <span class='@descr ivar id'>@descr</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="image_src=-instance_method"></span> - <span id="image_src-instance_method"></span> - <div class="method_details "> - <p class="signature " id="image_src-instance_method"> - - - (<tt>String</tt>) <strong>image_src</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The path to the image you want to include Only local images are supported -at this time and only jpg support</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"> - - -23 -24 -25</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 23</span> - -<span class='def def kw'>def</span> <span class='image_src identifier id'>image_src</span> - <span class='@image_src ivar id'>@image_src</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="name=-instance_method"></span> - <span id="name-instance_method"></span> - <div class="method_details "> - <p class="signature " id="name-instance_method"> - - - (<tt>String</tt>) <strong>name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name to use for this picture</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"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='name identifier id'>name</span> - <span class='@name ivar id'>@name</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="extname-instance_method"> - - - (<tt>String</tt>) <strong>extname</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>returns the extension of image_src without the preceeding ‘.’</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"> - - -70 -71 -72</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 70</span> - -<span class='def def kw'>def</span> <span class='extname identifier id'>extname</span> - <span class='File constant id'>File</span><span class='dot token'>.</span><span class='extname identifier id'>extname</span><span class='lparen token'>(</span><span class='image_src identifier id'>image_src</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='string val'>'.'</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='image_src identifier id'>image_src</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="file_name-instance_method"> - - - (<tt>String</tt>) <strong>file_name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The file name of image_src without any path information</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"> - - -64 -65 -66</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 64</span> - -<span class='def def kw'>def</span> <span class='file_name identifier id'>file_name</span> - <span class='File constant id'>File</span><span class='dot token'>.</span><span class='basename identifier id'>basename</span><span class='lparen token'>(</span><span class='image_src identifier id'>image_src</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='image_src identifier id'>image_src</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="height-instance_method"> - - - (<tt>Object</tt>) <strong>height</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>providing access to update the anchor’s height attribute</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>v</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>OneCellAnchor.width</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -101 -102 -103</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 101</span> - -<span class='def def kw'>def</span> <span class='height identifier id'>height</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='height identifier id'>height</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="height=-instance_method"> - - - (<tt>Object</tt>) <strong>height=</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>height</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -106 -107 -108</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 106</span> - -<span class='def def kw'>def</span> <span class='height= identifier id'>height=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='height identifier id'>height</span> <span class='assign token'>=</span> <span class='v identifier id'>v</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>Index</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this image in the workbooks images collections</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Index</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -76 -77 -78</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 76</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</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="pn-instance_method"> - - - (<tt>String</tt>) <strong>pn</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The part name for this image used in serialization and relationship -building</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"> - - -82 -83 -84</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 82</span> - -<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> - <span class='dstring node'>"#{IMAGE_PN % [(index+1), extname]}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="start_at-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>start_at</strong>(x, y) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>This is a short cut method to set the start anchor position If you need -finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>x</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The column</p> -</div> - - </li> - - <li> - - <span class='name'>y</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The row</p> -</div> - - </li> - -</ul> - -<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"> - - -116 -117 -118 -119</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 116</span> - -<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</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 picture</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"> - - -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 124</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='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:pic'</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:nvPicPr'</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:cNvPr'</span><span class='comma token'>,</span> <span class='symbol val'>:id=</span><span class='gt op'>></span><span class='string val'>"2"</span><span class='comma token'>,</span> <span class='symbol val'>:name=</span><span class='gt op'>></span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:descr=</span><span class='gt op'>></span><span class='descr identifier id'>descr</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:cNvPicPr'</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'>'a:picLocks'</span><span class='comma token'>,</span> <span class='symbol val'>:noChangeAspect=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> - <span class='rbrace 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:blipFill'</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'>'a:blip'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='comma token'>,</span> <span class='symbol val'>:'r:embed'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"rId1"</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'>'a:stretch'</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'>'a:fillRect'</span><span class='rparen token'>)</span> - <span class='rbrace 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:spPr'</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'>'a:xfrm'</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'>'a:off'</span><span class='comma token'>,</span> <span class='symbol val'>:x=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:y=</span><span class='gt op'>></span><span class='integer val'>0</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'>'a:ext'</span><span class='comma token'>,</span> <span class='symbol val'>:cx=</span><span class='gt op'>></span><span class='integer val'>2336800</span><span class='comma token'>,</span> <span class='symbol val'>:cy=</span><span class='gt op'>></span><span class='integer val'>2161540</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'>'a:prstGeom'</span><span class='comma token'>,</span> <span class='symbol val'>:prst=</span><span class='gt op'>></span><span class='symbol val'>:rect</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'>'a:avLst'</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="width-instance_method"> - - - (<tt>Object</tt>) <strong>width</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>providing access to the anchor’s width attribute</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>v</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>OneCellAnchor.width</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -89 -90 -91</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 89</span> - -<span class='def def kw'>def</span> <span class='width identifier id'>width</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='width identifier id'>width</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="width=-instance_method"> - - - (<tt>Object</tt>) <strong>width=</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>width</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -94 -95 -96</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 94</span> - -<span class='def def kw'>def</span> <span class='width= identifier id'>width=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='assign token'>=</span> <span class='v identifier id'>v</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:33 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 |