diff options
Diffstat (limited to 'doc/Axlsx/Title.html')
| -rw-r--r-- | doc/Axlsx/Title.html | 213 |
1 files changed, 58 insertions, 155 deletions
diff --git a/doc/Axlsx/Title.html b/doc/Axlsx/Title.html index 1e38aab7..a9d6c7c5 100644 --- a/doc/Axlsx/Title.html +++ b/doc/Axlsx/Title.html @@ -6,7 +6,7 @@ <title> Class: Axlsx::Title - — Documentation by YARD 0.7.3 + — AXLSX </title> @@ -94,9 +94,8 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - <p> -A Title stores information about the title of a chart -</p> + +<p>A Title stores information about the title of a chart</p> </div> @@ -132,9 +131,8 @@ A Title stores information about the title of a chart - <span class="summary_desc"><div class='inline'><p> -The cell that holds the text for the title. -</p> + <span class="summary_desc"><div class='inline'> +<p>The cell that holds the text for the title.</p> </div></span> </li> @@ -159,9 +157,8 @@ The cell that holds the text for the title. - <span class="summary_desc"><div class='inline'><p> -The text to be shown. -</p> + <span class="summary_desc"><div class='inline'> +<p>The text to be shown.</p> </div></span> </li> @@ -198,34 +195,8 @@ The text to be shown. - <span class="summary_desc"><div class='inline'><p> -Creates a new Title object. -</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#range-instance_method" title="#range (instance method)">- (String) <strong>range</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'><p> -returns the excel style abslute reference for the title when title is a -Cell object. -</p> + <span class="summary_desc"><div class='inline'> +<p>Creates a new Title object.</p> </div></span> </li> @@ -247,9 +218,8 @@ Cell object. - <span class="summary_desc"><div class='inline'><p> -Serializes the chart title. -</p> + <span class="summary_desc"><div class='inline'> +<p>Serializes the chart title.</p> </div></span> </li> @@ -270,9 +240,8 @@ Serializes the chart title. </p><div class="docstring"> <div class="discussion"> - <p> -Creates a new Title object -</p> + +<p>Creates a new Title object</p> </div> @@ -293,9 +262,8 @@ Creates a new Title object — - <div class='inline'><p> -The cell or string to be used for the chart’s title -</p> + <div class='inline'> +<p>The cell or string to be used for the chart's title</p> </div> </li> @@ -317,11 +285,10 @@ The cell or string to be used for the chart’s title <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 15</span> -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='title identifier id'>title</span><span class='assign token'>=</span><span class='string val'>""</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='cell identifier id'>cell</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span> <span class='if if_mod kw'>if</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='text identifier id'>text</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> <span class='unless unless_mod kw'>unless</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id title'>title</span><span class='op'>=</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id cell'>cell</span> <span class='op'>=</span> <span class='id title'>title</span> <span class='kw'>if</span> <span class='id title'>title</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Cell</span><span class='rparen'>)</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id text'>text</span> <span class='op'>=</span> <span class='id title'>title</span><span class='period'>.</span><span class='id to_s'>to_s</span> <span class='kw'>unless</span> <span class='id title'>title</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Cell</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -344,10 +311,9 @@ The cell or string to be used for the chart’s title </p><div class="docstring"> <div class="discussion"> - <p> -The cell that holds the text for the title. Setting this property will -automatically update the text attribute. -</p> + +<p>The cell that holds the text for the title. Setting this property will +automatically update the text attribute.</p> </div> @@ -381,10 +347,9 @@ automatically update the text attribute. <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 11</span> -<span class='def def kw'>def</span> <span class='cell identifier id'>cell</span> - <span class='@cell ivar id'>@cell</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id cell'>cell</span> + <span class='ivar'>@cell</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -402,10 +367,9 @@ automatically update the text attribute. </p><div class="docstring"> <div class="discussion"> - <p> -The text to be shown. Setting this property directly with a string will -remove the cell reference. -</p> + +<p>The text to be shown. Setting this property directly with a string will +remove the cell reference.</p> </div> @@ -439,10 +403,9 @@ remove the cell reference. <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 7</span> -<span class='def def kw'>def</span> <span class='text identifier id'>text</span> - <span class='@text ivar id'>@text</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id text'>text</span> + <span class='ivar'>@text</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -456,64 +419,7 @@ remove the cell reference. <div class="method_details first"> - <p class="signature first" id="range-instance_method"> - - - (<tt>String</tt>) <strong>range</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - <p> -returns the excel style abslute reference for the title when title is a -Cell object -</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"> - - -62 -63 -64 -65</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 62</span> - -<span class='def def kw'>def</span> <span class='range identifier id'>range</span> - <span class='return return kw'>return</span> <span class='string val'>""</span> <span class='unless unless_mod kw'>unless</span> <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> - <span class='dstring node'>"#{@data.row.worksheet.name}!#{data.row.r_abs}"</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"> + <p class="signature first" id="to_xml-instance_method"> - (<tt>String</tt>) <strong>to_xml</strong>(xml) @@ -521,9 +427,8 @@ Cell object </p><div class="docstring"> <div class="discussion"> - <p> -Serializes the chart title -</p> + +<p>Serializes the chart title</p> </div> @@ -542,9 +447,8 @@ Serializes the chart title — - <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> @@ -571,8 +475,6 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -42 -43 44 45 46 @@ -585,27 +487,28 @@ The document builder instance this objects xml will be added to. 53 54 55 -56</pre> +56 +57 +58</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 42</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'>'c:title'</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'>'c:tx'</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'>'c:strRef'</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'>'c:f'</span><span class='comma token'>,</span> <span class='range identifier id'>range</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'>'c:strCache'</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'>'c:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</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'>'c:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='integer val'>0</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'>'c:v'</span><span class='comma token'>,</span> <span class='@text ivar id'>@text</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace 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> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 44</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'>c:title</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'>c:tx</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'>c:strRef</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'>c:f</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id cell_range'>cell_range</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='ivar'>@cell</span><span class='rbracket'>]</span><span class='rparen'>)</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'>c:strCache</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'>c:ptCount</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='int'>1</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'>c:pt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:idx</span><span class='op'>=></span><span class='int'>0</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'>c:v</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='ivar'>@text</span><span class='rparen'>)</span> + <span class='rbrace'>}</span> + <span class='rbrace'>}</span> + <span class='rbrace'>}</span> + <span class='rbrace'>}</span> + <span class='rbrace'>}</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -616,9 +519,9 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 22:20:52 2011 by + Generated on Sat Nov 26 13:16:36 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.8.7). + 0.7.3 (ruby-1.9.3). </div> </body> |