Method: Axlsx::ConditionalFormattingRule#initialize

Defined in:

lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb

#initialize(options = {}) ⇒ ConditionalFormattingRule

Creates a new Conditional Formatting Rule object

Options Hash (options):

• type (Symbol) —

  The type of this formatting rule

• aboveAverage (Boolean) —

  This is an aboveAverage rule

• bottom (Boolean) —

  This is a bottom N rule.

• dxfId (Integer) —

  The formatting id to apply to matches

• equalAverage (Boolean) —

  Is the aboveAverage or belowAverage rule inclusive

• priority (Integer) —

  The priority of the rule, 1 is highest

• operator (Symbol) —

  Which operator to apply

• text (String) —

  The value to apply a text operator against

• percent (Boolean) —

  If a top/bottom N rule, evaluate as N% rather than N

• rank (Integer) —

  If a top/bottom N rule, the value of N

• stdDev (Integer) —

  The number of standard deviations above or below the average to match

• stopIfTrue (Boolean) —

  Stop evaluating rules after this rule matches

• timePeriod (Symbol) —

  The time period in a date occuring... rule

• formula (String) —

  The formula to match against in i.e. an equal rule. Use a [minimum, maximum] array for cellIs between/notBetween conditionals.

# File 'lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb', line 29

def initialize(options={})
  @color_scale = @data_bar = @icon_set = @formula = nil
  parse_options options
end