クラス: DataBarRule

Sheets.ConditionalFormatting.DataBarRule

Hierarchy

• ScaleRule

  ↳ DataBarRule

Table of contents

コンストラクタ

• constructor

メソッド

• axisColor
• axisPosition
• borderColor
• color
• condition
• contains
• createCondition
• dataBarDirection
• evaluate
• getExpected
• gradient
• intersects
• isScaleRule
• maxColor
• maxType
• maxValue
• midColor
• midType
• midValue
• minColor
• minType
• minValue
• negativeBorderColor
• negativeFillColor
• priority
• ranges
• reset
• ruleType
• showBarOnly
• showBorder
• stopIfTrue
• style
• useNegativeBorderColor
• useNegativeFillColor

コンストラクタ

constructor

• new DataBarRule(minType, minValue, maxType, maxValue, color, ranges)

指定されたパラメーターを持つデータバー条件ルールを表します。

実例

//次のサンプルコードは、データバールールを作成します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number, -1, GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number, 40, "green", [new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
minType	ScaleValueType	最小スケールのタイプ。
minValue	string | number	最小スケールの値。
maxType	ScaleValueType	最大スケールのタイプ。
maxValue	string | number	最大スケールの値。
color	string	データバーの塗りつぶし色。
ranges	Range[]	データバールールの対象範囲。

Overrides

ScaleRule.constructor

メソッド

axisColor

▸ axisColor(value?): any

データバーの軸の色を取得または設定します。

実例

// 次のサンプルコードは、axisColorメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
 // ルール
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	string	データバーの軸の色。

戻り値

any

値が設定されていない場合は、データバーの軸の色を返します。値が設定されている場合は、データバールールを返します。

---

axisPosition

▸ axisPosition(value?): any

データバーの軸の位置を取得または設定します。

実例

// 次のサンプルコードは、axisPositionメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
 // ルール
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	DataBarAxisPosition	データバーの軸の位置。

戻り値

any

値が設定されていない場合は、データバーの軸の位置を返します。値が設定されている場合は、データバールールを返します。

---

borderColor

▸ borderColor(value?): any

境界線の色を取得または設定します。

実例

// 次のサンプルコードは、borderColorメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
 // ルール
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	string	枠線の色。

戻り値

any

値が設定されていない場合は、境界線の色を返します。値が設定されている場合は、データバールールを返します。

---

color

▸ color(value?): any

データバーの正の塗りつぶし色を取得または設定します。

実例

// 次のサンプルコードは、colorメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
 // ルール
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	string	塗りつぶし色。

戻り値

any

値が設定されていない場合は、データバーの正の塗りつぶし色を返します。 それ以外の場合は、データバールールを返します。

---

condition

▸ condition(value?): any

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

パラメータ

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

戻り値

any

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

Inherited from

ScaleRule.condition

---

contains

▸ contains(row, column): boolean

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

パラメータ

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

戻り値

boolean

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

Inherited from

ScaleRule.contains

---

createCondition

▸ createCondition(): Condition

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

戻り値

Condition

条件。

Inherited from

ScaleRule.createCondition

---

dataBarDirection

▸ dataBarDirection(value?): any

データバーの方向を取得または設定します。

実例

// 次のサンプルコードは、dataBarDirectionメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
 // ルール
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	BarDirection	データバーの方向。

戻り値

any

値が設定されていない場合は、データバーの方向を返します。値が設定されている場合は、データバールールを返します。

---

evaluate

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

セルが条件を満たす場合、ルールの指定された値を返します。

パラメータ

名前	型	説明
evaluator	Object	エバリュエーター。
baseRow	number	行インデックス。
baseColumn	number	列インデックス。
actual	Object	現在の値。

戻り値

any

セルが条件を満たす場合、ルールの指定された値。

Overrides

ScaleRule.evaluate

---

getExpected

▸ getExpected(): Style

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

戻り値

Style

Inherited from

ScaleRule.getExpected

---

gradient

▸ gradient(value?): any

データバーがグラデーションかどうかを示す値を取得または設定します。

実例

// 次のサンプルコードは、gradientメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
dataBarRule.gradient(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	boolean	データバーがグラデーションかどうか。

戻り値

any

値が設定されていない場合は、データバーがグラデーションかどうかを示す値を返します。値が設定されている場合は、データバールールを返します。

---

intersects

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

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

パラメータ

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

戻り値

boolean

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

Inherited from

ScaleRule.intersects

---

isScaleRule

▸ isScaleRule(): boolean

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

戻り値

boolean

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

Inherited from

ScaleRule.isScaleRule

---

maxColor

▸ maxColor(value?): any

最大スケールの色を取得または設定します。

実例

var rule = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
rule.ranges([new GC.Spread.Sheets.Range(0,0,10,3)]);
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.twoScaleRule);
rule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
rule.minValue(10);
rule.minColor("Yellow");
rule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
rule.maxValue(100);
rule.maxColor("Blue");
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);

パラメータ

名前	型	説明
value?	string	最大スケールの色。

戻り値

any

値が設定されていない場合は、最大スケールの色を返します。値が設定されている場合は、スケールルールを返します。

Inherited from

ScaleRule.maxColor

---

maxType

▸ maxType(value?): any

最大スケールのタイプを取得または設定します。

実例

var scale = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
scale.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.threeScaleRule);
scale.midColor("red");
scale.midType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.midValue(50);
scale.maxColor("blue");
scale.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.maxValue(100);
scale.minColor("yellow");
scale.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.minValue(10);
scale.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
activeSheet.conditionalFormats.addRule(scale);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);

パラメータ

名前	型	説明
value?	ScaleValueType	最大スケールのタイプ。

戻り値

any

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

Inherited from

ScaleRule.maxType

---

maxValue

▸ maxValue(value?): any

最大スケールの値を取得または設定します。

実例

var scale = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
scale.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.twoScaleRule);
scale.maxColor("blue");
scale.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.maxValue(100);
scale.minColor("yellow");
scale.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.minValue(10);
scale.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
activeSheet.conditionalFormats.addRule(scale);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);
alert("Color: " + scale.maxColor() + " Type: " + scale.maxType() + " Value: " + scale.maxValue());

パラメータ

名前	型	説明
value?	number	最大スケールの値。

戻り値

any

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

Inherited from

ScaleRule.maxValue

---

midColor

▸ midColor(value?): any

中間スケールの色を取得または設定します。

実例

var scale = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
scale.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.threeScaleRule);
scale.midColor("red");
scale.midType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.midValue(50);
scale.maxColor("blue");
scale.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.maxValue(100);
scale.minColor("yellow");
scale.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.minValue(10);
scale.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
activeSheet.conditionalFormats.addRule(scale);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);

パラメータ

名前	型	説明
value?	string	中間スケールの色。

戻り値

any

値が設定されていない場合は、中間スケールの色を返します。値が設定されている場合は、スケールルールを返します。

Inherited from

ScaleRule.midColor

---

midType

▸ midType(value?): any

中間スケールのタイプを取得または設定します。

実例

var scale = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
scale.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.threeScaleRule);
scale.midColor("red");
scale.midType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.midValue(50);
scale.maxColor("blue");
scale.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.maxValue(100);
scale.minColor("yellow");
scale.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.minValue(10);
scale.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
activeSheet.conditionalFormats.addRule(scale);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);

パラメータ

名前	型	説明
value?	ScaleValueType	中間スケールのタイプ。

戻り値

any

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

Inherited from

ScaleRule.midType

---

midValue

▸ midValue(value?): any

中間スケールの値を取得または設定します。

実例

var scale = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
scale.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.threeScaleRule);
scale.midColor("red");
scale.midType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.midValue(50);
scale.maxColor("blue");
scale.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.maxValue(100);
scale.minColor("yellow");
scale.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
scale.minValue(10);
scale.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
activeSheet.conditionalFormats.addRule(scale);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);

パラメータ

名前	型	説明
value?	number	中間スケールの値。

戻り値

any

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

Inherited from

ScaleRule.midValue

---

minColor

▸ minColor(value?): any

最小スケールの色を取得または設定します。

実例

var rule = new GC.Spread.Sheets.ConditionalFormatting.ScaleRule();
rule.ranges([new GC.Spread.Sheets.Range(0,0,10,3)]);
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.twoScaleRule);
rule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
rule.minValue(10);
rule.minColor("Yellow");
rule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
rule.maxValue(100);
rule.maxColor("Blue");
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0, 1,3);
activeSheet.setValue(1,0, 50,3);
activeSheet.setValue(2,0, 100,3);

パラメータ

名前	型	説明
value?	string	最小スケールの色。

戻り値

any

値が設定されていない場合は、最小スケールの色を返します。値が設定されている場合は、スケールルールを返します。

Inherited from

ScaleRule.minColor

---

minType

▸ minType(value?): any

最小スケールのタイプを取得または設定します。

実例

activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	ScaleValueType	最小スケールのタイプ。

戻り値

any

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

Inherited from

ScaleRule.minType

---

minValue

▸ minValue(value?): any

最小スケールの値を取得または設定します。

実例

activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	number	最小スケールの値。

戻り値

any

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

Inherited from

ScaleRule.minValue

---

negativeBorderColor

▸ negativeBorderColor(value?): any

負数の境界線色を取得または設定します。

実例

// 次のサンプルコードは、negativeBorderColorメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	string	負数の境界線色。

戻り値

any

値が設定されていない場合は、負数の境界線色を返します。値が設定されている場合は、データバールールを返します。

---

negativeFillColor

▸ negativeFillColor(value?): any

負数の塗りつぶし色を取得または設定します。

実例

// 次のサンプルコードは、negativeFillColorメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	string	負数の塗りつぶし色。

戻り値

any

値が設定されていない場合は、負数の塗りつぶし色を返します。値が設定されている場合は、データバールールを返します。

---

priority

▸ priority(value?): any

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

パラメータ

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

戻り値

any

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

Inherited from

ScaleRule.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

ScaleRule.ranges

---

reset

▸ reset(): void

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

戻り値

void

Inherited from

ScaleRule.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

ScaleRule.ruleType

---

showBarOnly

▸ showBarOnly(value?): any

データバーをテキストなしで表示するかどうかを取得または設定します。

実例

// 次のサンプルコードは、showBarOnlyメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	boolean	データバーをテキストなしで表示するかどうか。

戻り値

any

値が設定されていない場合は、ウィジェットがデータバーをテキストなしで表示するかどうかを返します。値が設定されている場合は、データバールールを返します。

---

showBorder

▸ showBorder(value?): any

境界線を描画するかどうかを示す値を取得または設定します。

実例

// 次のサンプルコードは、showBorderメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	boolean	境界線を描画するかどうか。

戻り値

any

値が設定されていない場合は、境界線を描画するかどうかを示す値を返します。値が設定されている場合は、データバールールを返します。

---

stopIfTrue

▸ stopIfTrue(value?): boolean

条件がtrueに評価された場合に評価を終了するかどうかを取得します。

パラメータ

名前	型
value?	boolean

戻り値

boolean

Inherited from

ScaleRule.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

ScaleRule.style

---

useNegativeBorderColor

▸ useNegativeBorderColor(value?): any

負数の枠線を描画するために負の枠線の色が使用されるかどうかを示す値を取得または設定します。

実例

// 次のサンプルコードは、useNegativeBorderColorメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	boolean	負数の境界線を描画するために負数の境界線色を使用するかどうか。

戻り値

any

値が設定されていない場合は、負数の境界線を描画するために負数の境界線色を使用するかどうかを示す値を返します。値が設定されている場合は、データバールールを返します。

---

useNegativeFillColor

▸ useNegativeFillColor(value?): any

負数を描画するために負の塗りつぶしの色が使用されるかどうかを示す値を取得または設定します。

実例

// 次のサンプルコードは、useNegativeFillColorメソッドを使用します。
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,15,3);
activeSheet.setValue(2,0,25,3);
activeSheet.setValue(3,0,-1,3);
var dataBarRule = new GC.Spread.Sheets.ConditionalFormatting.DataBarRule();
dataBarRule.ranges([new GC.Spread.Sheets.Range(0,0,4,1)]);
dataBarRule.minType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.minValue(-1);
dataBarRule.maxType(GC.Spread.Sheets.ConditionalFormatting.ScaleValueType.number);
dataBarRule.maxValue(40);
dataBarRule.color("green");
dataBarRule.showBorder(true);
dataBarRule.borderColor("orange");
dataBarRule.dataBarDirection(GC.Spread.Sheets.ConditionalFormatting.BarDirection.leftToRight);
dataBarRule.negativeFillColor("yellow");
dataBarRule.useNegativeFillColor(true);
dataBarRule.negativeBorderColor("red");
dataBarRule.useNegativeBorderColor(true);
dataBarRule.axisPosition(GC.Spread.Sheets.ConditionalFormatting.DataBarAxisPosition.automatic);
dataBarRule.axisColor("blue");
dataBarRule.showBarOnly(false);
activeSheet.conditionalFormats.addRule(dataBarRule);

パラメータ

名前	型	説明
value?	boolean	負数を描画するために負数の塗りつぶし色を使用するかどうか。

戻り値

any

値が設定されていない場合は、負数を描画するために負数の塗りつぶし色を使用するかどうかを示す値を返します。値が設定されている場合は、データバールールを返します。