- GC.Data
- GC.Pivot
- GC.Spread.CalcEngine
- GC.Spread.CalcEngine.Functions
- GC.Spread.CalcEngine.LanguagePackages
- GC.Spread.Commands
- GC.Spread.Common
- GC.Spread.Formatter
- GC.Spread.Pivot
- GC.Spread.Sheets
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.CellState
- GC.Spread.Sheets.CellTypes
- GC.Spread.Sheets.Charts
- GC.Spread.Sheets.Commands
- GC.Spread.Sheets.Comments
- GC.Spread.Sheets.ConditionalFormatting
- GC.Spread.Sheets.ContextMenu
- GC.Spread.Sheets.DataValidation
- GC.Spread.Sheets.Fill
- GC.Spread.Sheets.Filter
- GC.Spread.Sheets.FloatingObjects
- GC.Spread.Sheets.FormulaTextBox
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.Print
- GC.Spread.Sheets.Search
- GC.Spread.Sheets.Shapes
- GC.Spread.Sheets.Slicers
- GC.Spread.Sheets.Sparklines
- GC.Spread.Sheets.StatusBar
- GC.Spread.Sheets.Tables
- GC.Spread.Sheets.TableSheet
- GC.Spread.Sheets.Touch
- GC.Spread.Slicers
- GC.Spread.Sheets.Designer
- GC.Spread.Excel
GC.Spread.Sheets.ConditionalFormatting.StateRule
Class: StateRule
Sheets.ConditionalFormatting.StateRule
Hierarchy
-
↳
StateRule
Table of contents
Constructors
Methods
- condition
- contains
- createCondition
- evaluate
- getExpected
- intersects
- isRow
- isScaleRule
- priority
- ranges
- reset
- ruleType
- state
- stopIfTrue
- style
Constructors
constructor
• new StateRule(ruleType, state, style?, ranges?)
Represents a state rule.
example
// add a row state rule with red back color in whole sheet
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var stateRule = new GC.Spread.Sheets.ConditionalFormatting.StateRule(GC.Spread.Sheets.ConditionalFormatting.RuleType.rowStateRule, style, [new GC.Spread.Sheets.Range(-1, -1, -1, -1)]);
activeSheet.conditionalFormats.addRule(cell);
// add a row state rule with two styles to different corresponding ranges
var stateRule = new GC.Spread.Sheets.ConditionalFormatting.StateRule(
GC.Spread.Sheets.ConditionalFormatting.RuleType.rowStateRule,
[new GC.Spread.Sheets.Style("green"), new GC.Spread.Sheets.Style("red")],
[new GC.Spread.Sheets.Range(1, 1, 10, 5)\uff0c new GC.Spread.Sheets.Range(1, 7, 10, 5)]
);
Parameters
| Name | Type | Description |
|---|---|---|
ruleType |
RuleType |
The state rule type, it would be GC.Spread.Sheets.ConditionalFormatting.RuleType.rowStateRule or GC.Spread.Sheets.ConditionalFormatting.RuleType.columnStateRule. |
state |
RowColumnStates |
The state. |
style? |
Style | Style[] |
The style that is applied to the cell when the state is met. It could an array of styles. |
ranges? |
Range[] |
The cell ranges where the rule is applied whose item type is GC.Spread.Sheets.Range. |
Overrides
Methods
condition
▸ condition(value?): any
Gets or sets the base condition of the rule.
Parameters
| Name | Type | Description |
|---|---|---|
value? |
Condition |
The base condition of the rule. |
Returns
any
If no value is set, returns the base condition of the rule; otherwise, returns the condition rule.
Inherited from
contains
▸ contains(row, column): boolean
Determines whether the range of cells contains the cell at the specified row and column.
Parameters
| Name | Type | Description |
|---|---|---|
row |
number |
The row index. |
column |
number |
The column index. |
Returns
boolean
Inherited from
createCondition
▸ createCondition(): Condition
Creates condition for the rule.
Returns
The condition.
Inherited from
ConditionRuleBase.createCondition
evaluate
▸ evaluate(evaluator, baseRow, baseColumn, actual): Style
Returns the cell style of the rule if the cell satisfies the condition.
Parameters
| Name | Type | Description |
|---|---|---|
evaluator |
Object |
The object that can evaluate a condition. |
baseRow |
number |
The row index. |
baseColumn |
number |
The column index. |
actual |
Object |
The actual value. |
Returns
The cell style of the rule.
Inherited from
getExpected
▸ getExpected(): Style
Gets the style of the base rule.
Returns
Inherited from
intersects
▸ intersects(row, column, rowCount, columnCount): boolean
Specifies whether the range for this rule intersects another range.
Parameters
| Name | Type | Description |
|---|---|---|
row |
number |
The row index. |
column |
number |
The column index. |
rowCount |
number |
The number of rows. |
columnCount |
number |
The number of columns. |
Returns
boolean
Inherited from
isRow
▸ isRow(): boolean
Get whether this state rule will applied to row direction.
Returns
boolean
Whether this state rule will be applied to row direction, otherwise, it will be applied to column direction.
isScaleRule
▸ isScaleRule(): boolean
Specifies whether this rule is a scale rule.
Returns
boolean
Inherited from
priority
▸ priority(value?): any
Gets or sets the priority of the rule.
Parameters
| Name | Type | Description |
|---|---|---|
value? |
number |
The priority of the rule. |
Returns
any
If no value is set, returns the priority of the rule; otherwise, returns the condition rule.
Inherited from
ranges
▸ ranges(value?): any
Gets or sets the condition rule ranges.
example
var style = new GC.Spread.Sheets.Style();
style.backColor = "green";
var ranges = [new GC.Spread.Sheets.Range(0, 0, 10, 1)];
activeSheet.conditionalFormats.addUniqueRule(style, ranges);
activeSheet.setValue(0, 0, 50);
activeSheet.setValue(1, 0, 50);
activeSheet.setValue(2, 0, 11);
activeSheet.setValue(3, 0, 5);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
Range[] |
The condition rule ranges. |
Returns
any
If no value is set, returns the condition rule ranges; otherwise, returns the condition rule.
Inherited from
reset
▸ reset(): void
Resets the rule.
Returns
void
Inherited from
ruleType
▸ ruleType(value?): any
Gets or sets the condition rule type.
example
//This example uses the ruleType method.
activeSheet.setArray(0,0,[1,2,3,4,5,6,7,8,9,10]);
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.foreColor = "black";
var cell = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
cell.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
cell.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.greaterThan);
cell.value1(5);
cell.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
cell.style(style);
activeSheet.conditionalFormats.addRule(cell);
var style1 = new GC.Spread.Sheets.Style();
style1.foreColor = "red";
var top = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
top.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
top.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
top.rank(3);
top.style(style1);
top.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
top.stopIfTrue(true);
activeSheet.conditionalFormats.addRule(top);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
RuleType |
The condition rule type. |
Returns
any
If no value is set, returns the condition rule type; otherwise, returns the condition rule.
Inherited from
state
▸ state(value?): RowColumnStates
Gets or sets the rule state.
Parameters
| Name | Type | Description |
|---|---|---|
value? |
RowColumnStates |
The state. |
Returns
The rule state.
stopIfTrue
▸ stopIfTrue(value?): any
Gets or sets whether rules with lower priority are applied before this rule.
example
//This example applies multiple rules.
activeSheet.setArray(0,0,[1,2,3,4,5,6,7,8,9,10]);
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.foreColor = "black";
var cell = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
cell.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
cell.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.greaterThan);
cell.value1(5);
cell.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
cell.style(style);
activeSheet.conditionalFormats.addRule(cell);
var style1 = new GC.Spread.Sheets.Style();
style1.foreColor = "red";
var top = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
top.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
top.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
top.rank(3);
top.style(style1);
top.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
top.stopIfTrue(true);
activeSheet.conditionalFormats.addRule(top);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
boolean |
Whether rules with lower priority are applied before this rule. |
Returns
any
If no value is set, returns whether the rules with lower priority are not applied before this rule; otherwise, returns the condition rule.
Inherited from
style
▸ style(value?): any
Gets or sets the style for the rule.
example
//This example applies multiple rules.
activeSheet.setArray(0,0,[1,2,3,4,5,6,7,8,9,10]);
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.foreColor = "black";
var cell = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
cell.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
cell.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.greaterThan);
cell.value1(5);
cell.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
cell.style(style);
activeSheet.conditionalFormats.addRule(cell);
var style1 = new GC.Spread.Sheets.Style();
style1.foreColor = "red";
var top = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
top.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.top10Rule);
top.type(GC.Spread.Sheets.ConditionalFormatting.Top10ConditionType.top);
top.rank(3);
top.style(style1);
top.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
top.stopIfTrue(true);
activeSheet.conditionalFormats.addRule(top);
Parameters
| Name | Type | Description |
|---|---|---|
value? |
Style |
The style for the rule. |
Returns
any
If no value is set, returns the style for the rule; otherwise, returns the condition rule.