Grid Excel スタイル フィルタリング

    グリッド Excel フィルタリングは、Grid などの Angular Material テーブルに対して Excel のようなフィルタリング UI を提供します。

    Angular Grid Excel スタイル フィルタリングの例

    使用方法

    Excel スタイル フィルタリングをオンにするには、2 つの入力を設定します。 allowFilteringtrue に設定し、filterModeexcelStyleFilter に設定してください。

    <igx-grid [data]="data" [autoGenerate]="true" [allowFiltering]="true" [filterMode]="'excelStyleFilter'">
    </igx-grid>
    

    インタラクション

    特定の列のフィルター メニューを開くには、ヘッダーの Angular フィルター アイコンをクリックします。さらに、選択したヘッダーで Ctrl + Shift + L の組み合わせを使用できます。列でフィルタリング機能と並べ替え、ピン固定、移動、選択、非表示が設定された場合、オンになっている機能のボタンが表示されます。

    フィルターが適用されていない場合、リストのすべての項目が選択されます。リストの上の入力からフィルターされます。データのフィルターは、リストで項目を選択/非選択して [適用] ボタンをクリックするか、あるいは Enter を押します。リスト項目に適用したフィルタリングは、equals オペレーターでフィルター式を作成します。各式間のロジック オペレーターは OR です。

    検索ボックスに入力してフィルターを適用すると、検索条件に一致する項目のみが選択されます。ただし、現在フィルターされている項目に項目を追加したい場合は、[現在の選択をフィルターに追加] オプションを選択する必要があります。

    フィルターをクリアしたい場合、[すべて選択] オプションをチェックして [適用] ボタンを押します。

    異なる式でフィルターを適用する場合、Text フィルター をクリックし、特定の列で使用できるフィルター演算子のサブメニューを開きます。いずれかを選択してカスタム フィルター ダイアログを開き、フィルターとロジック演算子を使用して式を追加できます。[クリア] ボタンでフィルターをクリアできます。

    メニュー機能の構成

    ソート、移動、ピン固定、非表示の機能をフィルター メニューから削除できます。これらを制御する入力は以下のとおりです: sortablemovableselecteddisablePinningdisableHiding

    <igx-grid #grid1 [data]="data" [autoGenerate]="false" height="650px" width="100%" [allowFiltering]="true" [filterMode]="'excelStyleFilter'">
        <igx-column field="ProductName" header="Product Name" [sortable]="true" [movable]="true" [dataType]="'string'">
        </igx-column>
        <igx-column field="QuantityPerUnit" header="Quantity Per Unit" [sortable]="false" [disablePinning]="true" [disableHiding]="true" [movable]="false" [dataType]="'string'">
        </igx-column>
        <igx-column field="UnitPrice" header="Unit Price" [disablePinning]="true" [disableHiding]="true" [sortable]="true" [movable]="true" [dataType]="'number'">
        </igx-column>
        <igx-column field="OrderDate" header="Order Date" [sortable]="false" [movable]="false" [dataType]="'date'" [formatter]="formatDate">
        </igx-column>
        <igx-column field="Discontinued" header="Discontinued" [sortable]="true" [movable]="true" [dataType]="'boolean'">
        </igx-column>
    </igx-grid>
    

    以下のサンプルの Product NameDiscontinued 列で 4 つすべての機能が有効です。Quantity Per Unit で 4 機能すべてが無効、Unit Price でソートと移動のみ有効、Order Date でピン固定と非表示のみ選択可能です。

    テンプレート

    列機能を無効にせずに Excel スタイル フィルター メニューをさらにカスタマイズする場合は、カスタム テンプレートを使用できます。Excel スタイル フィルター メニューには、テンプレート化のための 2 つのディレクティブがあります:

    • IgxExcelStyleColumnOperationsTemplateDirective - ソート、移動、固定などのすべての列操作で領域を再テンプレート化します。
    • IgxExcelStyleFilterOperationsTemplateDirective - すべてのフィルター固有の操作で領域を再テンプレート化します。

    これらの領域の 1 つだけ、または両方を再テンプレート化できます。これらのディレクティブ内にカスタム コンテンツを配置したり、組み込みの Excel スタイル フィルタリング コンポーネントを使用できます。

    次のコードは、igx-excel-style-headerigx-excel-style-sorting および igx-excel-style-search コンポーネントを使用してカスタム Excel スタイル フィルター メニューを定義する方法を示しています。

    <igx-grid #grid1 [data]="data" [autoGenerate]="false" height="650px" width="100%" [allowFiltering]="true" [filterMode]="'excelStyleFilter'">
    
        <igx-grid-excel-style-filtering [minHeight]="'380px'" [maxHeight]="'500px'">
            <igx-excel-style-column-operations>
                <igx-excel-style-header
                    [showPinning]="true"
                    [showHiding]="true"
                >
                </igx-excel-style-header>
    
                <igx-excel-style-sorting></igx-excel-style-sorting>
            </igx-excel-style-column-operations>
    
            <igx-excel-style-filter-operations>
                <igx-excel-style-search></igx-excel-style-search>
            </igx-excel-style-filter-operations>
        </igx-grid-excel-style-filtering>
    
        ...
    </igx-grid>
    

    igxExcelStyleHeaderIcon ディレクティブを使用して、列ヘッダーの Excel スタイル フィルタリング アイコンを再テンプレート化することもできます。

    <igx-grid ...>
        <ng-template igxExcelStyleHeaderIcon>
            <igx-icon>filter_alt</igx-icon>
        </ng-template>
    </igx-grid>
    

    以下は、使用可能な Excel スタイルフィルタリング コンポーネントの完全なリストです:

    一意の列値ストラテジ

    Excel スタイル フィルタリング ダイアログ内のリスト項目は、それぞれの列の一意の値を表します。これらの値は手動で提供し、ロード オン デマンドすることができます。詳細については、Grid リモート データ操作で説明されています。

    書式設定された値のフィルタリング ストラテジ

    デフォルトで、Grid コンポーネントは元のセル値に基づいてデータをフィルターしますが、場合によっては書式設定された値に基づいてデータをフィルターすることができます。 そのためには、FormattedValuesFilteringStrategy を使用します。 以下のサンプルは、列の数値を文字列として書式設定し、文字列値に基づいて Grid をフィルターする方法を示します。

    Note

    データの同じフィールドに複数の列がバインドされていて、1 つの列にフォーマッタがある場合、書式設定された値のフィルタリング ストラテジは正しく動作しません。

    外部の Excel スタイル フィルタリング

    上記デモで示されるように、Excel スタイル フィルタリング ダイアログのデフォルトの外観は Grid 内にあります。このダイアログは、フィルターを構成するときにのみ表示されます。ダイアログはグリッドの外部でスタンドアロン コンポーネントとして使用すると、常に表示になります。以下のデモでは、Excel スタイル フィルタリングが Grid とは別に宣言されます。

    デモ

    使用方法

    Excel スタイル フィルタリング コンポーネントを設定するには、column プロパティを Grid 列の 1 つに設定する必要があります。上記のサンプルで、column プロパティは Grid 列を表示する IgxSelectComponent の値にバインドされています。

    <igx-select #gridColums value="ProductID">
       <label igxLabel>Columns:</label>
       <igx-select-item *ngFor="let c of grid1.columns" [value]="c.field">
           {{ c.field }}
       </igx-select-item>
    </igx-select>
    
    <igx-grid-excel-style-filtering [column]="grid1.getColumnByName(gridColums.value)">
    </igx-grid-excel-style-filtering>
    

    表示要素が重なる場合のアウトレット設定

    Grid の z-index は、DOM の各グリッドに個別の重ね合わせコンテキストを作成します。これにより、グリッドのすべての子孫要素が互いに重ね合うことなく意図したとおりに描画されます。 ただし、グリッドの外側にある要素 (Excel スタイル フィルターなど) は、同じ z-index を持つ外側の要素 (たとえば、2 つのグリッドが上下に重ねる) と競合し、誤った描画が発生します。この問題の解決策は、outlet プロパティを外部のアウトレット ディレクティブに設定し、オーバーレイ要素が常に上に表示されるようにすることです。

    デモ

    スタイル設定

    ページネーターのスタイル設定を始めるには、すべてのテーマ関数とコンポーネントミックスインが存在する index ファイルをインポートする必要があります。

    @use "igniteui-angular/theming" as *;
    
    // 重要: Ignite UI for Angular 13 より前のバージョンは、次を使用してください。
    // @import '~igniteui-angular/lib/core/styles/themes/index';
    

    Excel スタイルのフィルタリング ダイアログは、filtering-row-background パラメーターを使用して、グリッドのテーマから背景色を取得します。背景を変更するには、カスタム テーマを作成する必要があります。

    $custom-grid: igx-grid-theme(
        $filtering-row-background: #FFCD0F
    );
    

    ボタン、チェックボックス、リスト、さらにはドロップダウンなど、フィルタリング ダイアログのような Excel 内には明らかに多くのコンポーネントがあります。スタイルを設定するには、それぞれに個別のテーマを作成する必要があります。

    $dark-button: igx-button-theme(
        $background: #FFCD0F,
        $foreground: #292826,
        $hover-background: #292826,
        $hover-foreground: #FFCD0F
    );
    
    $dark-input-group: igx-input-group-theme(
        $box-background: #FFCD0F,
        $idle-text-color: #292826,
        $focused-text-color: #292826,
        $filled-text-color: #292826
    );
    
    $custom-list: igx-list-theme(
        $background: #FFCD0F
    );
    
    $custom-checkbox: igx-checkbox-theme(
        $empty-color: #292826,
        $fill-color: #292826,
        $tick-color: #FFCD0F,
        $label-color: #292826
    );
    
    $custom-drop-down: igx-drop-down-theme(
        $background-color: #FFCD0F,
        $item-text-color: #292826,
        $hover-item-background: #292826,
        $hover-item-text-color: #FFCD0F
    );
    

    この例では、リストされたコンポーネントのパラメーターの一部のみを変更しましたが、igx-button-themeigx-checkbox-themeigx-drop-down-themeigx-input-group-themeigx-list-theme テーマは、それぞれのスタイルを制御するためのより多くのパラメーターを提供します。

    最後の手順は、それぞれのテーマを持つコンポーネント ミックスインを含めることです。また、入力のプレース ホルダーの色プロパティを設定します。

    @include igx-drop-down($custom-drop-down);
    @include igx-grid($custom-grid);
    .igx-excel-filter, .igx-excel-filter__secondary {
        @include igx-button($dark-button);
        @include igx-input-group($dark-input-group);
        @include igx-list($custom-list);
        @include igx-checkbox($custom-checkbox);
        .igx-input-group__input::placeholder {
            color: #FFCD0F;
        }
    }
    
    Note

    .igx-excel-filter.igx-excel-filter__secondary 内のほとんどのコンポーネントのミックスインをスコープするため、これらのカスタムテーマは、Excel スタイル フィルタリング ダイアログとそのすべてのサブダイアログにネストされたコンポーネントのみに影響します。そうでない場合、他のボタン、チェックボックス、入力グループ、およびリストも影響を受けます。

    Note

    コンポーネントが Emulated ViewEncapsulation を使用している場合、::ng-deep を使用してこのカプセル化を解除する必要があります。

    :host {
        ::ng-deep {
            @include igx-drop-down($custom-drop-down);
            @include igx-grid($custom-grid);
            .igx-excel-filter, .igx-excel-filter__secondary {
                @include igx-button($dark-button);
                @include igx-input-group($dark-input-group);
                @include igx-list($custom-list);
                @include igx-checkbox($custom-checkbox);
                .igx-input-group__input::placeholder {
                    color: #FFCD0F;
                }
            }
        }
    }
    

    カラーパレットの定義

    上記のように色の値をハードコーディングする代わりに、igx-palette および igx-color 関数を使用することによって色に関してより高い柔軟性を持つことができます。

    igx-palette は渡された一次色と二次色に基づいてカラーパレットを生成します:

    $yellow-color: #FFCD0F;
    $black-color: #292826;
    
    $dark-palette: igx-palette($primary: $black-color, $secondary: $yellow-color);
    

    また igx-color を使用してパレットから簡単に色を取り出すことができます。

    $custom-grid: igx-grid-theme(
        $filtering-row-background: #FFCD0F
    );
    
    $dark-button: igx-button-theme(
        $background: igx-color($dark-palette, "secondary", 400),
        $foreground: igx-color($dark-palette, "primary", 400),
        $hover-background: igx-color($dark-palette, "primary", 400),
        $hover-foreground: igx-color($dark-palette, "secondary", 400)
    );
    
    $dark-input-group: igx-input-group-theme(
        $box-background: igx-color($dark-palette, "secondary", 400),
        $idle-text-color: igx-color($dark-palette, "primary", 400),
        $focused-text-color: igx-color($dark-palette, "primary", 400),
        $filled-text-color: igx-color($dark-palette, "primary", 400)
    );
    
    $custom-list: igx-list-theme(
        $background: igx-color($dark-palette, "secondary", 400)
    );
    
    $custom-checkbox: igx-checkbox-theme(
        $empty-color: igx-color($dark-palette, "primary", 400),
        $fill-color: igx-color($dark-palette, "primary", 400),
        $tick-color: igx-color($dark-palette, "secondary", 400),
        $label-color: igx-color($dark-palette, "primary", 400)
    );
    
    $custom-drop-down: igx-drop-down-theme(
        $background-color: igx-color($dark-palette, "secondary", 400),
        $item-text-color: igx-color($dark-palette, "primary", 400),
        $hover-item-background: igx-color($dark-palette, "primary", 400),
        $hover-item-text-color: igx-color($dark-palette, "secondary", 400)
    );
    
    Note

    igx-color および igx-palette は、色を生成および取得するための重要な機能です。使い方の詳細についてはパレットのトピックを参照してください。

    スキーマの使用

    テーマ エンジンを使用してスキーマの利点を使用でき、堅牢で柔軟な構造を構築できます。スキーマはテーマを使用する方法です。

    すべてのコンポーネント (この場合はlight-gridlight-input-grouplight-buttonlight-listlight-checkboxlight-drop-down) に提供される 2 つの定義済みスキーマのいずれかを拡張します。

    $custom-grid-schema: extend($_light-grid,
        (
            filtering-row-background:(
                igx-color: ("secondary", 400)
            )
        )
    );
    
    $custom-button-schema: extend($_light-button,
        (
            flat-background:(
                igx-color: ("secondary", 400)
            ),
            flat-text-color:(
                igx-color: ("primary", 400)
            ),
            flat-hover-background:(
                igx-color: ("primary", 400)
            ),
            flat-hover-text-color:(
                igx-color: ("secondary", 400)
            ),
    
            raised-background:(
                igx-color: ("secondary", 400)
            ),
            raised-text-color:(
                igx-color: ("primary", 400)
            ),
            raised-hover-background:(
                igx-color: ("primary", 400)
            ),
            raised-hover-text-color:(
                igx-color: ("secondary", 400)
            )
        )
    );
    
    $custom-input-group-schema: extend($_light-input-group,
        (
            box-background:(
                igx-color: ("secondary", 400)
            ),
            idle-text-color:(
                igx-color: ("primary", 400)
            ),
            focused-text-color:(
                igx-color: ("primary", 400)
            ),
            filled-text-color:(
                igx-color: ("primary", 400)
            )
        )
    );
    
    $custom-list-schema: extend($_light-list,
        (
            background:(
                igx-color: ("secondary", 400)
            )
        )
    );
    
    $custom-checkbox-schema: extend($_light-checkbox,
        (
            empty-color:(
                igx-color: ("primary", 400)
            ),
            fill-color:(
                igx-color: ("primary", 400)
            ),
            tick-color:(
                igx-color: ("secondary", 400)
            ),
            label-color:(
                igx-color: ("primary", 400)
            )
        )
    );
    
    $custom-drop-down-schema: extend($_light-drop-down,
        (
            background-color:(
                igx-color: ("secondary", 400)
            ),
            item-text-color:(
                igx-color: ("primary", 400)
            ),
            hover-item-background:(
                igx-color: ("primary", 400)
            ),
            hover-item-text-color:(
                igx-color: ("secondary", 400)
            )
        )
    );
    

    カスタム スキーマを適用するには、グローバル (light または dark) の 1 つを拡張する必要があります。これは基本的にカスタム スキーマでコンポーネントを指し示し、その後それぞれのコンポーネント テーマに追加するものです。

    $custom-light-schema: extend($light-schema,(
        igx-grid: $custom-grid-schema,
        igx-button: $custom-button-schema,
        igx-input-group: $custom-input-group-schema,
        igx-list: $custom-list-schema,
        igx-checkbox: $custom-checkbox-schema,
        igx-drop-down: $custom-drop-down-schema
    ));
    
    $custom-grid: igx-grid-theme(
        $palette: $dark-palette,
        $schema: $custom-light-schema
    );
    
    $custom-button: igx-button-theme(
        $palette: $dark-palette,
        $schema: $custom-light-schema
    );
    
    $custom-input-group: igx-input-group-theme(
        $palette: $dark-palette,
        $schema: $custom-light-schema
    );
    
    $custom-list: igx-list-theme(
        $palette: $dark-palette,
        $schema: $custom-light-schema
    );
    
    $custom-checkbox: igx-checkbox-theme(
        $palette: $dark-palette,
        $schema: $custom-light-schema
    );
    
    $custom-drop-down: igx-drop-down-theme(
        $palette: $dark-palette,
        $schema: $custom-light-schema
    );
    

    テーマを上記と同じ方法で含めることに注意してください。

    デモ

    Note

    このサンプルは、「テーマの変更」から選択したグローバル テーマに影響を受けません。

    API リファレンス

    その他のリソース

    コミュニティに参加して新しいアイデアをご提案ください。