- 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.IO
- GC.Spread.Sheets.AutoMerge
- GC.Spread.Sheets.Barcode
- GC.Spread.Sheets.Bindings
- GC.Spread.Sheets.CalcEngine
- GC.Spread.Sheets.Search
- 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.FormulaPanel
- GC.Spread.Sheets.Hyperlink
- GC.Spread.Sheets.InputMask
- GC.Spread.Sheets.NameBox
- GC.Spread.Sheets.OutlineColumn
- GC.Spread.Sheets.Outlines
- GC.Spread.Sheets.PDF
- GC.Spread.Sheets.Print
- 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.IO
GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase
クラス: ConditionRuleBase
Sheets.ConditionalFormatting.ConditionRuleBase
Hierarchy
ConditionRuleBase
Table of contents
コンストラクタ
メソッド
- condition
- contains
- createCondition
- evaluate
- getExpected
- intersects
- isScaleRule
- priority
- ranges
- reset
- ruleType
- stopIfTrue
- style
コンストラクタ
constructor
• new ConditionRuleBase(ruleType, style, ranges)
指定されたスタイルで書式設定するベースルールクラスを表します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
ruleType |
RuleType |
|
style |
Style |
ルールのスタイル。 |
ranges |
Range[] |
範囲の配列。 |
メソッド
condition
▸ condition(value?): any
ルールのベース条件を取得または設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Condition |
ルールのベース条件。 |
戻り値
any
値が設定されていない場合は、ルールのベース条件を返します。値が設定されている場合は、条件ルールを返します。
contains
▸ contains(row, column): boolean
セル範囲に指定した行と列のセルが含まれているかどうかを判定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
row |
number |
行インデックス。 |
column |
number |
列インデックス。 |
戻り値
boolean
指定した行と列にあるセルがセル範囲に含まれている場合はtrue、それ以外の場合はfalse。
createCondition
▸ createCondition(): Condition
ルールの条件を作成します。
戻り値
条件。
evaluate
▸ evaluate(evaluator, baseRow, baseColumn, actual): Style
セルが条件を満たす場合、ルールのセルスタイルを返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
evaluator |
Object |
条件を評価できるオブジェクト。 |
baseRow |
number |
行インデックス。 |
baseColumn |
number |
列インデックス。 |
actual |
Object |
実際の値。 |
戻り値
ルールのセルスタイル。
getExpected
▸ getExpected(): Style
ベースルールのスタイルを取得します。
戻り値
intersects
▸ intersects(row, column, rowCount, columnCount): boolean
このルールの範囲が別の範囲と交差するかどうかを指定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
row |
number |
行インデックス。 |
column |
number |
列インデックス。 |
rowCount |
number |
行数。 |
columnCount |
number |
列数。 |
戻り値
boolean
このルールの範囲が別の範囲と交差する場合はtrue、それ以外の場合はfalse。
isScaleRule
▸ isScaleRule(): boolean
このルールがスケールルールかどうかを指定します。
戻り値
boolean
このルールがスケールルールである場合はtrue、それ以外の場合はfalse。
priority
▸ priority(value?): any
ルールの優先度を取得または設定します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
number |
ルールの優先度。 |
戻り値
any
値が設定されていない場合は、ルールの優先度を返します。値が設定されている場合は、条件ルールを返します。
ranges
▸ ranges(value?): any
条件ルールの範囲を取得または設定します。
実例
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);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Range[] |
条件ルールの範囲。 |
戻り値
any
値が設定されていない場合は、条件ルールの範囲を返します。値が設定されている場合は、条件ルールを返します。
reset
▸ reset(): void
ルールをリセットします。
戻り値
void
ruleType
▸ ruleType(value?): any
条件ルールのタイプを取得または設定します。
実例
// 次のサンプルコードは、ruleTypeメソッドを使用します。
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);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
RuleType |
条件ルールのタイプ。 |
戻り値
any
値が設定されていない場合は、条件ルールのタイプを返します。値が設定されている場合は、条件ルールを返します。
stopIfTrue
▸ stopIfTrue(value?): any
より優先度の低いルールがこのルールの前に適用されるかどうかを取得または設定します。
実例
// 次のサンプルコードは、複数のルールを適用します。
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);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
より優先度の低いルールがこのルールの前に適用されるかどうか。 |
戻り値
any
値が設定されていない場合は、より優先度の低いルールがこのルールの前に適用されるかどうかを返します。値が設定されている場合は、条件ルールを返します。
style
▸ style(value?): any
ルールのスタイルを取得または設定します。
実例
// 次のサンプルコードは、複数のルールを適用します。
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);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Style |
ルールのスタイル。 |
戻り値
any
値が設定されていない場合は、ルールのスタイルを返します。値が設定されている場合は、条件ルールを返します。