Class $.wijmo.wijspread.ConditionalFormats

Class Summary
Constructor Attributes	Constructor Name and Description
	$.wijmo.wijspread.ConditionalFormats(worksheet) Creates a new format condition.

Method Summary
Method Attributes	Method Name and Description
	add2ScaleRule(minType, minValue, minColor, maxType, maxValue, maxColor, ranges) Adds the two color scale rule to the rule collection.
	addAverageRule(type, style, ranges) Adds an average rule to the rule collection.
	addCellValueRule(comparisonOperator, value1, value2, style, ranges) Adds the cell value rule to the rule collection.
	addDateOccurringRule(type, style, ranges) Adds the data occurring rule to the rule collection.
	addDuplicateRule(style, ranges) Adds a duplicate rule to the rule collection.
	addFormulaRule(formula, style, ranges) Adds the formula rule to the rule collection.
	addRule(rule) Adds the rule.
	addSpecificTextRule(comparisonOperator, text, style, ranges) Adds the text rule to the rule collection.
	addTop10Rule(type, rank, style, ranges) Adds the top 10 rule or bottom 10 rule to the collection based on the Top10CondtionType.
	addUniqueRule(style, ranges) Adds a unique rule to the rule collection.
	containsRule(rule, row, column) Determines whether the specified cell contains a specified rule.
	count() Gets the number of rule objects in the collection.
	getRules(row, column) Gets the conditional rules from the cell at the specified row and column.
	removeRule(rule) Removes a rule object from the ConditionalFormats object.

Class Detail

$.wijmo.wijspread.ConditionalFormats(worksheet)

Creates a new format condition.

Parameters:
worksheet: The sheet.

Method Detail

add2ScaleRule(minType, minValue, minColor, maxType, maxValue, maxColor, ranges)

Adds the two color scale rule to the rule collection.

Parameters:
minType: The minimum scale type.
minValue: The minimum scale value.
minColor: The minimum scale color.
maxType: The maximum scale type.
maxValue: The maximum scale value.
maxColor: The maximum scale color.
ranges: The cell ranges where the rule is applied.

addAverageRule(type, style, ranges)

Adds an average rule to the rule collection.

Parameters:
type: The average condition type .
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

addCellValueRule(comparisonOperator, value1, value2, style, ranges)

Adds the cell value rule to the rule collection.

Parameters:
comparisonOperator: The ComparisonOperator comparison operator.
value1: The first value.
value2: The second value.
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

addDateOccurringRule(type, style, ranges)

Adds the data occurring rule to the rule collection.

Parameters:
type: The data occurring type .
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

addDuplicateRule(style, ranges)

Adds a duplicate rule to the rule collection.

Parameters:
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

addFormulaRule(formula, style, ranges)

Adds the formula rule to the rule collection.

Parameters:
formula: The condition formula.
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

addRule(rule)

Adds the rule.

var style = new $.wijmo.wijspread.Style();
style.backColor = "red";
var rule =new $.wijmo.wijspread.FormulaRule("=A1=B1+C1", style);
rule.ranges = [new $.wijmo.wijspread.Range(0, 0, 5, 1) ];
sheet.getConditionalFormats().addRule(rule);
sheet.setValue(0, 0, 2,3);
sheet.setValue(0, 1, 1,3);
sheet.setValue(0, 2,1,3);
sheet.setValue(1, 0, 1,3);

Parameters:
rule: The rule to add.

addSpecificTextRule(comparisonOperator, text, style, ranges)

Adds the text rule to the rule collection.

Parameters:
comparisonOperator: The comparison operator.
text: The text for comparison.
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

addTop10Rule(type, rank, style, ranges)

Adds the top 10 rule or bottom 10 rule to the collection based on the Top10CondtionType.

Parameters:
type: The top 10 condition .
rank: The number of top or bottom items to apply the style to.
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

addUniqueRule(style, ranges)

Adds a unique rule to the rule collection.

Parameters:
style: The style that is applied to the cell when the condition is met.
ranges: The cell ranges where the rule is applied.

containsRule(rule, row, column)

Determines whether the specified cell contains a specified rule.

Parameters:
rule: The rule for which to check.
row: The row index.
column: The column index.

count()

Gets the number of rule objects in the collection.

getRules(row, column)

Gets the conditional rules from the cell at the specified row and column.

Parameters:
row: The row index.
column: The column index.

removeRule(rule)

Removes a rule object from the ConditionalFormats object.

Parameters:
rule: Rule object to remove from the ConditionalFormats object.

Classes

Class $.wijmo.wijspread.ConditionalFormats