GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule

クラス: NormalConditionRule

Sheets.ConditionalFormatting.NormalConditionRule

Hierarchy

ConditionRuleBase

↳ NormalConditionRule

コンストラクタ

constructor

メソッド

コンストラクタ

constructor

• new NormalConditionRule(ruleType, ranges, style, operator, value1, value2, text, formula, type, rank)

通常の条件ルールを表します。

実例

activeSheet.setArray(0,0,[1,2,3,4,5,6,7,8,9,10]);
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)]);
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
cell.style(style);
activeSheet.conditionalFormats.addRule(cell);
// ボタン
$("#button1").click(function () {
     cell.reset();
     activeSheet.suspendPaint();
     activeSheet.resumePaint();
});

パラメータ

名前	型	説明
`ruleType`	`RuleType`
`ranges`	`Range`[]	ルールが適用されるセル範囲。配列要素の型はGC.Spread.Sheets.Rangeです。
`style`	`Style`	条件が満たされた場合にセルに適用されるスタイル。
`operator`	`LogicalOperators` \| `ComparisonOperators` \| `TextComparisonOperators`	比較演算子。
`value1`	`Object`	最初の値。
`value2`	`Object`	２番目の値。
`text`	`string`	比較用の文字列。
`formula`	`string`	条件数式。
`type`	`AverageConditionType` \| `DateOccurringType` \| `Top10ConditionType`	平均との比較条件タイプ。
`rank`	`number`	スタイルを適用する上位または下位項目の数。

Overrides

ConditionRuleBase.constructor

メソッド

condition

▸ condition(value?): any

ルールのベース条件を取得または設定します。

パラメータ

名前	型	説明
`value?`	`Condition`	ルールのベース条件。

戻り値

any

値が設定されていない場合は、ルールのベース条件を返します。値が設定されている場合は、条件ルールを返します。

Inherited from

ConditionRuleBase.condition

contains

▸ contains(row, column): boolean

セル範囲に指定した行と列のセルが含まれているかどうかを判定します。

パラメータ

名前	型	説明
`row`	`number`	行インデックス。
`column`	`number`	列インデックス。

戻り値

boolean

指定した行と列にあるセルがセル範囲に含まれている場合はtrue、それ以外の場合はfalse。

Inherited from

ConditionRuleBase.contains

createCondition

▸ createCondition(): Condition

ルールの条件を作成します。

戻り値

Condition

条件。

Overrides

ConditionRuleBase.createCondition

evaluate

▸ evaluate(evaluator, baseRow, baseColumn, actual): Style

セルが条件を満たす場合、ルールのセルスタイルを返します。

パラメータ

名前	型	説明
`evaluator`	`Object`	条件を評価できるオブジェクト。
`baseRow`	`number`	行インデックス。
`baseColumn`	`number`	列インデックス。
`actual`	`Object`	実際の値。

戻り値

Style

ルールのセルスタイル。

Inherited from

ConditionRuleBase.evaluate

formula

▸ formula(formulaOrBaseRow?, baseColumn?): any

条件数式を取得または設定します。

実例

// 次のサンプルコードは、formulaメソッドを使用します。
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.formulaRule);
rule.formula("=A1=B1+C1");
rule.ranges([new GC.Spread.Sheets.Range(0, 0, 2, 1)]);
rule.style(style);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0, 0, 2.3);
activeSheet.setValue(0, 1, 1.3);
activeSheet.setValue(0, 2,1,3);
activeSheet.setValue(1, 0, 1.3);
var formulaOfTheTopLeftCell = rule.formula();
var formulaOfA1 = rule.formula(0, 0);
var formulaOfA2 = rule.formula(1, 0);

パラメータ

名前	型	説明
`formulaOrBaseRow?`	`string` \| `number`	条件数式または基本行。
`baseColumn?`	`number`	基本列。

戻り値

any

値が設定されていない場合、またはbaseRowとbaseColumnが設定されている場合は、条件数式を返します。それ以外の場合は、数値条件ルールを返します。

getExpected

▸ getExpected(): Style

ベースルールのスタイルを取得します。

戻り値

Style

Inherited from

ConditionRuleBase.getExpected

intersects

▸ intersects(row, column, rowCount, columnCount): boolean

このルールの範囲が別の範囲と交差するかどうかを指定します。

パラメータ

名前	型	説明
`row`	`number`	行インデックス。
`column`	`number`	列インデックス。
`rowCount`	`number`	行数。
`columnCount`	`number`	列数。

戻り値

boolean

このルールの範囲が別の範囲と交差する場合はtrue、それ以外の場合はfalse。

Inherited from

ConditionRuleBase.intersects

isScaleRule

▸ isScaleRule(): boolean

このルールがスケールルールかどうかを指定します。

戻り値

boolean

このルールがスケールルールである場合はtrue、それ以外の場合はfalse。

Inherited from

ConditionRuleBase.isScaleRule

operator

▸ operator(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?`	`ComparisonOperators`	比較演算子。

戻り値

any

値が設定されていない場合は、比較演算子を返します。値が設定されている場合は、数値条件ルールを返します。

priority

▸ priority(value?): any

ルールの優先度を取得または設定します。

パラメータ

名前	型	説明
`value?`	`number`	ルールの優先度。

戻り値

any

値が設定されていない場合は、ルールの優先度を返します。値が設定されている場合は、条件ルールを返します。

Inherited from

ConditionRuleBase.priority

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

値が設定されていない場合は、条件ルールの範囲を返します。値が設定されている場合は、条件ルールを返します。

Inherited from

ConditionRuleBase.ranges

rank

▸ rank(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?`	`number`	スタイルを適用する上位または下位項目の数。

戻り値

any

値が設定されていない場合は、スタイルを適用する上位または下位項目の数を返します。値が設定されている場合は、数値条件ルールを返します。

reset

▸ reset(): void

ルールをリセットします。

実例

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);
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.averageRule);
rule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
rule.style(style);
rule.type(GC.Spread.Sheets.ConditionalFormatting.AverageConditionType.above);
activeSheet.conditionalFormats.addRule(rule);
rule.reset();

戻り値

void

Overrides

ConditionRuleBase.reset

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

値が設定されていない場合は、条件ルールのタイプを返します。値が設定されている場合は、条件ルールを返します。

Inherited from

ConditionRuleBase.ruleType

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

値が設定されていない場合は、より優先度の低いルールがこのルールの前に適用されるかどうかを返します。値が設定されている場合は、条件ルールを返します。

Inherited from

ConditionRuleBase.stopIfTrue

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

値が設定されていない場合は、ルールのスタイルを返します。値が設定されている場合は、条件ルールを返します。

Inherited from

ConditionRuleBase.style

text

▸ text(value?): any

比較用の文字列を取得または設定します。

実例

// 次のサンプルコードは、ルールを作成します。
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.specificTextRule);
rule.style(style);
rule.text("test");
rule.operator(GC.Spread.Sheets.ConditionalFormatting.TextComparisonOperators.contains);
rule.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0, 0, "testing");
activeSheet.setValue(1, 0, "test");
activeSheet.setValue(2, 0, "a");
activeSheet.setValue(3, 0, "t");

パラメータ

名前	型	説明
`value?`	`string`	比較用の文字列。

戻り値

any

値が設定されていない場合は、比較用の文字列を返します。値が設定されている場合は、数値条件ルールを返します。

type

▸ type(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?`	`AverageConditionType`	平均との比較条件タイプ。

戻り値

any

値が設定されていない場合は、平均との比較条件タイプを返します。値が設定されている場合は、数値条件ルールを返します。

value1

▸ value1(valueOrBaseRow?, baseColumn?): any

最初の値を取得または設定します。

実例

// 次のサンプルコードは、複数のルールを作成します。
activeSheet.setArray(0,0,[[1,10],[2,9], [3,8],[4,7],[5,6],[6,5],[7,4],[8,3],[9,2],[10,1]]);
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("=B1");
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);
var formulaOfTheTopLeftCell = cell.value1();
var formulaOfA5 = cell.value1(4, 0);
var formulaOfA10 = cell.value1(9, 0);

パラメータ

名前	型	説明
`valueOrBaseRow?`	`any`	最初の値または基本行。
`baseColumn?`	`number`	基本列。

戻り値

any

値が設定されていない場合、またはbaseRowとbaseColumnが設定されている場合は、最初の値を返します。それ以外の場合は、数値条件ルールを返します。

value2

▸ value2(valueOrBaseRow?, baseColumn?): any

最初の値を取得または設定します。

実例

// 次のサンプルコードは、value2メソッドを使用します。
activeSheet.setArray(0,0,[1,2,3,4,5,6,7,8,9,10]);
var cell = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
cell.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
cell.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
cell.value1(5);
cell.value2(7);
cell.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
style.foreColor = "black";
cell.style(style);
activeSheet.conditionalFormats.addRule(cell);

パラメータ

名前	型	説明
`valueOrBaseRow?`	`any`	最初の値または基本行。
`baseColumn?`	`number`	基本列。

戻り値

any

値が設定されていない場合、またはbaseRowとbaseColumnが設定されている場合は、最初の値を返します。それ以外の場合は、数値条件ルールを返します。

GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule

クラス: NormalConditionRule

Hierarchy

Table of contents

コンストラクタ

メソッド

コンストラクタ

constructor

パラメータ

Overrides

メソッド

condition

パラメータ

戻り値

Inherited from

contains

パラメータ

戻り値

Inherited from

createCondition

戻り値

Overrides

evaluate

パラメータ

戻り値

Inherited from

formula

パラメータ

戻り値

getExpected

戻り値

Inherited from

intersects

パラメータ

戻り値

Inherited from

isScaleRule

戻り値

Inherited from

operator

パラメータ

戻り値

priority

パラメータ

戻り値

Inherited from

ranges

パラメータ

戻り値

Inherited from

rank

パラメータ

戻り値

reset

戻り値

Overrides

ruleType

パラメータ

戻り値

Inherited from

stopIfTrue

パラメータ

戻り値

Inherited from

style

パラメータ

戻り値

Inherited from

text

パラメータ

戻り値

type

パラメータ

戻り値

value1

パラメータ

戻り値

value2

パラメータ

戻り値