UNPKG

2.29 kBTypeScriptView Raw
1// Type definitions for ag-grid v18.1.2
2// Project: http://www.ag-grid.com/
3// Definitions by: Niall Crosby <https://github.com/ag-grid/>
4import { IDoesFilterPassParams, SerializedFilter } from "../interfaces/iFilter";
5import { ComparableBaseFilter, IScalarFilterParams, FilterConditionType, IComparableFilterParams } from "./baseFilter";
6export interface SerializedTextFilter extends SerializedFilter {
7 filter: string;
8 type: string;
9}
10export interface TextComparator {
11 (filter: string, gridValue: any, filterText: string): boolean;
12}
13export interface TextFormatter {
14 (from: string): string;
15}
16export interface INumberFilterParams extends IScalarFilterParams {
17 debounceMs?: number;
18}
19export interface ITextFilterParams extends IComparableFilterParams {
20 textCustomComparator?: TextComparator;
21 debounceMs?: number;
22 caseSensitive?: boolean;
23}
24export declare class TextFilter extends ComparableBaseFilter<string, ITextFilterParams, SerializedTextFilter> {
25 private eFilterTextField;
26 private eFilterConditionTextField;
27 private filterText;
28 private filterConditionText;
29 private comparator;
30 private formatter;
31 static DEFAULT_FORMATTER: TextFormatter;
32 static DEFAULT_LOWERCASE_FORMATTER: TextFormatter;
33 static DEFAULT_COMPARATOR: TextComparator;
34 getDefaultType(): string;
35 customInit(): void;
36 modelFromFloatingFilter(from: string): SerializedTextFilter;
37 getApplicableFilterTypes(): string[];
38 bodyTemplate(type: FilterConditionType): string;
39 initialiseFilterBodyUi(type: FilterConditionType): void;
40 private addFilterChangedListener(type);
41 refreshFilterBodyUi(type: FilterConditionType): void;
42 afterGuiAttached(): void;
43 filterValues(type: FilterConditionType): string;
44 individualFilterPasses(params: IDoesFilterPassParams, type: FilterConditionType): boolean;
45 private checkIndividualFilter(params, filterType, filterText);
46 private onFilterTextFieldChanged(type);
47 setFilter(filter: string, type: FilterConditionType): void;
48 getFilter(): string;
49 resetState(): void;
50 serialize(type: FilterConditionType): SerializedTextFilter;
51 parse(model: SerializedTextFilter, type: FilterConditionType): void;
52 setType(filterType: string, type: FilterConditionType): void;
53}