Class: Axlsx::CellStyle

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

Overview

Note:

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

CellStyle defines named styles that reference defined formatting records and can be used in your worksheet.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SerializedAttributes

#declared_attributes, included, #serialized_attributes, #serialized_element_attributes

Methods included from OptionsParser

#parse_options

Constructor Details

#initialize(options = {}) ⇒ CellStyle

Creats a new CellStyle object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • name (String)
  • xfId (Integer)
  • buildinId (Integer)
  • iLevel (Integer)
  • hidden (Boolean)
  • customBuiltIn (Boolean) 


18
19
20
 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 18

def initialize(options={})
  parse_options options
end

Instance Attribute Details

#builtinId ⇒ Integer

The buildinId to use when this named style is applied

Returns:

  • (Integer)

See Also:



36
37
38
 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 36

def builtinId
  @builtinId
end

#customBuiltin ⇒ Boolean

Indicates that the build in style reference has been customized.

Returns:

  • (Boolean) 


48
49
50
 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 48

def customBuiltin
  @customBuiltin
end

#hidden ⇒ Boolean

Determines if this named style should show in the list of styles when using excel

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 44

def hidden
  @hidden
end

#iLevel ⇒ Integer

Determines if this formatting is for an outline style, and what level of the outline it is to be applied to.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 40

def iLevel
  @iLevel
end

#name ⇒ String

The name of this cell style

Returns:

  • (String) 


26
27
28
 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 26

def name
  @name
end

#xfId ⇒ Integer

The formatting record id this named style utilizes

Returns:

  • (Integer)

See Also:



31
32
33
 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 31

def xfId
  @xfId
end

Instance Method Details

#to_xml_string(str = '') ⇒ String

Serializes the object

Parameters:

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

Returns:

  • (String) 


66
67
68
69
70
 
# File 'lib/axlsx/stylesheet/cell_style.rb', line 66

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