- 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.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.Condition
クラス: Condition
Sheets.ConditionalFormatting.Condition
Table of contents
コンストラクタ
メソッド
- compareType
- evaluate
- expected
- formula
- getExpected
- getValidList
- ignoreBlank
- ignoreCase
- item1
- item2
- preciseCompareDate
- ranges
- reset
- treatNullValueAsZero
- useWildCards
- fromDay
- fromFormula
- fromMonth
- fromQuarter
- fromSource
- fromWeek
- fromYear
コンストラクタ
constructor
• new Condition(conditionType, args)
パラメーターオブジェクトを使用する条件項目を表します。
実例
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.averageCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.AverageConditionType.above});
nCondition.ranges([new GC.Spread.Sheets.Range(0, 0, 10, 3)]);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, 5);
activeSheet.setValue(1, 0, 15);
パラメータ
| 名前 | 型 |
|---|---|
conditionType |
ConditionType |
args |
Object |
メソッド
compareType
▸ compareType(value?): any
ルール比較タイプを取得または設定します。
実例
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.TextCompareType.contains);
nCondition.expected("test");
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, "testing");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
LogicalOperators | GeneralComparisonOperators | TextCompareType | ColorCompareType | DateCompareType |
ルール比較タイプ。 |
戻り値
any
値が設定されていない場合は、ルール比較タイプを返します。値が設定されている場合は、条件を返します。
evaluate
▸ evaluate(evaluator, baseRow, baseColumn, actualObj): boolean
指定したエバリュエーターを使用して条件を評価します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
evaluator |
Object |
式または関数を評価できるエバリュエーター。 |
baseRow |
number |
評価に使用する基本行インデックス。 |
baseColumn |
number |
評価に使用する基本列インデックス。 |
actualObj |
Object |
評価に使用するobject1の実際の値。 |
戻り値
boolean
結果が成功した場合はtrue、それ以外の場合はfalseを返します。
expected
▸ expected(value?): any
期待される値を取得または設定します。
実例
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.dateCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.DateCompareType.before);
nCondition.expected(new Date(2012, 11, 31));
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, new Date(2012, 12, 12));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
any |
期待される値。 |
戻り値
any
値が設定されていない場合は、期待される値を返します。値が設定されている場合は、条件を返します。
formula
▸ formula(formulaOrBaseRow?, baseColumn?): any
期待される数式を取得または設定します。
実例
var textLengthCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textLengthCondition);
textLengthCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.greaterThan);
textLengthCondition.formula("$C$1"); // 数値の計算に使用する数式。
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(textLengthCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, "abcf");
// $C$1に値3を設定します。このコードの後、セル(0,0)の値は有効になります。
activeSheet.setValue(0, 2, 3);
// $C$1に値5を設定します。このコードの後、セル(0,0)の値は無効になります。
// activeSheet.setValue(0, 2, 5);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
formulaOrBaseRow? |
string | number |
期待される数式または基本行。 |
baseColumn? |
number |
基本列。 |
戻り値
any
値が設定されていない場合、またはbaseRowとbaseColumnが設定されている場合は、期待される数式を返します。それ以外の場合は、条件を返します。
getExpected
▸ getExpected(evaluator, baseRow, baseColumn): Object
期待される値を取得します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
evaluator |
Object |
式または関数を評価できるエバリュエーター。 |
baseRow |
number |
評価に使用する基本行インデックス。 |
baseColumn |
number |
評価に使用する基本列インデックス。 |
戻り値
Object
期待される値。
getValidList
▸ getValidList(evaluator, baseRow, baseColumn): any[]
有効なデータ項目のリストを返します。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
evaluator |
Object |
式または関数を評価できるエバリュエーター。 |
baseRow |
number |
評価に使用する基本行インデックス。 |
baseColumn |
number |
評価に使用する基本列インデックス。 |
戻り値
any[]
有効なデータ項目のリスト。
ignoreBlank
▸ ignoreBlank(value?): any
空白セルを無視するかどうかを取得または設定します。
実例
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.TextCompareType.contains);
nCondition.expected("te?t");
nCondition.ignoreBlank(true);
nCondition.ignoreCase(true);
nCondition.useWildCards(true);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, "testing");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
空白セルを無視するかどうか。 |
戻り値
any
値が設定されていない場合は、空白セルを無視するかどうかを返します。値が設定されている場合は、条件を返します。
ignoreCase
▸ ignoreCase(value?): any
比較の実行時に大文字と小文字の違いを無視するかどうかを取得または設定します。
実例
// 次のサンプルコードは、テキスト条件を作成します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.TextCompareType.contains);
nCondition.expected("te?t");
nCondition.ignoreBlank(true);
nCondition.ignoreCase(true);
nCondition.useWildCards(true);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, "testing");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
比較の実行時に大文字と小文字の違いを無視するかどうか。 |
戻り値
any
値が設定されていない場合は、比較の実行時に大文字と小文字の違いを無視するかどうかを返します。値が設定されている場合は、条件を返します。
item1
▸ item1(value?): Condition
最初の条件を取得または設定します。
実例
// 次のサンプルコードは、日付を検証します。
var condition1 = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.dateCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.DateCompareType.afterEqualsTo, expected: new Date(2012, 11, 31)});
var condition2 = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.dateCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.DateCompareType.beforeEqualsTo, expected: new Date(2013, 11, 31)});
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.relationCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.LogicalOperators.and);
nCondition.item1(condition1);
nCondition.item2(condition2);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, new Date(2012, 11, 25));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Condition |
最初の条件。 |
戻り値
値が設定されていない場合は、最初の条件を返します。値が設定されている場合は、関係条件を返します。
item2
▸ item2(value?): Condition
2番目の条件を取得または設定します。
実例
// 次のサンプルコードは、日付を検証します。
var condition1 = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.dateCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.DateCompareType.afterEqualsTo, expected: new Date(2012, 11, 31)});
var condition2 = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.dateCondition, {compareType: GC.Spread.Sheets.ConditionalFormatting.DateCompareType.beforeEqualsTo, expected: new Date(2013, 11, 31)});
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.relationCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.LogicalOperators.and);
nCondition.item1(condition1);
nCondition.item2(condition2);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, new Date(2012, 11, 25));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Condition |
2番目の条件。 |
戻り値
値が設定されていない場合は、2番目の条件を返します。値が設定されている場合は、関係条件を返します。
preciseCompareDate
▸ preciseCompareDate(value?): any
1日を比較するか、特定の日時を比較するかを取得または設定します。
実例
// 次のサンプルコードは、preciseCompareDateメソッドを使用します。
var dateCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.dateCondition);
dateCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.greaterThan);
dateCondition.expected(new Date(2020, 4, 22, 06));
// 次のオプションがfalseの場合、バリデーターは1日を比較し、それらは同じであるため、検証は失敗し、赤いアラートが表示されます。
// 次のオプションがtrueの場合、7時の日時が6時よりも大きいため、結果は成功します。
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(dateCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.date);
validator.preciseCompareDate(true);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, new Date(2020, 4, 22, 07));
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
1日を比較するか、特定の日時を比較するかを示します。 |
戻り値
any
値が設定されていない場合は、1日または特定の日時の比較を返します。 それ以外の場合は、データバリデーターを返します。
ranges
▸ ranges(value?): any
条件の範囲を取得または設定します。
実例
// 次のサンプルコードは、一意の値条件を作成します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.uniqueCondition);
nCondition.expected(true);
nCondition.ranges([new GC.Spread.Sheets.Range(0, 0, 5, 1)]);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, 5);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
Range[] |
条件の範囲。 |
戻り値
any
値が設定されていない場合は、条件の範囲を返します。値が設定されている場合は、条件を返します。
reset
▸ reset(): void
このインスタンスをリセットします。
実例
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.numberCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.greaterThan);
nCondition.expected(5);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, 5);
// ボタンを作成します。
$("#button1").click(function () {
activeSheet.suspendPaint();
nCondition.reset();
activeSheet.resumePaint();
});
戻り値
void
treatNullValueAsZero
▸ treatNullValueAsZero(value?): any
セルのnull値をゼロとして扱うかどうかを取得または設定します。
実例
// 次のサンプルコードは、treatNullValueAsZeroメソッドを設定します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.cellValueCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.equalsTo);
nCondition.expected(0);
// 次のオプションがfalseの場合、検証は失敗し、赤のアラートが表示されます。
// 次のオプションがtrueの場合、空白セルはゼロとして扱われ、検証は成功します。
nCondition.treatNullValueAsZero(false);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
validator.ignoreBlank(false);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, null);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
セルのnull値をゼロとして扱うかどうか。 |
戻り値
any
値が設定されていない場合は、セルのnull値をゼロとして扱うかどうかを返します。値が設定されている場合は、条件を返します。
useWildCards
▸ useWildCards(value?): any
ワイルドカードを使用して文字列を比較するかどうかを取得または設定します。
実例
// 次のサンプルコードは、ワイルドカードを許可します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.textCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.TextCompareType.contains);
nCondition.expected("te?t");
nCondition.ignoreBlank(true);
nCondition.ignoreCase(true);
nCondition.useWildCards(true);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, "testing");
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
value? |
boolean |
ワイルドカードを使用して文字列を比較するかどうか。 |
戻り値
any
値が設定されていない場合は、ワイルドカードを使用して文字列を比較するかどうかを返します。値が設定されている場合は、条件を返します。
fromDay
▸ Static fromDay(day): Condition
指定した日から拡張日付条件オブジェクトを作成します。
静的
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
day |
number |
日。 |
戻り値
拡張日付条件オブジェクト。
fromFormula
▸ Static fromFormula(formula): Condition
数式データから領域条件を作成します。
静的
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
formula |
string |
データ項目を含む範囲を指定する数式。 |
戻り値
領域条件。
fromMonth
▸ Static fromMonth(month): Condition
指定した月から拡張日付条件オブジェクトを作成します。
静的
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
month |
number |
月。最初の月は0です。 |
戻り値
拡張日付条件オブジェクト。
fromQuarter
▸ Static fromQuarter(quarter): Condition
指定した四半期から拡張日付条件オブジェクトを作成します。
静的
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
quarter |
QuarterType |
四半期。 |
戻り値
拡張日付条件オブジェクト。
fromSource
▸ Static fromSource(expected): Condition
ソースデータから領域条件を作成します。
静的
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
expected |
string |
各データ項目がカンマ（","）で区切られた、期待されるソース。 |
戻り値
領域条件。
fromWeek
▸ Static fromWeek(week): Condition
指定した週から拡張日付条件オブジェクトを作成します。
静的
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
week |
number |
週。 |
戻り値
拡張日付条件オブジェクト。
fromYear
▸ Static fromYear(year): Condition
指定した年から拡張日付条件オブジェクトを作成します。
静的
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
year |
number |
年。 |
戻り値
拡張日付条件オブジェクト。