ig.excel.IconSetConditionalFormat
備考
このクラスは、そのセルの値が関連する IconCriterion によって定義される条件に一致する場合にセルでアイコンを表示する機能を提供します。
各アイコン セットは 3 ~ 5 アイコンを含みます。アイコンの数はしきい値の数を定義します。たとえば、3 つのアイコンを含むセットは 3 つのしきい値をサポートし、各しきい値は関連する範囲の 33% を表します。4 つのアイコンを含むセットは 4 つのしきい値をサポートし、各しきい値は範囲の 25% を表します。5 つのアイコンを含むセットは 5 つのしきい値をサポートし、各しきい値は範囲の 20% を表します。
しきい値範囲は関連するセットのアイコンの数に基づいて定義済みされますが、しきい値と関連する IconCriterion の Value プロパティを使用してカスタマイズ化できます。
デフォルトでしきい値がパーセンテージとして表わされます。パーセンタイル レーテイングまたは特定の値をサポートするために Value プロパティを使用します。Value プロパティの使用方法は ValueType プロパティに依存します。
しきい値の数は常に 3、4、または 5 ですが、特定のしきい値に表示されるアイコンが IconCriterion.icon プロパティを使用してカスタマイズできます。
依存関係
-
conditionType
継承- .conditionType( );
- 返却型:
- ig.excel.FormatConditionType
- 返却型の説明:
- FormatConditionType を返します。
このインスタンスの条件のタイプを識別する FormatConditionType 値を返します。
-
formula
継承- .formula( );
- 返却型:
- ig.excel.Formula
- 返却型の説明:
- Formula を返します。
この条件が適用する値を決定する 数式 を返します。
備考
注: 数式はブール値の結果を返します。数式を領域のセルに適用した際に数式が false を返す場合、そのセルは書式設定に含まれません。 -
iconCriteria
- .iconCriteria( );
- 返却型:
- ig.excel.IconSetCriterionCollection
- 返却型の説明:
- IconSetCriterionCollection を返します。
この条件を定義するコレクションを返します。
-
iconCriteria
- .iconCriteria( index:number );
- 返却型:
- ig.excel.IconCriterion
- 返却型の説明:
- IconSetCriterionCollection を返します。
この条件を定義するコレクションを返します。
- index
- タイプ:number
- ゼロから始まるインデックス。
-
iconSet
- .iconSet( );
- 返却型:
- ig.excel.FormatConditionIconSet
- 返却型の説明:
- FormatConditionIconSet を返します。
この条件を示すアイコンのセットを識別する FormatConditionIconSet 値を返します。
-
iconSet
- .iconSet( value:ig.excel.FormatConditionIconSet );
- 返却型:
- ig.excel.FormatConditionIconSet
- 返却型の説明:
- FormatConditionIconSet を返します。
この条件を示すアイコンのセットを識別する FormatConditionIconSet 値を返します。
- value
- タイプ:ig.excel.FormatConditionIconSet
-
isCustom
- .isCustom( );
1 つ以上の criterion の Icon プロパティが IconSetConditionalFormat.iconSet プロパティから返されたアイコン セットと異なるアイコン セットにある値を返す場合 true を返します。
-
isReverseOrder
- .isReverseOrder( );
アイコンの表示順序が反転されるかどうかを示すブール値を返します。
-
isReverseOrder
- .isReverseOrder( value:boolean );
アイコンの表示順序が反転されるかどうかを示すブール値を返します。
- value
- タイプ:boolean
-
priority
継承- .priority( );
複数の条件付き書式ルールが存在する場合に評価の順序を決定する値を返します。
-
priority
継承- .priority( value:number );
複数の条件付き書式ルールが存在する場合に評価の順序を決定する値を返します。
- value
- タイプ:number
-
regions
継承- .regions( );
この条件が関連するセル範囲を識別する WorksheetRegion を返します。
-
setFirstPriority
継承- .setFirstPriority( );
このルールが最初の評価される条件になるために ConditionBase.priority 値を設定します。関連するコレクションに複数の要素が含まれる場合のみに適用できます。
備考
複数の条件が同じコレクションに存在する場合、評価の順序はこの条件に一致するセルに適用される書式に影響します。
このメソッドは、関連する条件を最初に評価される条件に設定します。
条件を最後に評価される条件に設定するには、ConditionBase.setLastPriority メソッドを使用します。
-
setFormula
継承- .setFormula( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode] );
ThresholdConditionBase.formula プロパティに新しい Formula を割り当てます。
- formula
- タイプ:string
- 式の文字列表現。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- オプション
- formula パラメーターが A1 または R1C1 式として解析するかどうかを指定する CellReferenceMode 値。このプロパティはオプションで、デフォルト値は null です。この場合、Workbook.cellReferenceMode プロパティが使用されます。
備考
注: 数式はブール値の結果を返します。数式を領域のセルに適用した際に数式が false を返す場合、そのセルは書式設定に含まれません。 -
setLastPriority
継承- .setLastPriority( );
このルールが最後の評価される条件になるために ConditionBase.priority 値を設定します。関連する ConditionalFormatCollection に複数の要素が含まれる場合のみに適用できます。
備考
ConditionBase.setFirstPriority メソッドは関連する条件を最初に評価されることを設定する通り、SetLastPriority メソッドは関連する条件を最後に評価されることを設定します。
このメソッドを複数の条件で呼び出す場合、以前設定した最後に評価される条件と置き換えます。
-
setRegions
継承- .setRegions( regionAddress:string, cellReferenceMode:ig.excel.CellReferenceMode );
既存の領域を新しい領域と置き換えます。
- regionAddress
- タイプ:string
- コンマに分割される領域アドレスを 1 つ以上含む文字列。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- オプションのセル参照モード。
例外
例外 説明 ig.ArgumentException regionAddress が無効か、その他のワークシートからの領域を含む場合。 -
showValue
- .showValue( );
セル値がアイコンと表示されるかどうかを示すブール値を返します。
備考
デフォルトでセル値がアイコンと表示されます。このプロパティを使用すると、セル値の表示を回避します。
-
showValue
- .showValue( value:boolean );
セル値がアイコンと表示されるかどうかを示すブール値を返します。
- value
- タイプ:boolean
備考
デフォルトでセル値がアイコンと表示されます。このプロパティを使用すると、セル値の表示を回避します。
-
stopIfTrue
継承- .stopIfTrue( );
このルールが true に評価する場合、追加の書式ルールが評価されるかどうかを示すブール値を返します。含まれるコレクションが複数の要素を含む場合のみに適用されます。
備考
セル値が複数の条件に一致する場合、最初の条件によって定義される書式は優先があります。書式プロパティは解決処理で結合されます。たとえば、1 つの書式設定に赤い境界線があり、その他の書式設定に赤い前景色がある場合、その 2 つの条件に一致するセル値の書式設定は赤い境界線および赤い前景色になります。
このプロパティを使用すると、解決処理をオーバーライドできます。つまり、最初の条件が true に評価した後、その他の条件付き書式が適用されないために設定できます。
上記の例で、StopIfTrue が赤い境界線の条件付き書式で true の値に設定され、赤い前景色のその他の条件付き書式があり、セル値がその両方の条件に一致する場合があります。StopIfTrue 設定が追加の書式の評価を許可しないため、セルが赤い前景色を表示しません。ただし、StopIfTrue が false に設定される場合、赤い境界線および赤い前景色を表示します。
次の条件の評価を許可しない機能に追加して、ConditionBase.priority プロパティを使用して条件の評価順序を制御できます。
-
stopIfTrue
継承- .stopIfTrue( value:boolean );
このルールが true に評価する場合、追加の書式ルールが評価されるかどうかを示すブール値を返します。含まれるコレクションが複数の要素を含む場合のみに適用されます。
- value
- タイプ:boolean
備考
セル値が複数の条件に一致する場合、最初の条件によって定義される書式は優先があります。書式プロパティは解決処理で結合されます。たとえば、1 つの書式設定に赤い境界線があり、その他の書式設定に赤い前景色がある場合、その 2 つの条件に一致するセル値の書式設定は赤い境界線および赤い前景色になります。
このプロパティを使用すると、解決処理をオーバーライドできます。つまり、最初の条件が true に評価した後、その他の条件付き書式が適用されないために設定できます。
上記の例で、StopIfTrue が赤い境界線の条件付き書式で true の値に設定され、赤い前景色のその他の条件付き書式があり、セル値がその両方の条件に一致する場合があります。StopIfTrue 設定が追加の書式の評価を許可しないため、セルが赤い前景色を表示しません。ただし、StopIfTrue が false に設定される場合、赤い境界線および赤い前景色を表示します。
次の条件の評価を許可しない機能に追加して、ConditionBase.priority プロパティを使用して条件の評価順序を制御できます。
-
workbook
継承- .workbook( );
- 返却型:
- ig.excel.Workbook
- 返却型の説明:
- Workbook を返します。
関連付けられたワークブックへの参照を返します。
関連項目
-
worksheet
継承- .worksheet( );
- 返却型:
- ig.excel.Worksheet
- 返却型の説明:
- Worksheet を返します。
関連付けられたワークシートへの参照を返します。
関連項目