Class: Axlsx::PatternFill

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

Overview

Note:

The recommended way to manage styles is with Styles#add_style

A PatternFill is the pattern and solid fill styling for a cell.

See Also:

  • Style#add_style

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ PatternFill

Creates a new PatternFill Object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • patternType (Symbol)
  • fgColor (Color)
  • bgColor (Color) 


44
45
46
47
48
49
 
# File 'lib/axlsx/stylesheet/pattern_fill.rb', line 44

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

Instance Attribute Details

#bgColor ⇒ Color

The color to use for the background of the fill when the type is not solid.

Returns:



13
14
15
 
# File 'lib/axlsx/stylesheet/pattern_fill.rb', line 13

def bgColor
  @bgColor
end

#fgColor ⇒ Color

The color to use for the the background in solid fills.

Returns:



9
10
11
 
# File 'lib/axlsx/stylesheet/pattern_fill.rb', line 9

def fgColor
  @fgColor
end

#patternType ⇒ Object

Note:

patternType must be one of 

:none
:solid
:mediumGray
:darkGray
:lightGray
:darkHorizontal
:darkVertical
:darkDown
:darkUp
:darkGrid
:darkTrellis
:lightHorizontal
:lightVertical
:lightDown
:lightUp
:lightGrid
:lightTrellis
:gray125
:gray0625

The pattern type to use

See Also:

  • Open XML Part 1 18.18.55


38
39
40
 
# File 'lib/axlsx/stylesheet/pattern_fill.rb', line 38

def patternType
  @patternType
end

Instance Method Details

#to_xml(xml) ⇒ String

Serializes the pattern fill

Parameters:

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

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

Returns:

  • (String) 


60
61
62
63
64
 
# File 'lib/axlsx/stylesheet/pattern_fill.rb', line 60

def to_xml(xml) 
  xml.patternFill(:patternType => self.patternType) { 
    self.instance_values.reject { |k,v| k.to_sym == :patternType }.each { |k,v| xml.send(k, v.instance_values) }    
  }
end