class Axlsx::NumFmt

A NumFmt object defines an identifier and formatting code for data in cells. @note The recommended way to manage styles is Styles#add_style

Attributes

formatCode[R]

@return [String] The formatting to use for this number format. @see support.microsoft.com/kb/264372

numFmtId[R]

@return [Integer] An unsigned integer referencing a standard or custom number format. @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 @

@see Axlsx

Public Class Methods

new(options={}) click to toggle source

Creates a new NumFmt object @param [Hash] options Options for the number format object @option [Integer] numFmtId The predefined format id or new format id for this format @option [String] formatCode The format code for this number format

# File lib/axlsx/stylesheet/num_fmt.rb, line 14
def initialize(options={})
  @numFmtId = 0
  @formatCode = ""
  parse_options options
end

Public Instance Methods

formatCode=(v) click to toggle source

@see formatCode

# File lib/axlsx/stylesheet/num_fmt.rb, line 67
def formatCode=(v) Axlsx::validate_string v; @formatCode = v end
numFmtId=(v) click to toggle source

@see numFmtId

# File lib/axlsx/stylesheet/num_fmt.rb, line 64
def numFmtId=(v) Axlsx::validate_unsigned_int v; @numFmtId = v end
to_xml_string(str = '') click to toggle source

Serializes the object @param [String] str @return [String]

# File lib/axlsx/stylesheet/num_fmt.rb, line 72
def to_xml_string(str = '')
  serialized_tag('numFmt', str)
end