[]
Sheets.ConditionalFormatting.ConditionalFormats
• new ConditionalFormats(worksheet
)
一个格式条件类
属性名 | 类型 | 说明 |
---|---|---|
worksheet |
Worksheet |
表单 |
▸ add2ScaleRule(minType
, minValue
, minColor
, maxType
, maxValue
, maxColor
, ranges
): ConditionRuleBase
将双色刻度规则添加到规则集合
代码示例
//本示例使用add2ScaleRule方法
activeSheet.conditionalFormats.add2ScaleRule(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number,10,"Red",GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number,100,"Yellow", [new GC.Spread.Sheets.Range(0,0,10,3)]);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);
属性名 | 类型 | 说明 |
---|---|---|
minType |
ScaleValueType |
最小的比例类型 |
minValue |
number |
最小刻度值 |
minColor |
string |
最小刻度颜色 |
maxType |
ScaleValueType |
最大的比例类型 |
maxValue |
number |
最大刻度值 |
maxColor |
string |
最大刻度颜色 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
双色刻度规则已添加到规则集合
▸ add3ScaleRule(minType
, minValue
, minColor
, midType
, midValue
, midColor
, maxType
, maxValue
, maxColor
, ranges
): ConditionRuleBase
将三色刻度规则添加到规则集合
代码示例
//本示例使用add3ScaleRule方法
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);
activeSheet.conditionalFormats.add3ScaleRule(1, 10, "red", 0, 50, "blue",2, 100, "yellow", [new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
属性名 | 类型 | 说明 |
---|---|---|
minType |
ScaleValueType |
最小的比例类型 |
minValue |
number |
最小刻度值 |
minColor |
string |
最小刻度颜色 |
midType |
ScaleValueType |
中点刻度类型 |
midValue |
number |
中点刻度值 |
midColor |
string |
中点刻度颜色 |
maxType |
ScaleValueType |
最大的比例类型 |
maxValue |
number |
最大刻度值 |
maxColor |
string |
最大刻度颜色 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
三色刻度规则已添加到规则集合
▸ addAverageRule(type
, style
, ranges
): ConditionRuleBase
将平均规则添加到规则集合
代码示例
//本示例使用addAverageRule方法
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);
activeSheet.setValue(3,0, 2,3);
activeSheet.setValue(4,0, 60,3);
activeSheet.setValue(5,0, 90,3);
activeSheet.setValue(6,0, 3,3);
activeSheet.setValue(7,0, 40,3);
activeSheet.setValue(8,0, 70,3);
activeSheet.setValue(9,0, 5,3);
activeSheet.setValue(10,0, 35,3);
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.borderLeft =new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderTop = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderRight = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
style.borderBottom = new GC.Spread.Sheets.LineBorder("blue",GC.Spread.Sheets.LineStyle.medium);
activeSheet.conditionalFormats.addAverageRule(GC.Spread.Sheets.ConditionalFormatting.AverageConditionType.above,style,[new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
属性名 | 类型 | 说明 |
---|---|---|
type |
AverageConditionType |
平均值条件类型 |
style |
Style |
满足条件时应用于单元格的样式 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
平均规则已添加到规则集合
▸ addCellValueRule(comparisonOperator
, value1
, value2
, style
, ranges
): ConditionRuleBase
将单元格值规则添加到规则集合
代码示例
//本示例使用addCellValueRule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var ranges=[new GC.Spread.Sheets.Range(0,0,5,1)];
activeSheet.conditionalFormats.addCellValueRule(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between, 2, 100, style, ranges);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
属性名 | 类型 | 说明 |
---|---|---|
comparisonOperator |
ComparisonOperators |
比较运算符 |
value1 |
Object |
第一个值 |
value2 |
Object |
第二个值 |
style |
Style |
满足条件时应用于单元格的样式 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
单元格值规则已添加到规则集合
▸ addColumnStateRule(state
, style
, ranges
): ConditionRuleBase
在规则集合中添加一个列状态规则
代码示例
// 在列方向添加一个悬停状态规则
activeSheet.conditionalFormats.addColumnStateRule(GC.Spread.Sheets.RowColumnStates.hover, new GC.Spread.Sheets.Style("yellow"), [new GC.Spread.Sheets.Range(-1, -1, -1, -1)]);
activeSheet.conditionalFormats.addColumnStateRule(
GC.Spread.Sheets.RowColumnStates.hover,
[new GC.Spread.Sheets.Style("green"), new GC.Spread.Sheets.Style("red")],
[new GC.Spread.Sheets.Range(1, 1, 10, 5), new GC.Spread.Sheets.Range(13, 1, 10, 5)]
);
属性名 | 类型 | 说明 |
---|---|---|
state |
RowColumnStates |
状态类型 |
style |
Style | Style [] |
行的样式,如果列是匹配的状态 It could be an array of styles. |
ranges |
Range [] |
应用规则的范围,其项类型为GC.Spread.Sheet.Range |
添加到规则集合中的状态规则
▸ addDataBarRule(minType
, minValue
, maxType
, maxValue
, color
, ranges
): ConditionRuleBase
将数据条规则添加到规则集合
代码示例
//本示例使用addDataBarRule方法
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
activeSheet.conditionalFormats.addDataBarRule(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number, -1, GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number, 40, "orange", [new GC.Spread.Sheets.Range(0,0,4,1)]);
属性名 | 类型 | 说明 |
---|---|---|
minType |
ScaleValueType |
最小的比例类型 |
minValue |
number |
最小刻度值 |
maxType |
ScaleValueType |
最大的比例类型 |
maxValue |
number |
最大刻度值 |
color |
string |
在视图上显示的数据条颜色 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
数据条规则已添加到规则集合
▸ addDateOccurringRule(type
, style
, ranges
): ConditionRuleBase
将日期发生规则添加到规则集合中
代码示例
//本示例使用addDateOccurringRule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var d = new Date();
activeSheet.setValue(0, 0, d);
activeSheet.setValue(1, 0, new Date(d.setDate(d.getDate()+1)));
activeSheet.setValue(2, 0, new Date(d.setDate(d.getDate()+5)));
activeSheet.setValue(3, 0,new Date(d.setDate(d.getDate()+6)));
activeSheet.setValue(4, 0,new Date(d.setDate(d.getDate()+7)));
activeSheet.setValue(5, 0, new Date(d.setDate(d.getDate()+8)));
activeSheet.conditionalFormats.addDateOccurringRule(GC.Spread.Sheets.ConditionalFormatting.DateOccurringType.nextWeek, style, [new GC.Spread.Sheets.Range(0,0,10,1)]);
属性名 | 类型 | 说明 |
---|---|---|
type |
DateOccurringType |
日期发生类型 |
style |
Style |
满足条件时应用于单元格的样式 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
日期发生规则已添加到规则集合
▸ addDuplicateRule(style
, ranges
): ConditionRuleBase
将重复规则添加到规则集合
代码示例
//本示例使用addDuplicateRule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "yellow";
var ranges=[new GC.Spread.Sheets.Range(0,0,10,1)];
activeSheet.conditionalFormats.addDuplicateRule(style, ranges);
activeSheet.setValue(0, 0, 50);
activeSheet.setValue(1, 0, 50);
activeSheet.setValue(2, 0, 11);
activeSheet.setValue(3, 0, 5);
属性名 | 类型 | 说明 |
---|---|---|
style |
Style |
满足条件时应用于单元格的样式 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
重复规则已添加到规则集合
▸ addFormulaRule(formula
, style
, ranges
): ConditionRuleBase
将公式规则添加到规则集合
代码示例
//本示例使用addFormulaRule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var ranges = [new GC.Spread.Sheets.Range(0, 0, 2, 1)];
activeSheet.conditionalFormats.addFormulaRule("=A1=B1+C1", style, ranges);
activeSheet.setValue(0, 0, 2,3);
activeSheet.setValue(0, 1, 1,3);
activeSheet.setValue(0, 2,1,3);
activeSheet.setValue(1, 0, 1,3);
属性名 | 类型 | 说明 |
---|---|---|
formula |
string |
条件公式 |
style |
Style |
满足条件时应用于单元格的样式 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
公式规则已添加到规则集合
▸ addIconSetRule(iconSetTye
, ranges
): ConditionRuleBase
将图标集规则添加到规则集合
代码示例
//本示例使用addIconSetRule方法
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
activeSheet.conditionalFormats.addIconSetRule(GC.Spread.Sheets.ConditionalFormatting.IconSetType.fourTrafficLights, [new GC.Spread.Sheets.Range(0,0,4,1)]);
属性名 | 类型 | 说明 |
---|---|---|
iconSetTye |
IconSetType |
- |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
图标集规则已添加到规则集合
▸ addRowStateRule(state
, style
, ranges
): ConditionRuleBase
在规则集合中添加一个行状态规则
代码示例
// 在行方向添加一个悬停状态规则
activeSheet.conditionalFormats.addRowStateRule(GC.Spread.Sheets.RowColumnStates.hover, new GC.Spread.Sheets.Style("yellow"), [new GC.Spread.Sheets.Range(-1, -1, -1, -1)]);
// Add a hover state rule with variable styles
activeSheet.conditionalFormats.addRowStateRule(
GC.Spread.Sheets.RowColumnStates.hover,
[new GC.Spread.Sheets.Style("green"), new GC.Spread.Sheets.Style("red")],
[new GC.Spread.Sheets.Range(1, 1, 10, 5), new GC.Spread.Sheets.Range(1, 7, 10, 5)]
);
属性名 | 类型 | 说明 |
---|---|---|
state |
RowColumnStates |
状态类型 |
style |
Style | Style [] |
行的样式,如果行是匹配的状态 It could be an array of styles. |
ranges |
Range [] |
应用规则的范围,其项类型为GC.Spread.Sheet.Range |
添加到规则集合中的状态规则
▸ addRule(rule
): ConditionRuleBase
添加规则
代码示例
//本示例使用addRule方法
var scale = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
scale.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.threeScaleRule);
scale.midColor("red");
scale.midType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.midValue(50);
scale.maxColor("blue");
scale.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.maxValue(100);
scale.minColor("yellow");
scale.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.minValue(10);
scale.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
activeSheet.conditionalFormats.addRule(scale);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);
属性名 | 类型 | 说明 |
---|---|---|
rule |
ConditionRuleBase |
要添加的规则 |
▸ addSpecificTextRule(comparisonOperator
, text
, style
, ranges
): ConditionRuleBase
将文本规则添加到规则集合
代码示例
//本示例使用addSpecificTextRule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var ranges=[new GC.Spread.Sheets.Range(0,0,10,1)];
activeSheet.conditionalFormats.addSpecificTextRule(GC.Spread.Sheets.ConditionalFormatting.TextComparisonOperators.contains, "test", style, ranges);
activeSheet.setValue(0, 0, "testing");
activeSheet.setValue(1, 0, "test");
activeSheet.setValue(2, 0, "a");
activeSheet.setValue(3, 0, "t");
属性名 | 类型 | 说明 |
---|---|---|
comparisonOperator |
TextComparisonOperators |
比较运算符 |
text |
string |
供比较的文本 |
style |
Style |
满足条件时应用于单元格的样式 |
ranges |
Range [] |
将规则应用于项类型为GC.Spread.Sheets.Range的项的单元格区域 |
文本规则已添加到规则集合
▸ addTop10Rule(type
, rank
, style
, ranges
): ConditionRuleBase
将基于Top10CondtionType对象的前10条规则或后10条规则添加到集合中
代码示例
//本示例使用addTop10Rule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var ranges=[new GC.Spread.Sheets.Range(0,0,10,1)];
activeSheet.conditionalFormats.addTop10Rule(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top, 2, style, ranges);
activeSheet.setValue(0, 0, 1);
activeSheet.setValue(1, 0, 50);
activeSheet.setValue(2, 0, 11);
activeSheet.setValue(3, 0, 5);
属性名 | 类型 | 说明 |
---|---|---|
type |
Top10ConditionType |
前10条件 |
rank |
number |
要应用样式的顶部或底部项的数量 |
style |
Style |
满足条件时应用于单元格的样式 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
前10条规则已添加到规则集合
▸ addUniqueRule(style
, ranges
): ConditionRuleBase
将唯一规则添加到规则集合
代码示例
//本示例使用addUniqueRule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "green";
activeSheet.setValue(0, 0, 50);
activeSheet.setValue(1, 0, 50);
activeSheet.setValue(2, 0, 11);
activeSheet.setValue(3, 0, 5);
activeSheet.conditionalFormats.addUniqueRule(style, [new GC.Spread.Sheets.Range(0,0,10,1)]);
属性名 | 类型 | 说明 |
---|---|---|
style |
Style |
满足条件时应用于单元格的样式 |
ranges |
Range [] |
项类型为GC.Spread.Sheets.Range的应用规则的单元格区域 |
唯一规则已添加到规则集合
▸ clearRule(): void
删除所有规则
代码示例
//本示例使用clearRule方法
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);
activeSheet.conditionalFormats.add2ScaleRule(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number, 10, "red", GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number, 100, "yellow", [new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
// 删除要测试的方法前面的注释
//activeSheet.conditionalFormats.clearRule();
void
▸ containsRule(rule
, row
, column
): boolean
确定指定的单元格是否包含指定的规则
代码示例
//本示例检查以查看单元格是否具有指定的规则
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
var ruletest = activeSheet.conditionalFormats.containsRule(rule, 0, 0);
alert(ruletest);
属性名 | 类型 | 说明 |
---|---|---|
rule |
ConditionRuleBase |
要检查的规则 |
row |
number |
行索引 |
column |
number |
列索引 |
boolean
如果指定的单元格包含指定的规则,返回true;否则返回false
▸ count(): number
获取集合中规则对象的数量
代码示例
//本示例计算规则
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
var ruletest = activeSheet.conditionalFormats.count();
alert(ruletest);
number
集合中规则对象的数量
▸ getRule(index
): ConditionRuleBase
使用索引获取规则
代码示例
//本示例使用了getRule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
var ruletest = activeSheet.conditionalFormats.getRule(0);
alert(ruletest.value1());
属性名 | 类型 | 说明 |
---|---|---|
index |
number |
从中获取规则的索引 |
索引中的规则
▸ getRules(row
, column
): ConditionRuleBase
[]
从指定行和列的单元格获取条件规则
代码示例
//本示例使用getRules方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
var ruletest = activeSheet.conditionalFormats.getRules();
alert(ruletest[0].style().backColor);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
行索引 |
column |
number |
列索引 |
条件规则
▸ removeRule(rule
): void
从ConditionalFormats对象中删除一个规则对象
代码示例
//本示例使用removeRule方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
activeSheet.conditionalFormats.removeRule(rule);
属性名 | 类型 | 说明 |
---|---|---|
rule |
ConditionRuleBase |
从ConditionalFormats对象中删除的规则对象 |
void
▸ removeRuleByRange(row
, column
, rowCount
, columnCount
): void
从指定的单元格区域中删除规则
代码示例
//本示例使用removeRuleByRange方法
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
activeSheet.conditionalFormats.removeRuleByRange(0, 0, 5, 1);
属性名 | 类型 | 说明 |
---|---|---|
row |
number |
区域中第一个单元格的行索引 |
column |
number |
区域中第一个单元格的列索引 |
rowCount |
number |
区域内的行数 |
columnCount |
number |
区域内的列数 |
void