Class: Axlsx::Xf
- Inherits:
-
Object
- Object
- Axlsx::Xf
- 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
Instance Attribute Summary (collapse)
-
- (CellAlignment) alignment
The cell alignment for this style.
-
- (Boolean) applyAlignment
Indicates if the alignment options should be applied.
-
- (Boolean) applyBorder
indicates if the borderId should be applied.
-
- (Boolean) applyFill
indicates if the fillId should be applied.
-
- (Boolean) applyFont
indicates if the fontId should be applied.
-
- (Boolean) applyNumberFormat
indicates if the numFmtId should be applied.
-
- (Boolean) applyProtection
Indicates if the protection options should be applied.
-
- (Integer) borderId
index (0 based) of the border to be used in this style.
-
- (Integer) fillId
index (0 based) of the fill to be used in this style.
-
- (Integer) fontId
index (0 based) of the font to be used in this style.
-
- (Integer) numFmtId
id of the numFmt to apply to this style.
-
- (Boolean) pivotButton
indicates if the cell has a pivot table drop down button.
-
- (CellProtection) protection
The cell protection for this style.
-
- (Boolean) quotePrefix
indecates if text should be prefixed by a single quote in the cell.
-
- (Integer) xfId
index (0 based) of cellStylesXfs item to be used in this style.
Instance Method Summary (collapse)
-
- (Xf) initialize(options = {})
constructor
Creates a new Xf object.
-
- (String) to_xml(xml)
Serializes the xf elemen.
Constructor Details
- (Xf) initialize(options = {})
Creates a new Xf object
85 86 87 88 89 |
# File 'lib/axlsx/stylesheet/xf.rb', line 85 def initialize(={}) .each do |o| self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}=" end end |
Instance Attribute Details
- (CellAlignment) alignment
The cell alignment for this style
10 11 12 |
# File 'lib/axlsx/stylesheet/xf.rb', line 10 def alignment @alignment end |
- (Boolean) applyAlignment
Indicates if the alignment options should be applied
63 64 65 |
# File 'lib/axlsx/stylesheet/xf.rb', line 63 def applyAlignment @applyAlignment end |
- (Boolean) applyBorder
indicates if the borderId should be applied
59 60 61 |
# File 'lib/axlsx/stylesheet/xf.rb', line 59 def applyBorder @applyBorder end |
- (Boolean) applyFill
indicates if the fillId should be applied
55 56 57 |
# File 'lib/axlsx/stylesheet/xf.rb', line 55 def applyFill @applyFill end |
- (Boolean) applyFont
indicates if the fontId should be applied
51 52 53 |
# File 'lib/axlsx/stylesheet/xf.rb', line 51 def applyFont @applyFont end |
- (Boolean) applyNumberFormat
indicates if the numFmtId should be applied
47 48 49 |
# File 'lib/axlsx/stylesheet/xf.rb', line 47 def applyNumberFormat @applyNumberFormat end |
- (Boolean) applyProtection
Indicates if the protection options should be applied
67 68 69 |
# File 'lib/axlsx/stylesheet/xf.rb', line 67 def applyProtection @applyProtection end |
- (Integer) borderId
index (0 based) of the border to be used in this style
31 32 33 |
# File 'lib/axlsx/stylesheet/xf.rb', line 31 def borderId @borderId end |
- (Integer) fillId
index (0 based) of the fill to be used in this style
27 28 29 |
# File 'lib/axlsx/stylesheet/xf.rb', line 27 def fillId @fillId end |
- (Integer) fontId
index (0 based) of the font to be used in this style
23 24 25 |
# File 'lib/axlsx/stylesheet/xf.rb', line 23 def fontId @fontId end |
- (Integer) numFmtId
id of the numFmt to apply to this style
19 20 21 |
# File 'lib/axlsx/stylesheet/xf.rb', line 19 def numFmtId @numFmtId end |
- (Boolean) pivotButton
indicates if the cell has a pivot table drop down button
43 44 45 |
# File 'lib/axlsx/stylesheet/xf.rb', line 43 def pivotButton @pivotButton end |
- (CellProtection) protection
The cell protection for this style
15 16 17 |
# File 'lib/axlsx/stylesheet/xf.rb', line 15 def protection @protection end |
- (Boolean) quotePrefix
indecates if text should be prefixed by a single quote in the cell
39 40 41 |
# File 'lib/axlsx/stylesheet/xf.rb', line 39 def quotePrefix @quotePrefix end |
- (Integer) xfId
index (0 based) of cellStylesXfs item to be used in this style. Only applies to cellXfs items
35 36 37 |
# File 'lib/axlsx/stylesheet/xf.rb', line 35 def xfId @xfId end |
Instance Method Details
- (String) to_xml(xml)
Serializes the xf elemen
131 132 133 134 135 136 |
# File 'lib/axlsx/stylesheet/xf.rb', line 131 def to_xml(xml) xml.xf(self.instance_values.reject { |k, v| [:alignment, :protection, :extList, :name].include? k.to_sym}) { alignment.to_xml(xml) if self.alignment protection.to_xml(xml) if self.protection } end |