GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase

クラス: ConditionRuleBase

Sheets.ConditionalFormatting.ConditionRuleBase

階層

ConditionRuleBase

↳ NormalConditionRule

↳ ScaleRule

↳ StateRule

コンストラクタ

constructor

メソッド

コンストラクタ

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

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

戻り値

Condition

条件。

evaluate

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

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

パラメータ

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

戻り値

Style

ルールのセルスタイル。

getExpected

▸ getExpected(): Style

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

実例

 // 次のサンプルコードは、getExpected メソッドを使用します。
 activeSheet.suspendPaint();
 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);
 var data = [50, 50, 11, 5, 3, 6, 7, 8, 7, 11];
 var condition = activeSheet.conditionalFormats.getRules()[0];
 for (var i = 0; i < 10;i++){
     activeSheet.setValue(i, 0, data[i]);
 }
 activeSheet.resumePaint();
 console.log(condition.getExpected());

戻り値

Style

intersects

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

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

実例

 // 次のサンプルコードは、intersects メソッドを使用します。
 activeSheet.suspendPaint();
 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);
 var data = [50, 50, 11, 5, 3, 6, 7, 8, 7, 11];
 var condition = activeSheet.conditionalFormats.getRules()[0];
 for (var i = 0; i < 10; i++) {
     activeSheet.setValue(i, 0, data[i]);
 }
 activeSheet.resumePaint();
 activeSheet.bind(GC.Spread.Sheets.Events.SelectionChanged, function(e, info) {
     var selection = info.newSelections[0];
     var result = condition.intersects(selection.row, selection.col, selection.rowCount, selection.colCount);
     if (result) {
         alert("current selection is intersects with condition formatting range");
     } else {
         alert("current selection is not intersects with condition formatting range");
     }
 });

パラメータ

名前	型	説明
`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

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

実例

 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(2);
 cell.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 1)]);
 cell.style(style);
 activeSheet.conditionalFormats.addRule(cell);
 var style = new GC.Spread.Sheets.Style();
 style.cellButtons = [{
     caption: "Reset",
     useButtonStyle: true,
     width: 60,
     command: function(sheet) {
         cell.reset();
         sheet.resumePaint();
     }
 }];
 activeSheet.setStyle(16, 4, style);

戻り値

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

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

GC.Spread.Sheets.ConditionalFormatting.ConditionRuleBase

クラス: ConditionRuleBase

階層

Table of contents

コンストラクタ

メソッド

コンストラクタ

constructor

パラメータ

メソッド

condition

パラメータ

戻り値

contains

パラメータ

戻り値

createCondition

戻り値

evaluate

パラメータ

戻り値

getExpected

戻り値

intersects

パラメータ

戻り値

isScaleRule

戻り値

priority

パラメータ

戻り値

ranges

パラメータ

戻り値

reset

戻り値

ruleType

パラメータ

戻り値

stopIfTrue

パラメータ

戻り値

style

パラメータ

戻り値