summaryrefslogtreecommitdiffhomepage
path: root/lib
diff options
context:
space:
mode:
authorStephen Pike <[email protected]>2012-04-20 15:15:11 -0400
committerStephen Pike <[email protected]>2012-04-20 15:15:11 -0400
commit83f633051eb24440424fe8700bbc49caa74c0589 (patch)
treed84e4b9e27ae722c6438e40024a69d5462c4c100 /lib
parent2111de6d64fdb9569c94db896b9b6e0e152ec1d6 (diff)
downloadcaxlsx-83f633051eb24440424fe8700bbc49caa74c0589.tar.gz
caxlsx-83f633051eb24440424fe8700bbc49caa74c0589.zip
Add some more documentation for example of conditional formatting
Diffstat (limited to 'lib')
-rw-r--r--lib/axlsx/workbook/worksheet/worksheet.rb4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/axlsx/workbook/worksheet/worksheet.rb b/lib/axlsx/workbook/worksheet/worksheet.rb
index 59e57ac2..407a25e5 100644
--- a/lib/axlsx/workbook/worksheet/worksheet.rb
+++ b/lib/axlsx/workbook/worksheet/worksheet.rb
@@ -128,10 +128,12 @@ module Axlsx
#
# @param [String] cells The range to apply the formatting to
# @param [Array|Hash] rules An array of hashes (or just one) to create Conditional formatting rules from.
- # @example This would format column A whenever it is FALSE
+ # @example This would format column A whenever it is FALSE.
+ # # for a longer example, see examples/example_conditional_formatting.rb (link below)
# worksheet.add_conditional_formatting( "A1:A1048576", { :type => :cellIs, :operator => :equal, :formula => "FALSE", :dxfId => 1, :priority => 1 }
#
# @see ConditionalFormattingRule#initialize
+ # @see file:examples/example_conditional_formatting.rb
def add_conditional_formatting(cells, rules)
cf = ConditionalFormatting.new( :sqref => cells )
cf.add_rules rules