条件付き書式クラスクラス

条件付き書式を扱うクラスです。ワークシートから使用します。

osbxlでは、各種条件(複数可)を設定後、apply()メソッドを呼び計算を反映させる必要があります。 apply()メソッドの呼び出しを忘れないでください。

Methods

  • 条件付き書式の適用を行います。

    1. 設定したFormatConditionsの適用を行います。
    2. このメソッドは全条件設定後に、必ず、呼び出す必要があります。

    Returns void

  • AboveAverageCondition(平均値より上位/下位による条件付き書式)を取得します。

    1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
    2. getConditionTypesメソッドで、条件タイプ取得が可能です。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns AboveAverageObject

    条件付き書式平均値上位オブジェクト

  • セル範囲の設定された条件付き書式の枠線の書式(一括)を取得します。

    1. 返却値のStringは、セル範囲です。
    2. 条件付き書式が適用されているセルのみを返却します。

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    Returns Map<string, BordersObject>

    Map<セル範囲, 枠線の書式(一括)オブジェクト>

  • セル範囲の設定された条件付き書式のデータバーが含まれているかどうかを取得します。

    1. 返却値のStringは、セル範囲です。
    2. 条件付き書式が適用されているセルのみを返却します。

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    Returns Map<string, boolean>

    Map<セル範囲, データバーが含まれているかどうか(True:含まれている)>

  • セル範囲の設定された条件付き書式の塗りつぶし書式を取得します。

    1. 返却値のStringは、セル範囲です。
    2. 条件付き書式が適用されているセルのみを返却します。

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    Returns Map<string, FillObject>

    Map<セル範囲, 塗りつぶしオブジェクト>

  • セル範囲の設定された条件付き書式のフォント書式を取得します。

    1. 返却値のStringは、セル範囲です。
    2. 条件付き書式が適用されているセルのみを返却します。

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    Returns Map<string, FontObject>

    Map<セル範囲, フォントオブジェクト>

  • セル範囲の設定された条件付き書式のアイコンセットの書式を取得します。

    1. 返却値のStringは、セル範囲です。
    2. 条件付き書式が適用されているセルのみを返却します。

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    Returns Map<string, FilterIconsetObject>

    Map<セル範囲, アイコンセットオブジェクト>

  • セル範囲の設定された条件付き書式のセル表示書式を取得します。

    1. 返却値のStringは、セル範囲です。
    2. 条件付き書式が適用されているセルのみを返却します。

    Parameters

    • A1C1: string

      セル範囲(A1C1)

    Returns Map<string, string>

    Map<セル範囲, セル表示書式>

  • CellValueCondition(セル値による条件付き書式)を取得します。

    1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
    2. getConditionTypesメソッドで、条件タイプ取得が可能です。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns CellValueObject

    条件付き書式セル値オブジェクト

  • CellValueRangeCondition(セル値範囲による条件付き書式)を取得します。

    1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
    2. getConditionTypesメソッドで、条件タイプ取得が可能です。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns CellValueRangeObject

    条件付き書式セル値範囲オブジェクト

  • ColorScaleCondition(グラデーション色による条件付き書式)を取得します。

    1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
    2. getConditionTypesメソッドで、条件タイプ取得が可能です。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns ColorScaleObject

    条件付き書式グラデーション色オブジェクト

  • 全条件付き書式の条件タイプ(どの種類を用いた条件付き書式なのか)を取得します。

    1. 返却値のstringは、セル範囲です。
    2. 返却値のintは、priorityです。1から始まります。
    3. osbxlでは、priorityは、シート単位で一意に設定します。

    Returns Map<number, Map<string, XlFormatConditionType>>

    Map<プライオリティ(適用順序、値が低いほど先に適用する),Map<セル範囲,条件付き書式の条件タイプ>>

  • DataBarCondition(データバーによる条件付き書式)を取得します。

    1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
    2. getConditionTypesメソッドで、条件タイプ取得が可能です。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns DataBarObject

    条件付き書式データバーオブジェクト

  • IconsetCondition(アイコンセットによる条件付き書式)を取得します。

    1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
    2. getConditionTypesメソッドで、条件タイプ取得が可能です。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns IconsetConditionObject

    条件付き書式アイコンセットオブジェクト

  • Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を取得します。

    1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
    2. getConditionTypesメソッドで、条件タイプ取得が可能です。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns Top10Object

    条件付き書式上位下位オブジェクト

  • UniqueValueCondition(ユニーク値による条件付き書式)を取得します。

    1. `priority`は、条件のn番目を意味します。条件の先頭=1です。`priority`と条件タイプがあっていない場合、Exceptionとなります。
    2. getConditionTypesメソッドで、条件タイプ取得が可能です。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns UniqueValuesObject

    条件付き書式ユニーク値オブジェクト

  • 条件付き書式の条件の全削除を行います。

    Returns void

  • 条件付き書式の条件の個別削除を行います。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    Returns void

  • AboveAverageCondition(平均値より上位による条件付き書式)を設定します。

    1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    • condition: AboveAverageObject

      条件付き書式平均値上位オブジェクト

    Returns void

  • CellValueCondition(セル値による条件付き書式)を設定します。

    1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    • condition: CellValueObject

      条件付き書式セル値オブジェクト

    Returns void

  • CellValueRangeCondition(セル値範囲による条件付き書式)を設定します。

    1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    • condition: CellValueRangeObject

      条件付き書式セル値範囲オブジェクト

    Returns void

  • ColorScaleCondition(グラデーション色による条件付き書式)を設定します。

    1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    • condition: ColorScaleObject

      条件付き書式グラデーション色オブジェクト

    Returns void

  • DataBarCondition(データバーによる条件付き書式)を設定します。

    1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    • condition: DataBarObject

      条件付き書式データバーオブジェクト

    Returns void

  • IconsetCondition(アイコンセットによる条件付き書式)を設定します。

    1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    • condition: IconsetConditionObject

      条件付き書式アイコンセットオブジェクト

    Returns void

  • Top10Condition(上位/下位N件(またはパーセント)による条件付き書式)を設定します。

    1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    • condition: Top10Object

      条件付き書式上位下位オブジェクト

    Returns void

  • UniqueValueCondition(ユニーク値による条件付き書式)を設定します。

    1. `prirority`が既に存在する場合、存在する`priority`を後ろにずらします。

    Parameters

    • priority: number

      プライオリティ(適用順序、値が低いほど先に適用する)

    • condition: UniqueValuesObject

      条件付き書式ユニーク値オブジェクト

    Returns void

   Copyright © 2023. OSB-OFFICE.Inc, All rights reserved.   Generated using TypeDoc