Class: Axlsx::GradientStop

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

Overview

The GradientStop object represents a color point in a gradient.

See Also:

  • Office XML Part 1 ยง18.8.24

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(color, position) ⇒ GradientStop

Creates a new GradientStop object

Parameters:

  • color (Color)
  • position (Float) 


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

def initialize(color, position)
  self.color = color
  self.position = position
end

Instance Attribute Details

#color ⇒ Color

The color for this gradient stop

Returns:

See Also:



9
10
11
 
# File 'lib/axlsx/stylesheet/gradient_stop.rb', line 9

def color
  @color
end

#position ⇒ Float

The position of the color

Returns:

  • (Float) 


13
14
15
 
# File 'lib/axlsx/stylesheet/gradient_stop.rb', line 13

def position
  @position
end

Instance Method Details

#to_xml_string(str = '') ⇒ String

Serializes the object

Parameters:

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

Returns:

  • (String) 


31
32
33
34
35
 
# File 'lib/axlsx/stylesheet/gradient_stop.rb', line 31

def to_xml_string(str = '')
  str << ('<stop position="' << position.to_s << '">')
  self.color.to_xml_string(str)
  str << '</stop>'
end