Class: Axlsx::IconSet

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

Overview

Note:

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

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 = {}) {|_self| ... } ⇒ IconSet

Creates a new icon set object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • iconSet (String)
  • reverse (Boolean)
  • percent (Boolean)
  • showValue (Boolean)

Yields:

  • (_self)

Yield Parameters:


18
19
20
21
22
23
24
25
# File 'lib/axlsx/workbook/worksheet/icon_set.rb', line 18

def initialize(options = {})
  @percent = @showValue = true
  @reverse = false
  @iconSet = "3TrafficLights1"
  initialize_value_objects
  parse_options options
  yield self if block_given?
end

Instance Attribute Details

#iconSetString

The icon set to display. Allowed values are: 3Arrows, 3ArrowsGray, 3Flags, 3TrafficLights1, 3TrafficLights2, 3Signs, 3Symbols, 3Symbols2, 4Arrows, 4ArrowsGray, 4RedToBlack, 4Rating, 4TrafficLights, 5Arrows, 5ArrowsGray, 5Rating, 5Quarters The default value is 3TrafficLights1

Returns:

  • (String)

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

def iconSet
  @iconSet
end

#percentBoolean

Indicates whether the thresholds indicate percentile values, instead of number values. The default falue is true

Returns:

  • (Boolean)

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

def percent
  @percent
end

#reverseBoolean

If true, reverses the default order of the icons in this icon set.maxLength attribute The default value is false

Returns:

  • (Boolean)

43
44
45
# File 'lib/axlsx/workbook/worksheet/icon_set.rb', line 43

def reverse
  @reverse
end

#showValueBoolean

Indicates whether to show the values of the cells on which this data bar is applied. The default value is true

Returns:

  • (Boolean)

48
49
50
# File 'lib/axlsx/workbook/worksheet/icon_set.rb', line 48

def showValue
  @showValue
end

Instance Method Details

#to_xml_string(str = "") ⇒ String

Serialize this object to an xml string

Parameters:

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

Returns:

  • (String)

65
66
67
68
69
# File 'lib/axlsx/workbook/worksheet/icon_set.rb', line 65

def to_xml_string(str="")
  serialized_tag('iconSet', str) do
    @value_objects.each { |cfvo| cfvo.to_xml_string(str) }
  end
end