Class: Axlsx::Fill

Inherits:

Object

• Object
• Axlsx::Fill

Defined in:

lib/axlsx/stylesheet/fill.rb

Overview

Note:

The recommended way to manage styles in your workbook is to use Styles#add_style.

The Fill is a formatting object that manages the background color, and pattern for cells.

See Also:

• Styles#add_style
• PatternFill
• GradientFill

Instance Attribute Summary

• #fill_type ⇒ PatternFill, GradientFill

  The type of fill.

Instance Method Summary

• #initialize(fill_type) ⇒ Fill constructor

  Creates a new Fill object.

• #to_xml_string(str = +'')) ⇒ String

  Serializes the object.

Constructor Details

#initialize(fill_type) ⇒ Fill

Creates a new Fill object

Parameters:

• fill_type (PatternFill, GradientFill)

Raises:

• (ArgumentError) —

  if the fill_type parameter is not a PatternFill or a GradientFill instance

# File 'lib/axlsx/stylesheet/fill.rb', line 17

def initialize(fill_type)
  self.fill_type = fill_type
end

Instance Attribute Details

#fill_type ⇒ PatternFill, GradientFill

The type of fill

Returns:

• (PatternFill, GradientFill)

# File 'lib/axlsx/stylesheet/fill.rb', line 12

def fill_type
  @fill_type
end

Instance Method Details

#to_xml_string(str = +'')) ⇒ String

Serializes the object

Parameters:

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

Returns:

• (String)

# File 'lib/axlsx/stylesheet/fill.rb', line 24

def to_xml_string(str = +'')
  str << '<fill>'
  @fill_type.to_xml_string(str)
  str << '</fill>'
end