diff options
| author | Randy Morgan <[email protected]> | 2011-11-27 21:45:19 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-27 21:45:19 +0900 |
| commit | cdfc7251bde8347678d355e5fe65fc20e120bc23 (patch) | |
| tree | d555a2b6a70b8e5b735aa7ef2248017cf7b1447e /doc/Axlsx/Marker.html | |
| parent | e6d269d03875bc0a4687b9d5f4b7016fc7d27b32 (diff) | |
| download | caxlsx-cdfc7251bde8347678d355e5fe65fc20e120bc23.tar.gz caxlsx-cdfc7251bde8347678d355e5fe65fc20e120bc23.zip | |
updating docs for 1.0.10a release
Diffstat (limited to 'doc/Axlsx/Marker.html')
| -rw-r--r-- | doc/Axlsx/Marker.html | 169 |
1 files changed, 98 insertions, 71 deletions
diff --git a/doc/Axlsx/Marker.html b/doc/Axlsx/Marker.html index 05bdfeeb..51bc972f 100644 --- a/doc/Axlsx/Marker.html +++ b/doc/Axlsx/Marker.html @@ -97,15 +97,17 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage markers is Worksheet#add_chart Markers are -created for a two cell anchor based on the :start and :end options.</p> + <div class='inline'><p> +The recommended way to manage markers is Worksheet#add_chart Markers are +created for a two cell anchor based on the :start and :end options. +</p> </div> </div> - -<p>The Marker class defines a point in the worksheet that drawing anchors -attach to.</p> +<p> +The Marker class defines a point in the worksheet that drawing anchors +attach to. +</p> </div> @@ -144,8 +146,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>The column this marker anchors to.</p> + <span class="summary_desc"><div class='inline'><p> +The column this marker anchors to. +</p> </div></span> </li> @@ -170,8 +173,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>The offset distance from this marker's column.</p> + <span class="summary_desc"><div class='inline'><p> +The offset distance from this marker’s column. +</p> </div></span> </li> @@ -196,8 +200,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>The row this marker anchors to.</p> + <span class="summary_desc"><div class='inline'><p> +The row this marker anchors to. +</p> </div></span> </li> @@ -222,8 +227,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>The offset distance from this marker's row.</p> + <span class="summary_desc"><div class='inline'><p> +The offset distance from this marker’s row. +</p> </div></span> </li> @@ -258,8 +264,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>shortcut to set the column, row position for this marker.</p> + <span class="summary_desc"><div class='inline'><p> +shortcut to set the column, row position for this marker. +</p> </div></span> </li> @@ -283,8 +290,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Marker object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Marker object. +</p> </div></span> </li> @@ -306,8 +314,9 @@ attach to.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the marker.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the marker. +</p> </div></span> </li> @@ -328,8 +337,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Marker object</p> + <p> +Creates a new Marker object +</p> </div> @@ -350,8 +360,9 @@ attach to.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -420,12 +431,13 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 28</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</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'>@col</span><span class='comma'>,</span> <span class='ivar'>@colOff</span><span class='comma'>,</span> <span class='ivar'>@row</span><span class='comma'>,</span> <span class='ivar'>@rowOff</span> <span class='op'>=</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</span><span class='comma'>,</span> <span class='int'>0</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='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> - <span class='kw'>end</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='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='@col ivar id'>@col</span><span class='comma token'>,</span> <span class='@colOff ivar id'>@colOff</span><span class='comma token'>,</span> <span class='@row ivar id'>@row</span><span class='comma token'>,</span> <span class='@rowOff ivar id'>@rowOff</span> <span class='assign token'>=</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -448,8 +460,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The column this marker anchors to</p> + <p> +The column this marker anchors to +</p> </div> @@ -483,9 +496,10 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 9</span> -<span class='kw'>def</span> <span class='id col'>col</span> - <span class='ivar'>@col</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='col identifier id'>col</span> + <span class='@col ivar id'>@col</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -503,8 +517,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The offset distance from this marker's column</p> + <p> +The offset distance from this marker’s column +</p> </div> @@ -538,9 +553,10 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 13</span> -<span class='kw'>def</span> <span class='id colOff'>colOff</span> - <span class='ivar'>@colOff</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='colOff identifier id'>colOff</span> + <span class='@colOff ivar id'>@colOff</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -558,8 +574,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The row this marker anchors to</p> + <p> +The row this marker anchors to +</p> </div> @@ -593,9 +610,10 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 17</span> -<span class='kw'>def</span> <span class='id row'>row</span> - <span class='ivar'>@row</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='row identifier id'>row</span> + <span class='@row ivar id'>@row</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -613,8 +631,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The offset distance from this marker's row</p> + <p> +The offset distance from this marker’s row +</p> </div> @@ -648,9 +667,10 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 21</span> -<span class='kw'>def</span> <span class='id rowOff'>rowOff</span> - <span class='ivar'>@rowOff</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='rowOff identifier id'>rowOff</span> + <span class='@rowOff ivar id'>@rowOff</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -672,8 +692,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>shortcut to set the column, row position for this marker</p> + <p> +shortcut to set the column, row position for this marker +</p> </div> @@ -692,8 +713,9 @@ attach to.</p> — - <div class='inline'> -<p>the column for the marker</p> + <div class='inline'><p> +the column for the marker +</p> </div> </li> @@ -708,8 +730,9 @@ attach to.</p> — - <div class='inline'> -<p>the row of the marker</p> + <div class='inline'><p> +the row of the marker +</p> </div> </li> @@ -731,10 +754,11 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 47</span> -<span class='kw'>def</span> <span class='id coord'>coord</span><span class='lparen'>(</span><span class='id col'>col</span><span class='comma'>,</span> <span class='id row'>row</span><span class='rparen'>)</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id col'>col</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id row'>row</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='coord identifier id'>coord</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='row identifier id'>row</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='row identifier id'>row</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -749,8 +773,9 @@ attach to.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the marker</p> + <p> +Serializes the marker +</p> </div> @@ -769,8 +794,9 @@ attach to.</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> @@ -806,11 +832,12 @@ attach to.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 54</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='lbracket'>[</span><span class='symbol'>:col</span><span class='comma'>,</span> <span class='symbol'>:colOff</span><span class='comma'>,</span> <span class='symbol'>:row</span><span class='comma'>,</span> <span class='symbol'>:rowOff</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id k'>k</span><span class='op'>|</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:</span><span class='embexpr_beg'>#{</span><span class='id k'>k</span><span class='period'>.</span><span class='id to_s'>to_s</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='id k'>k</span><span class='rparen'>)</span><span class='rparen'>)</span> - <span class='kw'>end</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='lbrack token'>[</span><span class='symbol val'>:col</span><span class='comma token'>,</span> <span class='symbol val'>:colOff</span><span class='comma token'>,</span> <span class='symbol val'>:row</span><span class='comma token'>,</span> <span class='symbol val'>:rowOff</span><span class='rbrack token'>]</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='k identifier id'>k</span><span class='bitor op'>|</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='dstring node'>"xdr:#{k.to_s}"</span><span class='comma token'>,</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='k identifier id'>k</span><span class='rparen token'>)</span><span class='rparen token'>)</span> + <span class='end end kw'>end</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -821,9 +848,9 @@ attach to.</p> </div> <div id="footer"> - Generated on Sun Nov 27 20:28:13 2011 by + Generated on Sun Nov 27 21:44:26 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> |
