diff options
Diffstat (limited to 'doc/Axlsx/NumFmt.html')
| -rw-r--r-- | doc/Axlsx/NumFmt.html | 179 |
1 files changed, 99 insertions, 80 deletions
diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html index b308d6dc..51a18033 100644 --- a/doc/Axlsx/NumFmt.html +++ b/doc/Axlsx/NumFmt.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is Styles#add_style</p> + <div class='inline'><p> +The recommended way to manage styles is Styles#add_style +</p> </div> </div> - -<p>A NumFmt object defines an identifier and formatting code for data in -cells.</p> +<p> +A NumFmt object defines an identifier and formatting code for data in +cells. +</p> </div> @@ -136,8 +138,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>The formatting to use for this number format.</p> + <span class="summary_desc"><div class='inline'><p> +The formatting to use for this number format. +</p> </div></span> </li> @@ -162,8 +165,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>An unsinged integer referencing a standard or custom number format.</p> + <span class="summary_desc"><div class='inline'><p> +An unsinged integer referencing a standard or custom number format. +</p> </div></span> </li> @@ -200,8 +204,9 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>A new instance of NumFmt.</p> + <span class="summary_desc"><div class='inline'><p> +A new instance of NumFmt. +</p> </div></span> </li> @@ -223,9 +228,10 @@ cells.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a numFmt element applying the instance values of this object as -attributes.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a numFmt element applying the instance values of this object as +attributes. +</p> </div></span> </li> @@ -246,8 +252,9 @@ attributes.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A new instance of NumFmt</p> + <p> +A new instance of NumFmt +</p> </div> @@ -272,13 +279,14 @@ attributes.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 45</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'>@numFmtId</span> <span class='op'>=</span> <span class='int'>0</span> - <span class='ivar'>@formatCode</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></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='@numFmtId ivar id'>@numFmtId</span> <span class='assign token'>=</span> <span class='integer val'>0</span> + <span class='@formatCode ivar id'>@formatCode</span> <span class='assign token'>=</span> <span class='string val'>""</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> @@ -301,8 +309,9 @@ attributes.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The formatting to use for this number format.</p> + <p> +The formatting to use for this number format. +</p> </div> @@ -320,8 +329,9 @@ attributes.</p> — - <div class='inline'> -<p>The formatting to use for this number format.</p> + <div class='inline'><p> +The formatting to use for this number format. +</p> </div> </li> @@ -348,9 +358,10 @@ attributes.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 44</span> -<span class='kw'>def</span> <span class='id formatCode'>formatCode</span> - <span class='ivar'>@formatCode</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='formatCode identifier id'>formatCode</span> + <span class='@formatCode ivar id'>@formatCode</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -371,48 +382,51 @@ attributes.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>These are the known formats I can dig up. The constant NUM_FMT_PERCENT is + <div class='inline'><p> +These are the known formats I can dig up. The constant NUM_FMT_PERCENT is 9, and uses the default % formatting. Axlsx also defines a few formats for date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and -NUM_FRM_YYYYMMDDHHMMSS.</p> - -<pre class="code">1 0 -2 0.00 -3 #,##0 -4 #,##0.00 -5 $#,##0_);($#,##0) -6 $#,##0_);[Red]($#,##0) -7 $#,##0.00_);($#,##0.00) -8 $#,##0.00_);[Red]($#,##0.00) -9 0% -10 0.00% -11 0.00E+00 -12 # ?/? -13 # ??/?? -14 m/d/yyyy -15 d-mmm-yy -16 d-mmm -17 mmm-yy -18 h:mm AM/PM -19 h:mm:ss AM/PM -20 h:mm -21 h:mm:ss -22 m/d/yyyy h:mm -37 #,##0_);(#,##0) -38 #,##0_);[Red](#,##0) -39 #,##0.00_);(#,##0.00) -40 #,##0.00_);[Red](#,##0.00) -45 mm:ss -46 [h]:mm:ss -47 mm:ss.0 -48 ##0.0E+0 -49 @</pre> +NUM_FRM_YYYYMMDDHHMMSS. +</p> +<pre class="code"> + <span class='integer val'>1</span> <span class='integer val'>0</span> + <span class='integer val'>2</span> <span class='integer val'>0</span><span class='integer val'>.00</span> + <span class='integer val'>3</span> <span class='comment val'>#,##0</span> + <span class='integer val'>4</span> <span class='comment val'>#,##0.00</span> + <span class='integer val'>5</span> $<span class='comment val'>#,##0_);($#,##0)</span> + <span class='integer val'>6</span> $<span class='comment val'>#,##0_);[Red]($#,##0)</span> + <span class='integer val'>7</span> $<span class='comment val'>#,##0.00_);($#,##0.00)</span> + <span class='integer val'>8</span> $<span class='comment val'>#,##0.00_);[Red]($#,##0.00)</span> + <span class='integer val'>9</span> <span class='integer val'>0</span><span class='mod op'>%</span> + <span class='integer val'>10</span> <span class='integer val'>0</span><span class='integer val'>.00</span><span class='mod op'>%</span> + <span class='integer val'>11</span> <span class='integer val'>0</span><span class='float val'>.00E+00</span> + <span class='integer val'>12</span> <span class='comment val'># ?/?</span> + <span class='integer val'>13</span> <span class='comment val'># ??/??</span> + <span class='integer val'>14</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yyyy identifier id'>yyyy</span> + <span class='integer val'>15</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>16</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span> + <span class='integer val'>17</span> <span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> + <span class='integer val'>18</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>19</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> + <span class='integer val'>20</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>21</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>22</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yyyy identifier id'>yyyy</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> + <span class='integer val'>37</span> <span class='comment val'>#,##0_);(#,##0)</span> + <span class='integer val'>38</span> <span class='comment val'>#,##0_);[Red](#,##0)</span> + <span class='integer val'>39</span> <span class='comment val'>#,##0.00_);(#,##0.00)</span> + <span class='integer val'>40</span> <span class='comment val'>#,##0.00_);[Red](#,##0.00)</span> + <span class='integer val'>45</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>46</span> <span class='lbrack token'>[</span><span class='h identifier id'>h</span><span class='rbrack token'>]</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> + <span class='integer val'>47</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span><span class='integer val'>.0</span> + <span class='integer val'>48</span> <span class='comment val'>##0.0E+0</span> + <span class='integer val'>49</span> @ +</pre> </div> </div> - -<p>An unsinged integer referencing a standard or custom number format.</p> +<p> +An unsinged integer referencing a standard or custom number format. +</p> </div> @@ -430,8 +444,9 @@ NUM_FRM_YYYYMMDDHHMMSS.</p> — - <div class='inline'> -<p>An unsinged integer referencing a standard or custom number format.</p> + <div class='inline'><p> +An unsinged integer referencing a standard or custom number format. +</p> </div> </li> @@ -458,9 +473,10 @@ NUM_FRM_YYYYMMDDHHMMSS.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 40</span> -<span class='kw'>def</span> <span class='id numFmtId'>numFmtId</span> - <span class='ivar'>@numFmtId</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='numFmtId identifier id'>numFmtId</span> + <span class='@numFmtId ivar id'>@numFmtId</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -482,9 +498,10 @@ NUM_FRM_YYYYMMDDHHMMSS.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a numFmt element applying the instance values of this object as -attributes.</p> + <p> +Creates a numFmt element applying the instance values of this object as +attributes. +</p> </div> @@ -503,8 +520,9 @@ attributes.</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> @@ -523,7 +541,8 @@ attributes.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 60</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 numFmt'>numFmt</span><span class='lparen'>(</span><span class='kw'>self</span><span class='period'>.</span><span class='id instance_values'>instance_values</span><span class='rparen'>)</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='numFmt identifier id'>numFmt</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -534,9 +553,9 @@ attributes.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:19 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> |