/*! * * Wijmo Library 5.20251.40 * https://developer.mescius.com/wijmo * * Copyright(c) MESCIUS inc. All rights reserved. * * Licensed under the End-User License Agreement For MESCIUS Wijmo Software. * us.sales@mescius.com * https://developer.mescius.com/wijmo/licensing * */ /** * {@module wijmo.grid.search} * Extension that includes the {@link FlexGridSearch} control, which provides * full-text search/filter/highlight services for {@link FlexGrid} controls. */ /** * */ export declare var ___keepComment: any; import { Control } from 'wijmo/wijmo'; import { FlexGrid } from 'wijmo/wijmo.grid'; export declare const FlexGridSearchClsNames: { hostElement: string; }; /** * The {@link FlexGridSearch} control allows users to quickly search the * items displayed in a {@link FlexGrid}. * * The control filters the items and shows only the ones that contain * the text provided by the user. It also highlights the matches in * the target {@link FlexGrid} (except for templated cells, which do * not support highlighting). * * The {@link FlexGridSearch} control may be used in conjunction with * the {@link FlexGridFilter} control, which provides column-specific * filtering. * * The example below shows how you can create a {@link FlexGridSearch} * control and connect it to a {@link FlexGrid}: * ```typescript * import { FlexGrid } from 'wijmo/wijmo.grid'; * import { FlexGridSearch } from 'wijmo/wijmo.grid.search'; * * // create FlexGrid * let grid = new FlexGrid('#gridElement', { * itemsSource: getData(); * }); * * // create FlexGridSearch and connect it to the grid * let search = new FlexGridSearch('#searchElement', { * grid: grid * }); * ``` */ export declare class FlexGridSearch extends Control { _tbx: HTMLInputElement; _btn: HTMLElement; private _g; private _cv; private _delay; private _cssMatch; private _searchAllColumns; private _rxSrch; private _rxHilite; private _toSearch; private _filterBnd; private _isSubmitOnChange; _inputAriaLabel: any; _ariaLabelledby: string; static _ctrlTemplate: string; /** * Gets or sets the template used to instantiate {@link FlexGridSearch} controls. */ static controlTemplate: string; /** * Initializes a new instance of the {@link FlexGridSearch} class. * * @param element The DOM element that hosts the control, or a selector for the host element (e.g. '#theCtrl'). * @param options The JavaScript object containing initialization data for the control. */ constructor(element: any, options?: any); /** * Gets or sets the {@link FlexGrid} that is connected to this {@link GroupPanel}. * * Once a grid is connected to the panel, the panel displays the groups * defined in the grid's data source. Users can drag grid columns * into the panel to create new groups, drag groups within the panel to * re-arrange the groups, or delete items in the panel to remove the groups. */ grid: FlexGrid; /** * Gets the HTML input element hosted by the control. * * Use this property in situations where you want to customize the * attributes of the input element. */ readonly inputElement: HTMLInputElement; /** * Gets or sets the text to search for. * * The text may include multiple terms, separated by spaces. */ text: string; /** * Gets or sets the delay, in milliseconds, between when a keystroke occurs * and when the search is performed. * * The default value for this property is **500** milliseconds. */ delay: number; /** * Gets or sets the string shown as a hint when the control is empty. * * The default value for this property is an empty string **""**. */ placeholder: string; /** * Gets or sets the name of the CSS class used to highlight any parts * of the content that match the search terms. * * The default value for this property is **"wj-state-match"**. * * Highlighing is not supported in template cells. */ cssMatch: string; /** * Gets or sets a value that determines whether invisible columns should * be included in the search. * * The default value for this property is **false**. */ searchAllColumns: boolean; private _formatItem; private _itemsSourceChanged; private _applySearch; private _filter; private _getItemText; private _applySearchText; /** * Gets or sets the property to determine whether to submit the value in the OnChange event of the input */ isSubmitOnChange: boolean; /** * Gets or sets the aria-labelledby attribute of {@link FlexGridSearch} input element. */ ariaLabelledBy: string; protected _updateInputAriaLabel(): void; }