UNPKG

devextreme-angular

Version:

Angular UI and visualization components based on DevExtreme widgets

362 lines (276 loc) • 10.9 kB
/*! * devextreme-angular * Version: 20.2.5 * Build date: Fri Jan 15 2021 * * Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file in the root of the project for details. * * https://github.com/DevExpress/devextreme-angular */ import { TransferState } from '@angular/platform-browser'; import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core'; import DevExpress from 'devextreme/bundles/dx.all'; import DxFilterBuilder from 'devextreme/ui/filter_builder'; import { ControlValueAccessor } from '@angular/forms'; import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core'; import { DxiCustomOperationComponent } from 'devextreme-angular/ui/nested'; import { DxiFieldComponent } from 'devextreme-angular/ui/nested'; /** * The FilterBuilder UI component allows a user to build complex filter expressions with an unlimited number of filter conditions, combined by logical operations using the UI. */ export declare class DxFilterBuilderComponent extends DxComponent implements OnDestroy, ControlValueAccessor, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxFilterBuilder; /** * Specifies the shortcut key that sets focus on the UI component. */ accessKey: string; /** * Specifies whether or not the UI component changes its state when interacting with a user. */ activeStateEnabled: boolean; /** * Specifies whether the UI component can display hierarchical data fields. */ allowHierarchicalFields: boolean; /** * Configures custom filter operations. */ customOperations: Array<DevExpress.ui.dxFilterBuilderCustomOperation>; /** * Specifies whether the UI component responds to user interaction. */ disabled: boolean; /** * Specifies the global attributes to be attached to the UI component's container element. */ elementAttr: any; /** * Configures fields. */ fields: Array<DevExpress.ui.dxFilterBuilderField>; /** * Specifies filter operation descriptions. */ filterOperationDescriptions: { between?: string; contains?: string; endsWith?: string; equal?: string; greaterThan?: string; greaterThanOrEqual?: string; isBlank?: string; isNotBlank?: string; lessThan?: string; lessThanOrEqual?: string; notContains?: string; notEqual?: string; startsWith?: string; }; /** * Specifies whether the UI component can be focused using keyboard navigation. */ focusStateEnabled: boolean; /** * Specifies group operation descriptions. */ groupOperationDescriptions: { and?: string; notAnd?: string; notOr?: string; or?: string; }; /** * Specifies a set of available group operations. */ groupOperations: Array<string>; /** * Specifies the UI component's height. */ height: number | Function | string; /** * Specifies text for a hint that appears when a user pauses on the UI component. */ hint: string; /** * Specifies whether the UI component changes its state when a user pauses on it. */ hoverStateEnabled: boolean; /** * Specifies groups' maximum nesting level. */ maxGroupLevel: number; /** * Switches the UI component to a right-to-left representation. */ rtlEnabled: boolean; /** * Specifies the number of the element when the Tab key is used for navigating. */ tabIndex: number; /** * Allows you to specify a filter. */ value: any; /** * Specifies whether the UI component is visible. */ visible: boolean; /** * Specifies the UI component's width. */ width: number | Function | string; /** * A function that is executed when the UI component's content is ready and each time the content is changed. */ onContentReady: EventEmitter<any>; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<any>; /** * A function that is executed after an editor is created. */ onEditorPrepared: EventEmitter<any>; /** * A function that is executed before an editor is created. */ onEditorPreparing: EventEmitter<any>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<any>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<any>; /** * A function that is executed after the UI component's value is changed. */ onValueChanged: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ accessKeyChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ activeStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ allowHierarchicalFieldsChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ customOperationsChange: EventEmitter<Array<DevExpress.ui.dxFilterBuilderCustomOperation>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ disabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ elementAttrChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ fieldsChange: EventEmitter<Array<DevExpress.ui.dxFilterBuilderField>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ filterOperationDescriptionsChange: EventEmitter<{ between?: string; contains?: string; endsWith?: string; equal?: string; greaterThan?: string; greaterThanOrEqual?: string; isBlank?: string; isNotBlank?: string; lessThan?: string; lessThanOrEqual?: string; notContains?: string; notEqual?: string; startsWith?: string; }>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ focusStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ groupOperationDescriptionsChange: EventEmitter<{ and?: string; notAnd?: string; notOr?: string; or?: string; }>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ groupOperationsChange: EventEmitter<Array<string>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<number | Function | string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter<string>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hoverStateEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ maxGroupLevelChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ rtlEnabledChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ tabIndexChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ valueChange: EventEmitter<any>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ visibleChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ widthChange: EventEmitter<number | Function | string>; /** * */ onBlur: EventEmitter<any>; change(_: any): void; touched: (_: any) => void; customOperationsChildren: QueryList<DxiCustomOperationComponent>; fieldsChildren: QueryList<DxiFieldComponent>; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxFilterBuilder; writeValue(value: any): void; setDisabledState(isDisabled: boolean): void; registerOnChange(fn: (_: any) => void): void; registerOnTouched(fn: () => void): void; _createWidget(element: any): void; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; } export declare class DxFilterBuilderModule { }