diff options
Diffstat (limited to 'doc/Axlsx/Axis.html')
| -rw-r--r-- | doc/Axlsx/Axis.html | 229 |
1 files changed, 98 insertions, 131 deletions
diff --git a/doc/Axlsx/Axis.html b/doc/Axlsx/Axis.html index 5588a0b4..460bcb51 100644 --- a/doc/Axlsx/Axis.html +++ b/doc/Axlsx/Axis.html @@ -94,9 +94,8 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - <p> -the access class defines common properties and values for a chart axis. -</p> + +<p>the access class defines common properties and values for a chart axis.</p> </div> @@ -132,9 +131,8 @@ the access class defines common properties and values for a chart axis. - <span class="summary_desc"><div class='inline'><p> -the id of the axis. -</p> + <span class="summary_desc"><div class='inline'> +<p>the id of the axis.</p> </div></span> </li> @@ -159,9 +157,8 @@ the id of the axis. - <span class="summary_desc"><div class='inline'><p> -The position of the axis must be one of [:l, :r, :t, :b]. -</p> + <span class="summary_desc"><div class='inline'> +<p>The position of the axis must be one of [:l, :r, :t, :b].</p> </div></span> </li> @@ -186,9 +183,8 @@ The position of the axis must be one of [:l, :r, :t, :b]. - <span class="summary_desc"><div class='inline'><p> -The perpendicular axis. -</p> + <span class="summary_desc"><div class='inline'> +<p>The perpendicular axis.</p> </div></span> </li> @@ -213,10 +209,9 @@ The perpendicular axis. - <span class="summary_desc"><div class='inline'><p> -specifies how the perpendicular axis is crossed must be one of [:autoZero, -:min, :max]. -</p> + <span class="summary_desc"><div class='inline'> +<p>specifies how the perpendicular axis is crossed must be one of [:autoZero, +:min, :max].</p> </div></span> </li> @@ -241,9 +236,8 @@ specifies how the perpendicular axis is crossed must be one of [:autoZero, - <span class="summary_desc"><div class='inline'><p> -The number format format code for this axis default :General. -</p> + <span class="summary_desc"><div class='inline'> +<p>The number format format code for this axis default :General.</p> </div></span> </li> @@ -268,9 +262,8 @@ The number format format code for this axis default :General. - <span class="summary_desc"><div class='inline'><p> -The scaling of the axis. -</p> + <span class="summary_desc"><div class='inline'> +<p>The scaling of the axis.</p> </div></span> </li> @@ -295,9 +288,8 @@ The scaling of the axis. - <span class="summary_desc"><div class='inline'><p> -the position of the tick labels must be one of [:nextTo, :high, :low]. -</p> + <span class="summary_desc"><div class='inline'> +<p>the position of the tick labels must be one of [:nextTo, :high, :low].</p> </div></span> </li> @@ -334,9 +326,8 @@ the position of the tick labels must be one of [:nextTo, :high, :low]. - <span class="summary_desc"><div class='inline'><p> -Creates an Axis object. -</p> + <span class="summary_desc"><div class='inline'> +<p>Creates an Axis object.</p> </div></span> </li> @@ -358,9 +349,8 @@ Creates an Axis object. - <span class="summary_desc"><div class='inline'><p> -Serializes the common axis. -</p> + <span class="summary_desc"><div class='inline'> +<p>Serializes the common axis.</p> </div></span> </li> @@ -381,9 +371,8 @@ Serializes the common axis. </p><div class="docstring"> <div class="discussion"> - <p> -Creates an Axis object -</p> + +<p>Creates an Axis object</p> </div> @@ -402,9 +391,8 @@ Creates an Axis object — - <div class='inline'><p> -the id of this axis -</p> + <div class='inline'> +<p>the id of this axis</p> </div> </li> @@ -419,9 +407,8 @@ the id of this axis — - <div class='inline'><p> -the id of the perpendicular axis -</p> + <div class='inline'> +<p>the id of the perpendicular axis</p> </div> </li> @@ -438,9 +425,8 @@ the id of the perpendicular axis — - <div class='inline'><p> -a customizable set of options -</p> + <div class='inline'> +<p>a customizable set of options</p> </div> </li> @@ -498,9 +484,8 @@ a customizable set of options — - <div class='inline'><p> -If axId or crossAx are not unsigned integers -</p> + <div class='inline'> +<p>If axId or crossAx are not unsigned integers</p> </div> </li> @@ -532,22 +517,21 @@ If axId or crossAx are not unsigned integers <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 45</span> -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</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='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='rparen token'>)</span> - <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='crossAx identifier id'>crossAx</span><span class='rparen token'>)</span> - <span class='@axId ivar id'>@axId</span> <span class='assign token'>=</span> <span class='axId identifier id'>axId</span> - <span class='@crossAx ivar id'>@crossAx</span> <span class='assign token'>=</span> <span class='crossAx identifier id'>crossAx</span> - <span class='@format_code ivar id'>@format_code</span> <span class='assign token'>=</span> <span class='string val'>"General"</span> - <span class='@scaling ivar id'>@scaling</span> <span class='assign token'>=</span> <span class='Scaling constant id'>Scaling</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:orientation=</span><span class='gt op'>></span><span class='symbol val'>:minMax</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='axPos identifier id'>axPos</span> <span class='assign token'>=</span> <span class='symbol val'>:l</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='tickLblPos identifier id'>tickLblPos</span> <span class='assign token'>=</span> <span class='symbol val'>:nextTo</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='format_code identifier id'>format_code</span> <span class='assign token'>=</span> <span class='string val'>"General"</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='crosses identifier id'>crosses</span> <span class='assign token'>=</span> <span class='symbol val'>:autoZero</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='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='comma'>,</span> <span class='id crossAx'>crossAx</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='const'>Axlsx</span><span class='op'>::</span><span class='id validate_unsigned_int'>validate_unsigned_int</span><span class='lparen'>(</span><span class='id axId'>axId</span><span class='rparen'>)</span> + <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_unsigned_int'>validate_unsigned_int</span><span class='lparen'>(</span><span class='id crossAx'>crossAx</span><span class='rparen'>)</span> + <span class='ivar'>@axId</span> <span class='op'>=</span> <span class='id axId'>axId</span> + <span class='ivar'>@crossAx</span> <span class='op'>=</span> <span class='id crossAx'>crossAx</span> + <span class='ivar'>@format_code</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>General</span><span class='tstring_end'>"</span></span> + <span class='ivar'>@scaling</span> <span class='op'>=</span> <span class='const'>Scaling</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:orientation</span><span class='op'>=></span><span class='symbol'>:minMax</span><span class='rparen'>)</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id axPos'>axPos</span> <span class='op'>=</span> <span class='symbol'>:l</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id tickLblPos'>tickLblPos</span> <span class='op'>=</span> <span class='symbol'>:nextTo</span> + <span class='kw'>self</span><span class='period'>.</span><span class='id format_code'>format_code</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>General</span><span class='tstring_end'>"</span></span> + <span class='kw'>self</span><span class='period'>.</span><span class='id crosses'>crosses</span> <span class='op'>=</span> <span class='symbol'>:autoZero</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='kw'>end</span></pre> </td> </tr> </table> @@ -570,9 +554,8 @@ If axId or crossAx are not unsigned integers </p><div class="docstring"> <div class="discussion"> - <p> -the id of the axis. -</p> + +<p>the id of the axis.</p> </div> @@ -606,10 +589,9 @@ the id of the axis. <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 7</span> -<span class='def def kw'>def</span> <span class='axId identifier id'>axId</span> - <span class='@axId ivar id'>@axId</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id axId'>axId</span> + <span class='ivar'>@axId</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -627,9 +609,8 @@ the id of the axis. </p><div class="docstring"> <div class="discussion"> - <p> -The position of the axis must be one of [:l, :r, :t, :b] -</p> + +<p>The position of the axis must be one of [:l, :r, :t, :b]</p> </div> @@ -663,10 +644,9 @@ The position of the axis must be one of [:l, :r, :t, :b] <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 21</span> -<span class='def def kw'>def</span> <span class='axPos identifier id'>axPos</span> - <span class='@axPos ivar id'>@axPos</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id axPos'>axPos</span> + <span class='ivar'>@axPos</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -684,9 +664,8 @@ The position of the axis must be one of [:l, :r, :t, :b] </p><div class="docstring"> <div class="discussion"> - <p> -The perpendicular axis -</p> + +<p>The perpendicular axis</p> </div> @@ -720,10 +699,9 @@ The perpendicular axis <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 11</span> -<span class='def def kw'>def</span> <span class='crossAx identifier id'>crossAx</span> - <span class='@crossAx ivar id'>@crossAx</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id crossAx'>crossAx</span> + <span class='ivar'>@crossAx</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -741,10 +719,9 @@ The perpendicular axis </p><div class="docstring"> <div class="discussion"> - <p> -specifies how the perpendicular axis is crossed must be one of [:autoZero, -:min, :max] -</p> + +<p>specifies how the perpendicular axis is crossed must be one of [:autoZero, +:min, :max]</p> </div> @@ -778,10 +755,9 @@ specifies how the perpendicular axis is crossed must be one of [:autoZero, <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 36</span> -<span class='def def kw'>def</span> <span class='crosses identifier id'>crosses</span> - <span class='@crosses ivar id'>@crosses</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id crosses'>crosses</span> + <span class='ivar'>@crosses</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -799,9 +775,8 @@ specifies how the perpendicular axis is crossed must be one of [:autoZero, </p><div class="docstring"> <div class="discussion"> - <p> -The number format format code for this axis default :General -</p> + +<p>The number format format code for this axis default :General</p> </div> @@ -835,10 +810,9 @@ The number format format code for this axis default :General <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 31</span> -<span class='def def kw'>def</span> <span class='format_code identifier id'>format_code</span> - <span class='@format_code ivar id'>@format_code</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id format_code'>format_code</span> + <span class='ivar'>@format_code</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -856,9 +830,8 @@ The number format format code for this axis default :General </p><div class="docstring"> <div class="discussion"> - <p> -The scaling of the axis -</p> + +<p>The scaling of the axis</p> </div> @@ -899,10 +872,9 @@ The scaling of the axis <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 16</span> -<span class='def def kw'>def</span> <span class='scaling identifier id'>scaling</span> - <span class='@scaling ivar id'>@scaling</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id scaling'>scaling</span> + <span class='ivar'>@scaling</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -920,9 +892,8 @@ The scaling of the axis </p><div class="docstring"> <div class="discussion"> - <p> -the position of the tick labels must be one of [:nextTo, :high, :low] -</p> + +<p>the position of the tick labels must be one of [:nextTo, :high, :low]</p> </div> @@ -956,10 +927,9 @@ the position of the tick labels must be one of [:nextTo, :high, :low] <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 26</span> -<span class='def def kw'>def</span> <span class='tickLblPos identifier id'>tickLblPos</span> - <span class='@tickLblPos ivar id'>@tickLblPos</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id tickLblPos'>tickLblPos</span> + <span class='ivar'>@tickLblPos</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -981,9 +951,8 @@ the position of the tick labels must be one of [:nextTo, :high, :low] </p><div class="docstring"> <div class="discussion"> - <p> -Serializes the common axis -</p> + +<p>Serializes the common axis</p> </div> @@ -1002,9 +971,8 @@ Serializes the common axis — - <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> @@ -1045,17 +1013,16 @@ The document builder instance this objects xml will be added to. <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 79</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axId ivar id'>@axId</span><span class='rparen token'>)</span> - <span class='@scaling ivar id'>@scaling</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:axPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axPos ivar id'>@axPos</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:majorGridlines'</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:numFmt'</span><span class='comma token'>,</span> <span class='symbol val'>:formatCode</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@format_code ivar id'>@format_code</span><span class='comma token'>,</span> <span class='symbol val'>:sourceLinked=</span><span class='gt op'>></span><span class='string 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:tickLblPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickLblPos ivar id'>@tickLblPos</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:crossAx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crossAx ivar id'>@crossAx</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:crosses'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crosses ivar id'>@crosses</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> +<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:axId</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@axId</span><span class='rparen'>)</span> + <span class='ivar'>@scaling</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> + <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:axPos</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@axPos</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:majorGridlines</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'>c:numFmt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:formatCode</span> <span class='op'>=></span> <span class='ivar'>@format_code</span><span class='comma'>,</span> <span class='symbol'>:sourceLinked</span><span class='op'>=></span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>1</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'>c:tickLblPos</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@tickLblPos</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:crossAx</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@crossAx</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:crosses</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='ivar'>@crosses</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -1066,9 +1033,9 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:52:34 2011 by + Generated on Sun Nov 27 22:08:37 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> |