diff options
| author | Randy Morgan <[email protected]> | 2011-11-29 14:57:08 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-29 14:57:08 +0900 |
| commit | 25a73b821d4234e0a435fbee07f449c1a15ea1f4 (patch) | |
| tree | 299faa8cf2a416212cfda463d1d2e6d56727ec4d /doc/Axlsx/Pic.html | |
| parent | 51a57d7ef89ab5c5eea4341d8e3728fbf9d560f9 (diff) | |
| download | caxlsx-25a73b821d4234e0a435fbee07f449c1a15ea1f4.tar.gz caxlsx-25a73b821d4234e0a435fbee07f449c1a15ea1f4.zip | |
prepping for 1.0.10 release and travis integration
Diffstat (limited to 'doc/Axlsx/Pic.html')
| -rw-r--r-- | doc/Axlsx/Pic.html | 354 |
1 files changed, 202 insertions, 152 deletions
diff --git a/doc/Axlsx/Pic.html b/doc/Axlsx/Pic.html index 9a3e868e..505d49c0 100644 --- a/doc/Axlsx/Pic.html +++ b/doc/Axlsx/Pic.html @@ -94,9 +94,10 @@ <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> + <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> @@ -119,8 +120,9 @@ the recommended way to manage images in your sheets</p> <dt id="ALLOWED_EXTENSIONS-constant" class="">ALLOWED_EXTENSIONS = <div class="docstring"> <div class="discussion"> - -<p>allowed file extenstions</p> + <p> +allowed file extenstions +</p> </div> @@ -130,7 +132,8 @@ the recommended way to manage images in your sheets</p> </div> </dt> - <dd><pre class="code"><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>gif</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>jpeg</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>png</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>jpg</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span></pre></dd> + <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> @@ -158,8 +161,9 @@ the recommended way to manage images in your sheets</p> - <span class="summary_desc"><div class='inline'> -<p>The anchor for this image.</p> + <span class="summary_desc"><div class='inline'><p> +The anchor for this image. +</p> </div></span> </li> @@ -184,8 +188,9 @@ the recommended way to manage images in your sheets</p> - <span class="summary_desc"><div class='inline'> -<p>A description of the picture.</p> + <span class="summary_desc"><div class='inline'><p> +A description of the picture. +</p> </div></span> </li> @@ -210,9 +215,10 @@ the recommended way to manage images in your sheets</p> - <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> + <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> @@ -237,8 +243,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>The name to use for this picture.</p> + <span class="summary_desc"><div class='inline'><p> +The name to use for this picture. +</p> </div></span> </li> @@ -273,8 +280,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>returns the extension of image_src without the preceeding '.'.</p> + <span class="summary_desc"><div class='inline'><p> +returns the extension of image_src without the preceeding ’.’. +</p> </div></span> </li> @@ -296,8 +304,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>The file name of image_src without any path information.</p> + <span class="summary_desc"><div class='inline'><p> +The file name of image_src without any path information. +</p> </div></span> </li> @@ -319,8 +328,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>providing access to update the anchor's height attribute.</p> + <span class="summary_desc"><div class='inline'><p> +providing access to update the anchor’s height attribute. +</p> </div></span> </li> @@ -363,8 +373,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this image in the workbooks images collections.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this image in the workbooks images collections. +</p> </div></span> </li> @@ -388,8 +399,9 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Pic(ture) object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Pic(ture) object. +</p> </div></span> </li> @@ -411,9 +423,10 @@ at this time and only jpg support.</p> - <span class="summary_desc"><div class='inline'> -<p>The part name for this image used in serialization and relationship -building.</p> + <span class="summary_desc"><div class='inline'><p> +The part name for this image used in serialization and relationship +building. +</p> </div></span> </li> @@ -435,10 +448,11 @@ building.</p> - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the start anchor position If you need + <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> +rowOff. +</p> </div></span> </li> @@ -460,8 +474,9 @@ rowOff.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the picture.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the picture. +</p> </div></span> </li> @@ -483,8 +498,9 @@ rowOff.</p> - <span class="summary_desc"><div class='inline'> -<p>providing access to the anchor's width attribute.</p> + <span class="summary_desc"><div class='inline'><p> +providing access to the anchor’s width attribute. +</p> </div></span> </li> @@ -526,8 +542,9 @@ rowOff.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Pic(ture) object</p> + <p> +Creates a new Pic(ture) object +</p> </div> @@ -546,8 +563,9 @@ rowOff.</p> — - <div class='inline'> -<p>the anchor that holds this image</p> + <div class='inline'><p> +the anchor that holds this image +</p> </div> </li> @@ -564,8 +582,9 @@ rowOff.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -663,8 +682,9 @@ rowOff.</p> — - <div class='inline'> -<p>the object that the method was called on</p> + <div class='inline'><p> +the object that the method was called on +</p> </div> </li> @@ -690,15 +710,16 @@ rowOff.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 38</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id anchor'>anchor</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'>@anchor</span> <span class='op'>=</span> <span class='id anchor'>anchor</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id drawing'>drawing</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id images'>images</span> <span class='op'><<</span> <span class='kw'>self</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='id start_at'>start_at</span><span class='lparen'>(</span><span class='op'>*</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span> - <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</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='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> @@ -721,8 +742,9 @@ rowOff.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The anchor for this image</p> + <p> +The anchor for this image +</p> </div> @@ -756,9 +778,10 @@ rowOff.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 27</span> -<span class='kw'>def</span> <span class='id anchor'>anchor</span> - <span class='ivar'>@anchor</span> -<span class='kw'>end</span></pre> +<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> @@ -776,8 +799,9 @@ rowOff.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A description of the picture</p> + <p> +A description of the picture +</p> </div> @@ -811,9 +835,10 @@ rowOff.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 18</span> -<span class='kw'>def</span> <span class='id descr'>descr</span> - <span class='ivar'>@descr</span> -<span class='kw'>end</span></pre> +<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> @@ -831,9 +856,10 @@ rowOff.</p> </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> + <p> +The path to the image you want to include Only local images are supported +at this time and only jpg support +</p> </div> @@ -867,9 +893,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 23</span> -<span class='kw'>def</span> <span class='id image_src'>image_src</span> - <span class='ivar'>@image_src</span> -<span class='kw'>end</span></pre> +<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> @@ -887,8 +914,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>The name to use for this picture</p> + <p> +The name to use for this picture +</p> </div> @@ -922,9 +950,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 13</span> -<span class='kw'>def</span> <span class='id name'>name</span> - <span class='ivar'>@name</span> -<span class='kw'>end</span></pre> +<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> @@ -946,8 +975,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>returns the extension of image_src without the preceeding '.'</p> + <p> +returns the extension of image_src without the preceeding ’.’ +</p> </div> @@ -981,9 +1011,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 70</span> -<span class='kw'>def</span> <span class='id extname'>extname</span> - <span class='const'>File</span><span class='period'>.</span><span class='id extname'>extname</span><span class='lparen'>(</span><span class='id image_src'>image_src</span><span class='rparen'>)</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id image_src'>image_src</span><span class='period'>.</span><span class='id nil?'>nil?</span> -<span class='kw'>end</span></pre> +<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> @@ -998,8 +1029,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>The file name of image_src without any path information</p> + <p> +The file name of image_src without any path information +</p> </div> @@ -1033,9 +1065,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 64</span> -<span class='kw'>def</span> <span class='id file_name'>file_name</span> - <span class='const'>File</span><span class='period'>.</span><span class='id basename'>basename</span><span class='lparen'>(</span><span class='id image_src'>image_src</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id image_src'>image_src</span><span class='period'>.</span><span class='id nil?'>nil?</span> -<span class='kw'>end</span></pre> +<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> @@ -1050,8 +1083,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>providing access to update the anchor's height attribute</p> + <p> +providing access to update the anchor’s height attribute +</p> </div> @@ -1094,9 +1128,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 101</span> -<span class='kw'>def</span> <span class='id height'>height</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id height'>height</span> -<span class='kw'>end</span></pre> +<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> @@ -1138,9 +1173,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 106</span> -<span class='kw'>def</span> <span class='id height='>height=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id height'>height</span> <span class='op'>=</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<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> @@ -1155,8 +1191,9 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this image in the workbooks images collections</p> + <p> +The index of this image in the workbooks images collections +</p> </div> @@ -1190,9 +1227,10 @@ at this time and only jpg support</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 76</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id drawing'>drawing</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id images'>images</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='@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> @@ -1207,9 +1245,10 @@ at this time and only jpg support</p> </p><div class="docstring"> <div class="discussion"> - -<p>The part name for this image used in serialization and relationship -building</p> + <p> +The part name for this image used in serialization and relationship +building +</p> </div> @@ -1243,9 +1282,10 @@ building</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 82</span> -<span class='kw'>def</span> <span class='id pn'>pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>IMAGE_PN</span> <span class='op'>%</span> <span class='lbracket'>[</span><span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id extname'>extname</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<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> @@ -1260,10 +1300,11 @@ building</p> </p><div class="docstring"> <div class="discussion"> - -<p>This is a short cut method to set the start anchor position If you need + <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> +rowOff +</p> </div> @@ -1282,8 +1323,9 @@ rowOff</p> — - <div class='inline'> -<p>The column</p> + <div class='inline'><p> +The column +</p> </div> </li> @@ -1298,8 +1340,9 @@ rowOff</p> — - <div class='inline'> -<p>The row</p> + <div class='inline'><p> +The row +</p> </div> </li> @@ -1334,10 +1377,11 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 116</span> -<span class='kw'>def</span> <span class='id start_at'>start_at</span><span class='lparen'>(</span><span class='id x'>x</span><span class='comma'>,</span> <span class='id y'>y</span><span class='rparen'>)</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id from'>from</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id x'>x</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id from'>from</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id y'>y</span> -<span class='kw'>end</span></pre> +<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> @@ -1352,8 +1396,9 @@ rowOff</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the picture</p> + <p> +Serializes the picture +</p> </div> @@ -1372,8 +1417,9 @@ rowOff</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> @@ -1429,31 +1475,32 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 124</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:pic</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:nvPicPr</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:cNvPr</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:id</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>2</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='op'>=></span><span class='id name'>name</span><span class='comma'>,</span> <span class='symbol'>:descr</span><span class='op'>=></span><span class='id descr'>descr</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:cNvPicPr</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'>a:picLocks</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:noChangeAspect</span><span class='op'>=></span><span class='int'>1</span><span class='rparen'>)</span> - <span class='rbrace'>}</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:blipFill</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'>a:blip</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:xmlns:r</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_R</span><span class='comma'>,</span> <span class='symbol'>:r:embed</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId1</span><span class='tstring_end'>"</span></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'>a:stretch</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'>a:fillRect</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</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:spPr</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'>a:xfrm</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'>a:off</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:x</span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span> <span class='symbol'>:y</span><span class='op'>=></span><span class='int'>0</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'>a:ext</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:cx</span><span class='op'>=></span><span class='int'>2336800</span><span class='comma'>,</span> <span class='symbol'>:cy</span><span class='op'>=></span><span class='int'>2161540</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'>a:prstGeom</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:prst</span><span class='op'>=></span><span class='symbol'>:rect</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'>a:avLst</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</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: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> @@ -1468,8 +1515,9 @@ rowOff</p> </p><div class="docstring"> <div class="discussion"> - -<p>providing access to the anchor's width attribute</p> + <p> +providing access to the anchor’s width attribute +</p> </div> @@ -1512,9 +1560,10 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 89</span> -<span class='kw'>def</span> <span class='id width'>width</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id width'>width</span> -<span class='kw'>end</span></pre> +<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> @@ -1556,9 +1605,10 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 94</span> -<span class='kw'>def</span> <span class='id width='>width=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> - <span class='ivar'>@anchor</span><span class='period'>.</span><span class='id width'>width</span> <span class='op'>=</span> <span class='id v'>v</span> -<span class='kw'>end</span></pre> +<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> @@ -1569,9 +1619,9 @@ rowOff</p> </div> <div id="footer"> - Generated on Sun Nov 27 22:10:46 2011 by + Generated on Tue Nov 29 13:28:54 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> |
