Class: Axlsx::Xf

Inherits:
Object
  • Object
show all
Includes:
OptionsParser, SerializedAttributes
Defined in:
lib/axlsx/stylesheet/xf.rb

Overview

The Xf class defines a formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from OptionsParser

#parse_options

Methods included from SerializedAttributes

included, #serialized_attributes, #serialized_element_attributes

Constructor Details

#initialize(options = {}) ⇒ Xf

Creates a new Xf object

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • numFmtId (Integer)
  • fontId (Integer)
  • fillId (Integer)
  • borderId (Integer)
  • xfId (Integer)
  • quotePrefix (Boolean)
  • pivotButton (Boolean)
  • applyNumberFormat (Boolean)
  • applyFont (Boolean)
  • applyFill (Boolean)
  • applyBorder (Boolean)
  • applyAlignment (Boolean)
  • applyProtection (Boolean)
  • alignment (CellAlignment)
  • protection (CellProtection) 


26
27
28
 
# File 'lib/axlsx/stylesheet/xf.rb', line 26

def initialize(options={})
  parse_options options
end

Instance Attribute Details

#alignment ⇒ CellAlignment

The cell alignment for this style

Returns:

See Also:



37
38
39
 
# File 'lib/axlsx/stylesheet/xf.rb', line 37

def alignment
  @alignment
end

#applyAlignment ⇒ Boolean

Indicates if the alignment options should be applied

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/axlsx/stylesheet/xf.rb', line 90

def applyAlignment
  @applyAlignment
end

#applyBorder ⇒ Boolean

indicates if the borderId should be applied

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/axlsx/stylesheet/xf.rb', line 86

def applyBorder
  @applyBorder
end

#applyFill ⇒ Boolean

indicates if the fillId should be applied

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/axlsx/stylesheet/xf.rb', line 82

def applyFill
  @applyFill
end

#applyFont ⇒ Boolean

indicates if the fontId should be applied

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/axlsx/stylesheet/xf.rb', line 78

def applyFont
  @applyFont
end

#applyNumberFormat ⇒ Boolean

indicates if the numFmtId should be applied

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/axlsx/stylesheet/xf.rb', line 74

def applyNumberFormat
  @applyNumberFormat
end

#applyProtection ⇒ Boolean

Indicates if the protection options should be applied

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/axlsx/stylesheet/xf.rb', line 94

def applyProtection
  @applyProtection
end

#borderId ⇒ Integer

index (0 based) of the border to be used in this style

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/axlsx/stylesheet/xf.rb', line 58

def borderId
  @borderId
end

#fillId ⇒ Integer

index (0 based) of the fill to be used in this style

Returns:

  • (Integer) 


54
55
56
 
# File 'lib/axlsx/stylesheet/xf.rb', line 54

def fillId
  @fillId
end

#fontId ⇒ Integer

index (0 based) of the font to be used in this style

Returns:

  • (Integer) 


50
51
52
 
# File 'lib/axlsx/stylesheet/xf.rb', line 50

def fontId
  @fontId
end

#numFmtId ⇒ Integer

id of the numFmt to apply to this style

Returns:

  • (Integer) 


46
47
48
 
# File 'lib/axlsx/stylesheet/xf.rb', line 46

def numFmtId
  @numFmtId
end

#pivotButton ⇒ Boolean

indicates if the cell has a pivot table drop down button

Returns:

  • (Boolean) 


70
71
72
 
# File 'lib/axlsx/stylesheet/xf.rb', line 70

def pivotButton
  @pivotButton
end

#protection ⇒ CellProtection

The cell protection for this style

Returns:

See Also:



42
43
44
 
# File 'lib/axlsx/stylesheet/xf.rb', line 42

def protection
  @protection
end

#quotePrefix ⇒ Boolean

indecates if text should be prefixed by a single quote in the cell

Returns:

  • (Boolean) 


66
67
68
 
# File 'lib/axlsx/stylesheet/xf.rb', line 66

def quotePrefix
  @quotePrefix
end

#xfId ⇒ Integer

index (0 based) of cellStylesXfs item to be used in this style. Only applies to cellXfs items

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/axlsx/stylesheet/xf.rb', line 62

def xfId
  @xfId
end

Instance Method Details

#to_xml_string(str = '') ⇒ String

Serializes the object

Parameters:

  • str (String) (defaults to: '')

Returns:

  • (String) 


136
137
138
139
140
141
142
143
 
# File 'lib/axlsx/stylesheet/xf.rb', line 136

def to_xml_string(str = '')
  str << '<xf '
  serialized_attributes str
  str << '>'
  alignment.to_xml_string(str) if self.alignment
  protection.to_xml_string(str) if self.protection
  str << '</xf>'
end