Data Transformer Collate Filter Range

Edit on GitHub

This document explains the Data Transformer Collate Filter Range service in the Components Library.

Overview

Data Transformer Collate Filter Range is an Angular Service that implements filtering to range of data values based on configuration.

Check out an example usage of the Data Transformer Collate Filter Range in the @spryker/table config:

<spy-table
    [config]="{
        datasource: {
            ...,                                               
            transform: {
                ...,
                filter: {
                    select1: {
                        type: 'range',
                        propNames: 'col1',
                    },
                    select2: {
                        type: 'range',
                        propNames: ['col2', 'col1'],
                    },
                },
            },
        },
    }"
>
</spy-table>

Service registration

Register the service:

@NgModule({
    imports: [
        DataTransformerModule.withTransformers({
            collate: CollateDataTransformerService,
        }),
        CollateDataTransformer.withFilters({
            range: RangeDataTransformerFilterService,
        }),
    ],
})
export class RootModule {}

Interfaces

Below you can find interfaces for the Data Transformer Collate Filter Range:

declare module '@spryker/data-transformer.collate' {
    interface DataTransformerFilterRegistry {
        range: RangeDataTransformerFilterService;
    }
}

interface DataTransformerFilterConfig {
    type: string;
    propNames: string | string[];
}