Class: Axlsx::Cfvo

Inherits:
Object
  • Object
show all
Includes:
OptionsParser, SerializedAttributes
Defined in:
lib/axlsx/workbook/worksheet/cfvo.rb

Overview

Note:

The recommended way to manage these rules is via Worksheet#add_conditional_formatting

Conditional Format Value Object Describes the values of the interpolation points in a gradient scale. This object is used by ColorScale, DataBar and IconSet classes

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SerializedAttributes

#declared_attributes, included, #serialized_attributes, #serialized_element_attributes, #serialized_tag

Methods included from OptionsParser

#parse_options

Constructor Details

#initialize(options = {}) ⇒ Cfvo

Creates a new Cfvo object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • type (Symbol) —

    The type of conditional formatting value object

  • gte (Boolean) —

    threshold value usage indicator

  • val (String) —

    The value of the conditional formatting object



17
18
19
20
 
# File 'lib/axlsx/workbook/worksheet/cfvo.rb', line 17

def initialize(options = {})
  @gte = true
  parse_options options
end

Instance Attribute Details

#gte ⇒ Boolean

Type (xsd:boolean) For icon sets, determines whether this threshold value uses the greater than or equal to operator. 0 indicates 'greater than' is used instead of 'greater than or equal to'. The default value is true

Returns:

  • (Boolean) 


33
34
35
 
# File 'lib/axlsx/workbook/worksheet/cfvo.rb', line 33

def gte
  @gte
end

#type ⇒ Symbol

Type (ST_CfvoType) The type of this conditional formatting value object. options are num, percent, max, min, formula and percentile

Returns:

  • (Symbol) 


27
28
29
 
# File 'lib/axlsx/workbook/worksheet/cfvo.rb', line 27

def type
  @type
end

#val ⇒ Object

Type (ST_Xstring) The value of the conditional formatting object This library will accept any value so long as it supports to_s



38
39
40
 
# File 'lib/axlsx/workbook/worksheet/cfvo.rb', line 38

def val
  @val
end

Instance Method Details

#to_xml_string(str = '') ⇒ String

serialize the Csvo object

Parameters:

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

Returns:

  • (String) 


56
57
58
 
# File 'lib/axlsx/workbook/worksheet/cfvo.rb', line 56

def to_xml_string(str = '')
  serialized_tag('cfvo', str)
end