GC.Spread.Sheets.ConditionalFormatting.StateRule

クラス: StateRule

Sheets.ConditionalFormatting.StateRule

Hierarchy

ConditionRuleBase

↳ StateRule

コンストラクタ

constructor

メソッド

コンストラクタ

constructor

• new StateRule(ruleType, state, style?, ranges?)

状態のルールを表します。

実例

// シート全体に赤と黒の色の行状態ルールを追加します。
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);
// 異なる範囲に 2 つのスタイルを持つ行状態ルールを追加します。
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)]
);

パラメータ

名前	型	説明
`ruleType`	`RuleType`	状態ルールの種類は、GC.Spread.Sheets.ConditionalFormatting.RuleType.rowStateRuleまたはGC.Spread.Sheets.ConditionalFormatting.RuleType.columnStateRuleになります。
`state`	`RowColumnStates`	状態。
`style?`	`Style` \| `Style`[]	状態が満たされた場合にセルに適用されるスタイル。スタイルの配列である可能性があります。
`ranges?`	`Range`[]	ルールが適用されるセル範囲。配列要素の型はGC.Spread.Sheets.Rangeです。

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

条件。

Inherited from

ConditionRuleBase.createCondition

evaluate

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

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

パラメータ

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

戻り値

Style

ルールのセルスタイル。

Inherited from

ConditionRuleBase.evaluate

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

isRow

▸ isRow(): boolean

この状態ルールが行方向に適用されるかどうかを取得します。

戻り値

boolean

この状態ルールが行方向に適用されるかどうか、そうでない場合は列方向に適用されます。

isScaleRule

▸ isScaleRule(): boolean

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

戻り値

boolean

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

Inherited from

ConditionRuleBase.isScaleRule

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

reset

▸ reset(): void

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

戻り値

void

Inherited from

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

state

▸ state(value?): RowColumnStates

状態ルールを取得または設定します。

パラメータ

名前	型	説明
`value?`	`RowColumnStates`	状態。

戻り値

RowColumnStates

ルールの状態。

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

GC.Spread.Sheets.ConditionalFormatting.StateRule

クラス: StateRule

Hierarchy

Table of contents

コンストラクタ

メソッド

コンストラクタ

constructor

パラメータ

Overrides

メソッド

condition

パラメータ

戻り値

Inherited from

contains

パラメータ

戻り値

Inherited from

createCondition

戻り値

Inherited from

evaluate

パラメータ

戻り値

Inherited from

getExpected

戻り値

Inherited from

intersects

パラメータ

戻り値

Inherited from

isRow

戻り値

isScaleRule

戻り値

Inherited from

priority

パラメータ

戻り値

Inherited from

ranges

パラメータ

戻り値

Inherited from

reset

戻り値

Inherited from

ruleType

パラメータ

戻り値

Inherited from

state

パラメータ

戻り値

stopIfTrue

パラメータ

戻り値

Inherited from

style

パラメータ

戻り値

Inherited from