ig.excel.ColorScaleConditionalFormat

最小値、中値、および最大値のしきい値に相対してセル値に基づいて WorksheetCell の色設定を制御するプロパティを公開します。

備考

このクラスは、コンストラクターの colorScaleType パラメーターの値に基づいて決定される 2 色または 3 色スケールをサポートします。

2 色スケールの場合、関連する範囲のセルは、値が 最小値および最大値のしきい値に相対する方法に基づいて色が設定されます。

3 色スケールの場合、関連する範囲のセルは、値が最小値、中値、および最大値のしきい値に相対する方法に基づいて色が設定されます。

このクラスは一意の色しきい値を最大 3 つサポートします。

単一のしきい値の指定はサポートされていません。予期されていない動作となる場合があります。

このインスタンスが 2 色スケールとして作成される場合、ColorScaleConditionalFormat.midpointThreshold プロパティは適用できません。この場合、MidpointThreshold プロパティから返されたオブジェクトにプロパティを設定することは例外が発生する原因となります。

依存関係

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
このコントロールにオプションはありません。
このコントロールにイベントはありません。

  • colorScaleType

    .colorScaleType( );
    返却型:
    ig.excel.ColorScaleType
    返却型の説明:
    ColorScaleType を返します。

    このインスタンスを 2 色または 3 色スケールとして識別する ColorScaleType 値を返します。

    備考

    'TwoColor' 値と作成された ColorScaleConditionalFormat インスタンスは ColorScaleConditionalFormat.midpointThreshold をサポートしません。 MidpointThreshold プロパティから返されたオブジェクトにプロパティの設定は例外が発生する原因となります。

    関連項目

  • conditionType
    継承

    .conditionType( );
    返却型:
    ig.excel.FormatConditionType
    返却型の説明:
    FormatConditionType を返します。

    このインスタンスの条件のタイプを識別する FormatConditionType 値を返します。

    関連項目

  • formula
    継承

    .formula( );
    返却型:
    ig.excel.Formula
    返却型の説明:
    Formula を返します。

    この条件が適用する値を決定する 数式 を返します。

    備考

    注: 数式はブール値の結果を返します。数式を領域のセルに適用した際に数式が false を返す場合、そのセルは書式設定に含まれません。

    関連項目

  • maximumThreshold

    .maximumThreshold( );
    返却型:
    ig.excel.ColorScaleCriterion
    返却型の説明:
    ColorScaleCriterion を返します。

    このインスタンスの最大しきい値のプロパティを定義する ColorScaleCriterion オブジェクトを返します。

    備考

    以下の値型は最大しきい値で無効です。例外を発生する原因になります。

    • LowestValue
    • AutomaticMinimum
    • AutomaticMaximum

    関連項目

  • midpointThreshold

    .midpointThreshold( );
    返却型:
    ig.excel.ColorScaleCriterion
    返却型の説明:
    ColorScaleCriterion を返します。

    このインスタンスの中値しきい値のプロパティを定義する ColorScaleCriterion オブジェクトを返します。

    備考

    中値しきい値は、colorScaleType パラメーターに指定された 'ThreeColor' 値を持つ ColorScaleConditionalFormat インスタンスのみにサポートされます。

    このプロパティから返されたインスタンスにプロパティを設定すると、このインスタンスが 2 色スケールとして作成した場合に例外が発生する原因になります。

    以下の値型は中値しきい値で無効です。例外を発生する原因になります。

    • LowestValue
    • HighestValue
    • AutomaticMinimum
    • AutomaticMaximum

    関連項目

  • minimumThreshold

    .minimumThreshold( );
    返却型:
    ig.excel.ColorScaleCriterion
    返却型の説明:
    ColorScaleCriterion を返します。

    このインスタンスの最小しきい値のプロパティを定義する ColorScaleCriterion オブジェクトを返します。

    備考

    最小しきい値は、関連する範囲の間の最小値の条件を定義します。

    2 色スケールの場合、ColorScaleConditionalFormat.maximumThreshold は次の「位置」を定義します。3 色スケールの場合、ColorScaleConditionalFormat.midpointThreshold プロパティは次の位置を定義します。

    以下の値型は最小しきい値で無効です。例外を発生する原因になります。

    • HighestValue
    • AutomaticMinimum
    • AutomaticMaximum

    関連項目

  • priority
    継承

    .priority( );

    複数の条件付き書式ルールが存在する場合に評価の順序を決定する値を返します。

    備考

    デフォルトで、条件は、含まれているコレクション内に現れる順序で評価されます。

    このプロパティを使用すると、条件のコレクションでの順序位置をオーバーライドできます。

    より低い数値がより優先されます。たとえば、優先が 1 に設定される条件が 2 の優先の条件の前に評価されます。

    セル値が複数の条件に一致する場合、最初に評価された条件によって定義される書式は優先があります。

    1 つ以上の条件で優先を設定する場合、各条件に一意の値があることを確認するためにコレクションのその他の条件の値を変更する可能性があります。

  • priority
    継承

    .priority( value:number );

    複数の条件付き書式ルールが存在する場合に評価の順序を決定する値を返します。

    • value
    • タイプ:number

    備考

    デフォルトで、条件は、含まれているコレクション内に現れる順序で評価されます。

    このプロパティを使用すると、条件のコレクションでの順序位置をオーバーライドできます。

    より低い数値がより優先されます。たとえば、優先が 1 に設定される条件が 2 の優先の条件の前に評価されます。

    セル値が複数の条件に一致する場合、最初に評価された条件によって定義される書式は優先があります。

    1 つ以上の条件で優先を設定する場合、各条件に一意の値があることを確認するためにコレクションのその他の条件の値を変更する可能性があります。

  • 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 が無効か、その他のワークシートからの領域を含む場合。

  • 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 を返します。

    関連付けられたワークシートへの参照を返します。

    関連項目

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.