オートフィルターを扱うクラスです。ワークシートまたは、テーブルから使用します。

Methods

  • オートフィルターの対象セル範囲を取得します。

    Returns string

    対象セル範囲(A1C1)

  • 並び替えクラスを取得します。

    Returns Sort

    並び替えクラス

  • オートフィルターの削除を行います。オートフィルター自体を削除します。

    Returns void

  • オートフィルター条件の全クリアを行います。オートフィルター自体は残ります。

    Returns void

  • オートフィルター条件のクリアを行います。

    Parameters

    • colId: number

      条件削除対象列 (先頭列=1)

    Returns void

  • AndCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をAndで結合))の設定を行います。

    1. パラメータ`criteria1`,パラメータ`criteria2`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)

    Parameters

    Returns void

  • averageFilter(平均値によるフィルター)の設定を行います。

    1. パラメータ`aboveAverage`が、trueは、平均以上、falseは、平均以下が、フィルター対象となります。

    Parameters

    • aboveAverage: boolean

      true: 平均値以上 false: 平均値以下

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • BottomPercentFilter(値の下位のパーセント値フィルター)の設定を行います。

    1. 下位`filterVal`パーセントがフィルター条件となります。

    Parameters

    • filterVal: number

      フィルター値(パーセント値: 0~100)

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • Bottom10ValueFilter(値の下位の値フィルター)の設定を行います。

    1. 下位`filterVal`件がフィルター条件となります。

    Parameters

    • filterVal: number

      フィルター値

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • CellColorFilter(セル色によるフィルター)の設定を行います。

    1. パラメータ`targetA1`のセルのセル色をフィルター条件に加えます。このパラメータが空値の場合、セル色は、自動となります。

    Parameters

    • targetA1: string

      対象セル

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • CustomFilter(ワイルドカード含む任意条件のフィルター)の設定を行います。

    1. 任意条件のフィルターを設定します。パラメータ`criteria`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)

    Parameters

    • op: XlAutoFilterOperator

      演算子

    • criteria: string

      検索条件

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • DateTimeFilter(表示日時によるフィルター)の設定を行います。

    1. パラメータ`filterVal`の単位をフィルター条件に設定します。

    Parameters

    • filterVal: XlAutoFilterDateTime

      日付のグルーピング単位

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • DateTimeGroupingFilter(表示日時(複数)によるフィルター)の設定を行います。

    1. パラメータ`filterVals`は、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。
    2. パラメータ`filterTypes`は、複数値設定可能です。グルーピングの単位を指定します。
    3. パラメータ`filterVals`の数とパラメータ`filterTypes`の数は、同じである必要があります。n番目の`filterVals`の値をn番目の`filterTypes`の条件でフィルター条件とします。

    Parameters

    • filterVals: DateTimeObject[]

      Array<フィルター対象日時オブジェクト>

    • filterTypes: XlDateTimeGroupingType[]

      Array<日時のグルーピング単位>

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • FontColorFilter(フォント色によるフィルター)の設定を行います。

    1. パラメータ`targetA1`のセルのフォント色をフィルター条件に加えます。このパラメータが空値の場合、フォント色は自動となります。

    Parameters

    • targetA1: string

      対象セル

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • IconFilter(表示アイコンによるフィルター)の設定を行います。

    1. パラメータ`filterIconId`は、パラメータ`filterIconset'のアイコンの中で、何番目のアイコンをフィルター対象にするかどうかを設定します。

    Parameters

    • filterIconset: XlFilterIconSet

      アイコンセット アイコンセットなしに設定する場合は、XlFilterIconSet.IconSetNoneを設定します。

    • filterIconId: number

      アイコンセットの中のアイコンID 1から始まります。アイコンセットなしに設定する場合は任意の値となります。

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • OrCustomFilter(ワイルドカード含む任意条件のフィルター(2条件をOrで結合))の設定を行います。

    1. パラメータ`criteria1`,パラメータ`criteria2`には、*,? 等を含む条件式が入力可能です。(Excelと同一です)

    Parameters

    Returns void

  • Top10PercentFilter(値の上位のパーセント値フィルター)の設定を行います。

    1. 上位`filterVal`パーセントがフィルター条件となります。

    Parameters

    • filterVal: number

      フィルター値(パーセント値: 0~100)

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • Top10ValueFilter(値の上位の値フィルター)の設定を行います。

    1. 上位`filterVal`件がフィルター条件となります。

    Parameters

    • filterVal: number

      フィルター値

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • UniqueValueFilter(値(日時オブジェクト)の一意性によるフィルター)の設定を行います。

    1. パラメータ`filterVals`は、複数値設定可能です。セルの値が日付/時刻であるセルがフィルター対象です。

    Parameters

    • filterVals: DateTimeObject[]

      Array<フィルター対象日時オブジェクト>

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • UniqueValueFilter(値(数値)の一意性によるフィルター)の設定を行います。

    1. パラメータ`filterVals`は、複数値設定可能です。セルの値が数値であるセルがフィルター対象です。

    Parameters

    • filterVals: number[]

      Array<フィルター対象数値>

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

  • UniqueValueFilter(値(文字列)の一意性によるフィルター)の設定を行います。

    1. パラメータ`filterVals`は、複数値設定可能です。セルの値が文字列であるセルがフィルター対象です。

    Parameters

    • filterVals: string[]

      Array フィルター対象文字列

    • colId: number = 1

      フィルター対象列 (先頭列=1)

    Returns void

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