Class: Axlsx::BorderPr

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

Overview

A border part.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ BorderPr

Creates a new Border Part Object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • color (Color)
  • name (Symbol)
  • style (Symbol)

See Also:



46
47
48
49
50
 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 46

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

Instance Attribute Details

#color ⇒ Color

Returns The color of this border part.

Returns:

  • (Color) —

    The color of this border part.



6
7
8
 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 6

def color
  @color
end

#name ⇒ Symbol

Note:

The following are allowed

:start
:end
:left
:right
:top
:bottom
:diagonal
:vertical
:horizontal

Returns The name of this border part.

Returns:

  • (Symbol) —

    The name of this border part



39
40
41
 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 39

def name
  @name
end

#style ⇒ Symbol

Note:

The following are allowed

:none 
:thin
:medium
:dashed
:dotted
:thick
:double
:hair 
:mediumDashed
:dashDot
:mediumDashDot
:dashDotDot
:mediumDashDotDot
:slantDashDot

Returns The syle of this border part.

Returns:

  • (Symbol) —

    The syle of this border part.



25
26
27
 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 25

def style
  @style
end

Instance Method Details

#to_xml(xml) ⇒ String

Serializes the border part

Parameters:

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

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

Returns:

  • (String) 


62
63
64
65
66
 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 62

def to_xml(xml)
  xml.send(@name, :style => @style) {
    @color.to_xml(xml) if @color.is_a? Color
  } 
end