Class: Axlsx::CellAlignment

Inherits:
Object
  • Object
show all
Includes:
OptionsParser, SerializedAttributes
Defined in:
lib/axlsx/stylesheet/cell_alignment.rb

Overview

Note:

Using Styles#add_style is the recommended way to manage cell alignment.

CellAlignment stores information about the cell alignment of a style Xf Object.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from OptionsParser

#parse_options

Methods included from SerializedAttributes

#declared_attributes, included, #serialized_attributes, #serialized_element_attributes

Constructor Details

#initialize(options = {}) ⇒ CellAlignment

Create a new cell_alignment object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • horizontal (Symbol)
  • vertical (Symbol)
  • text_rotation (Integer)
  • wrap_text (Boolean)
  • indent (Integer)
  • relative_indent (Integer)
  • justify_last_line (Boolean)
  • shrink_to_fit (Boolean)
  • reading_order (Integer) 


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

def initialize(options={})
  parse_options options
end

Instance Attribute Details

#horizontal ⇒ Symbol

Note:

The horizontal cell alignement style must be one of :general :left :center :right :fill :justify :centerContinuous :distributed

The horizontal alignment of the cell.

Returns:

  • (Symbol) 


43
44
45
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 43

def horizontal
  @horizontal
end

#indent ⇒ Integer

The amount of indent

Returns:

  • (Integer) 


68
69
70
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 68

def indent
  @indent
end

#justify_last_line ⇒ Boolean Also known as: justifyLastLine

Indicate if the last line should be justified.

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 77

def justify_last_line
  @justify_last_line
end

#reading_order ⇒ Integer Also known as: readingOrder

The reading order of the text 0 Context Dependent 1 Left-to-Right 2 Right-to-Left

Returns:

  • (Integer) 


90
91
92
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 90

def reading_order
  @reading_order
end

#relative_indent ⇒ Integer Also known as: relativeIndent

The amount of relativeIndent

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 72

def relative_indent
  @relative_indent
end

#shrink_to_fit ⇒ Boolean Also known as: shrinkToFit

Indicate if the text should be shrunk to the fit in the cell.

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 82

def shrink_to_fit
  @shrink_to_fit
end

#text_rotation ⇒ Integer Also known as: textRotation

The textRotation of the cell.

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 58

def text_rotation
  @text_rotation
end

#vertical ⇒ Symbol

Note:

The vertical cell allingment style must be one of the following: :top :center :bottom :justify :distributed

The vertical alignment of the cell.

Returns:

  • (Symbol) 


54
55
56
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 54

def vertical
  @vertical
end

#wrap_text ⇒ Boolean Also known as: wrapText

Indicate if the text of the cell should wrap

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 63

def wrap_text
  @wrap_text
end

Instance Method Details

#to_xml_string(str = '') ⇒ String

Serializes the object

Parameters:

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

Returns:

  • (String) 


127
128
129
130
131
 
# File 'lib/axlsx/stylesheet/cell_alignment.rb', line 127

def to_xml_string(str = '')
  str << '<alignment '
  serialized_attributes str
  str << '/>'
end