Class: Axlsx::Border

Inherits:

Object

• Object
• Axlsx::Border

Includes:

OptionsParser, SerializedAttributes

Defined in:

lib/axlsx/stylesheet/border.rb

Overview

This class details a border used in Office Open XML spreadsheet styles.

Constant Summary

EDGES =

[:left, :right, :top, :bottom].freeze

Instance Attribute Summary

• #diagonal_down ⇒ Boolean (also: #diagonalDown)

  The diagonal down property for the border that indicates if the border should include a diagonal line from the top left to the top right of the cell.

• #diagonal_up ⇒ Boolean (also: #diagonalUp)

  The diagonal up property for the border that indicates if the border should include a diagonal line from the bottom left to the top right of the cell.

• #outline ⇒ Boolean

  The outline property for the border indicating that top, left, right and bottom borders should only be applied to the outside border of a range of cells.

• #prs ⇒ SimpleTypedList readonly

  A list of BorderPr objects for this border.

Instance Method Summary

• #initialize(options = {}) ⇒ Border constructor

  Creates a new Border object.

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

  Serializes the object.

Methods included from OptionsParser

#parse_options

Methods included from SerializedAttributes

included, #serialized_attributes, #serialized_element_attributes, #serialized_tag

Constructor Details

#initialize(options = {}) ⇒ Border

Note:

The recommended way to manage borders is with Style#add_style

Creates a new Border object

Examples:

• Making a border

p = Axlsx::Package.new
red_border = p.workbook.styles.add_style :border => { :style => :thin, :color => "FFFF0000" }
ws = p.workbook.add_worksheet
ws.add_row [1,2,3], :style => red_border
p.serialize('red_border.xlsx')

Options Hash (options):

• diagonal_up (Boolean)
• diagonal_down (Boolean)
• outline (Boolean)

See Also:

• Style#add_style

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

def initialize(options = {})
  @prs = SimpleTypedList.new BorderPr
  parse_options options
end

Instance Attribute Details

#diagonal_down ⇒ Boolean Also known as: diagonalDown

# File 'lib/axlsx/stylesheet/border.rb', line 36

def diagonal_down
  @diagonal_down
end

#diagonal_up ⇒ Boolean Also known as: diagonalUp

# File 'lib/axlsx/stylesheet/border.rb', line 32

def diagonal_up
  @diagonal_up
end

#outline ⇒ Boolean

# File 'lib/axlsx/stylesheet/border.rb', line 40

def outline
  @outline
end

#prs ⇒ SimpleTypedList (readonly)

# File 'lib/axlsx/stylesheet/border.rb', line 43

def prs
  @prs
end

Instance Method Details

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

Serializes the object

# File 'lib/axlsx/stylesheet/border.rb', line 68

def to_xml_string(str = +'')
  str << '<border '
  serialized_attributes str
  str << '>'
  # enforces order
  [:start, :end, :left, :right, :top, :bottom, :diagonal, :vertical, :horizontal].each do |k|
    @prs.select { |pr| pr.name == k }.each do |part|
      part.to_xml_string(str)
    end
  end
  str << '</border>'
end