File

projects/angular/components/ui-grid/src/models/filterModel.ts

Description

The filter model schema.

Index

Properties

Properties

meta
meta: ISuggestValueData<T> | ISuggestValueData<T>[] | null
Type : ISuggestValueData<T> | ISuggestValueData<T>[] | null
Optional

The current filter meta. This will be additional suggest data sent to search filters in case you need more than the id from suggest.

method
method: string
Type : string

Filter method metadata.

eg: equals, greaterThan, etc.

property
property: | string
Type : | string

The targeted entity property.

type
type: string
Type : string
Optional

Type metadata.

eg: string, number, etc.

value
value: string | number | Date | boolean | | undefined | null
Type : string | number | Date | boolean | | undefined | null

The current filter value.

import { ISuggestValueData } from '@uipath/angular/components/ui-suggest';

/**
 * The filter model schema.
 *
 * @export
 */
export interface IFilterModel<T> {
    /**
     * The targeted entity property.
     *
     */
    property: keyof T | string;
    /**
     * Filter method metadata.
     *
     * eg: `equals`, `greaterThan`, etc.
     *
     */
    method: string;
    /**
     * The current filter value.
     *
     */
    value: string | number | Date | boolean | [] | undefined | null;
    /**
     * Type metadata.
     *
     * eg: `string`, `number`, etc.
     *
     */
    type?: string;
    /**
     * The current filter meta.
     * This will be additional suggest data sent to search filters in case you need more than the id from suggest.
     *
     */
    meta?: ISuggestValueData<T> | ISuggestValueData<T>[] | null;
}

results matching ""

    No results matching ""