smart-webcomponents-angular
Version:
[](https://jqwidgets.com/license/)
107 lines (106 loc) • 5.92 kB
TypeScript
import { FilterPanel } from './../index';
import { Animation, FilterPanelFilterType, FilterPanelMode } from './../index';
import { AfterViewInit, ElementRef, OnInit, OnChanges, OnDestroy, SimpleChanges, EventEmitter } from '@angular/core';
import { BaseElement } from './smart.element';
import * as i0 from "@angular/core";
export { Animation, FilterPanelFilterType, FilterPanelMode, ElementRenderMode } from './../index';
export { Smart } from './smart.element';
export { FilterPanel } from './../index';
export declare class FilterPanelComponent extends BaseElement implements OnInit, AfterViewInit, OnDestroy, OnChanges {
constructor(ref: ElementRef<FilterPanel>);
private eventHandlers;
nativeElement: FilterPanel;
/** @description Creates the component on demand.
* @param properties An optional object of properties, which will be added to the template binded ones.
*/
createComponent(properties?: {}): any;
/** @description Sets or gets the animation mode. Animation is disabled when the property is set to 'none' */
get animation(): Animation | string;
set animation(value: Animation | string);
/** @description Defines which operation buttons will be shown in the filter panel */
get buttons(): string[];
set buttons(value: string[]);
/** @description Array in mode: 'excel', determines the data to extract unique filter values from. The expected format of the data is an array of objects with key-value pairs (JSON array) */
get data(): number[];
set data(value: number[]);
/** @description Describes filtered data field. */
get dataField(): string;
set dataField(value: string);
/** @description If set to an array, determines a custom collection of filter values to be displayed. If set to a callback function, the user can add custom filter values dynamically to the default filter values (in this case, the evaluateFilterExpression function must also be implemented) .dataSource is only available in mode: 'excel'. */
get dataSource(): any;
set dataSource(value: any);
/** @description Enables or disables filter panel. */
get disabled(): boolean;
set disabled(value: boolean);
/** @description Callback function, used for custom evaluations in filter panel. */
get evaluateFilterExpression(): any;
set evaluateFilterExpression(value: any);
/** @description Defines which filter type is used. */
get filterType(): FilterPanelFilterType | string;
set filterType(value: FilterPanelFilterType | string);
/** @description Format string used in filterType 'Date'. */
get formatString(): string;
set formatString(value: string);
/** @description Sets or gets the license which unlocks the product. */
get license(): string;
set license(value: string);
/** @description Sets or gets the language. Used in conjunction with the property messages. */
get locale(): string;
set locale(value: string);
/** @description Defines field names of the filtered element. */
get messages(): any;
set messages(value: any);
/** @description Desfines filter panel's mode */
get mode(): FilterPanelMode | string;
set mode(value: FilterPanelMode | string);
/** @description If the element is readonly, users cannot interact with it. */
get readonly(): boolean;
set readonly(value: boolean);
/** @description Determines the theme. Theme defines the look of the element */
get theme(): string;
set theme(value: string);
/** @description If is set to true, the element cannot be focused. */
get unfocusable(): boolean;
set unfocusable(value: boolean);
/** @description This event is triggered when the current filtering is discarted.
* @param event. The custom event. */
onCancel: EventEmitter<CustomEvent>;
/** @description This event is triggered when the current filtering is cleared.
* @param event. The custom event. */
onClear: EventEmitter<CustomEvent>;
/** @description This event is triggered when filter panel settings are applied.
* @param event. The custom event. */
onFilter: EventEmitter<CustomEvent>;
/** @description Discards current filtering.
*/
cancel(): void;
/** @description Clears current filtering.
*/
clear(): void;
/** @description Evaluates a filter.
* @param {any} value. The evalueated element in filter panel.
*/
evaluate(value: any): void;
/** @description Applies current filtering.
*/
filter(): void;
/** @description Gets the current filter state.
* @returns {any}
*/
getState(): Promise<any>;
/** @description Loads a previously saved filter state.
* @param {any} state. An object returned by the method getState.
*/
loadState(state: any): void;
get isRendered(): boolean;
ngOnInit(): void;
ngAfterViewInit(): void;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
/** @description Add event listeners. */
private listen;
/** @description Remove event listeners. */
private unlisten;
static ɵfac: i0.ɵɵFactoryDeclaration<FilterPanelComponent, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<FilterPanelComponent, "smart-filter-panel, [smart-filter-panel]", ["smart-filter-panel"], { "animation": "animation"; "buttons": "buttons"; "data": "data"; "dataField": "dataField"; "dataSource": "dataSource"; "disabled": "disabled"; "evaluateFilterExpression": "evaluateFilterExpression"; "filterType": "filterType"; "formatString": "formatString"; "license": "license"; "locale": "locale"; "messages": "messages"; "mode": "mode"; "readonly": "readonly"; "theme": "theme"; "unfocusable": "unfocusable"; }, { "onCancel": "onCancel"; "onClear": "onClear"; "onFilter": "onFilter"; }, never>;
}