Class: Axlsx::Xf

Inherits:

Object

• Object
• Axlsx::Xf

show all

Defined in:

lib/axlsx/stylesheet/xf.rb

Overview

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.

84
85
86
87
88

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

def initialize(options={})
  options.each do |o|
    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
  end
end

9
10
11

# File 'lib/axlsx/stylesheet/xf.rb', line 9

def alignment
  @alignment
end

62
63
64

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

def applyAlignment
  @applyAlignment
end

58
59
60

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

def applyBorder
  @applyBorder
end

54
55
56

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

def applyFill
  @applyFill
end

50
51
52

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

def applyFont
  @applyFont
end

46
47
48

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

def applyNumberFormat
  @applyNumberFormat
end

66
67
68

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

def applyProtection
  @applyProtection
end

30
31
32

# File 'lib/axlsx/stylesheet/xf.rb', line 30

def borderId
  @borderId
end

26
27
28

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

def fillId
  @fillId
end

22
23
24

# File 'lib/axlsx/stylesheet/xf.rb', line 22

def fontId
  @fontId
end

18
19
20

# File 'lib/axlsx/stylesheet/xf.rb', line 18

def numFmtId
  @numFmtId
end

42
43
44

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

def pivotButton
  @pivotButton
end

14
15
16

# File 'lib/axlsx/stylesheet/xf.rb', line 14

def protection
  @protection
end

38
39
40

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

def quotePrefix
  @quotePrefix
end

34
35
36

# File 'lib/axlsx/stylesheet/xf.rb', line 34

def xfId
  @xfId
end

110
111
112
113
114
115

# File 'lib/axlsx/stylesheet/xf.rb', line 110

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