From 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Thu, 1 Dec 2011 14:11:42 +0900 Subject: removing generated yard docs from repository --- doc/Axlsx/NumFmt.html | 548 -------------------------------------------------- 1 file changed, 548 deletions(-) delete mode 100644 doc/Axlsx/NumFmt.html (limited to 'doc/Axlsx/NumFmt.html') diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html deleted file mode 100644 index 968f5c9b..00000000 --- a/doc/Axlsx/NumFmt.html +++ /dev/null @@ -1,548 +0,0 @@ - - - - - - Class: Axlsx::NumFmt - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::NumFmt - - - -

- -
- -
Inherits:
-
- Object - -
    -
  • Object
    • - - - -
- show all - -
- - - - - - - - - -
Defined in:
-
lib/axlsx/stylesheet/num_fmt.rb
- -
-
- -

Overview

-
- -
- Note: -
-

The recommended way to manage styles is Styles#add_style

-
-
- - -

A NumFmt object defines an identifier and formatting code for data in -cells.

- - -
-
-
- - -
- -

Instance Attribute Summary (collapse)

- - - - - - -

- Instance Method Summary - (collapse) -

- - - - -
-

Constructor Details

- -
-

- - - (NumFmt) initialize(options = {}) - - - -

-
- -

A new instance of NumFmt

- - -
-
-
- - -
- - - - -
- 
-
-
-45
-46
-47
-48
-49
-50
-51
- 		- 
# File 'lib/axlsx/stylesheet/num_fmt.rb', line 45
-
-def initialize(options={})
-  @numFmtId = 0
-  @formatCode = ""
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-  end
-end
-
-
-
- -
- -
-

Instance Attribute Details

- - - - -
-

- - - (String) formatCode - - - -

-
- -

The formatting to use for this number format.

- - -
-
-
- -

Returns:

-
    - -
  • - - - (String) - - - - — -
    -

    The formatting to use for this number format.

    -
    - -
    • - -
- -

See Also:

- - -
- - - - -
- 
-
-
-44
-45
-46
- 		- 
# File 'lib/axlsx/stylesheet/num_fmt.rb', line 44
-
-def formatCode
-  @formatCode
-end
-
-
-
- - - - -
-

- - - (Integer) numFmtId - - - -

-
- -
- Note: -
-

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.

- -
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 @
-
-
-
- - -

An unsinged integer referencing a standard or custom number format.

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Integer) - - - - — -
    -

    An unsinged integer referencing a standard or custom number format.

    -
    - -
    • - -
- -

See Also:

- - -
- - - - -
- 
-
-
-40
-41
-42
- 		- 
# File 'lib/axlsx/stylesheet/num_fmt.rb', line 40
-
-def numFmtId
-  @numFmtId
-end
-
-
-
- -
- - -
-

Instance Method Details

- - -
-

- - - (Object) to_xml(xml) - - - -

-
- -

Creates a numFmt element applying the instance values of this object as -attributes.

- - -
-
-
-

Parameters:

-
    - -
  • - - xml - - - (Nokogiri::XML::Builder) - - - - — -
    -

    The document builder instance this objects xml will be added to.

    -
    - -
    • - -
- - -
- - - - -
- 
-
-
-60
- 		- 
# File 'lib/axlsx/stylesheet/num_fmt.rb', line 60
-
-def to_xml(xml) xml.numFmt(self.instance_values) end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3