UNPKG

devextreme-angular

Version:

Angular UI and visualization components based on DevExtreme widgets

400 lines (314 loc) 15.5 kB
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'; import * as i0 from "@angular/core"; import * as i1 from "devextreme-angular/ui/nested"; import * as i2 from "devextreme-angular/core"; import * as i3 from "@angular/platform-browser"; /** * 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. */ get accessKey(): string | undefined; set accessKey(value: string | undefined); /** * Specifies whether the UI component changes its visual state as a result of user interaction. */ get activeStateEnabled(): boolean; set activeStateEnabled(value: boolean); /** * Specifies whether the UI component can display hierarchical data fields. */ get allowHierarchicalFields(): boolean; set allowHierarchicalFields(value: boolean); /** * Configures custom filter operations. */ get customOperations(): Array<DevExpress.ui.dxFilterBuilderCustomOperation>; set customOperations(value: Array<DevExpress.ui.dxFilterBuilderCustomOperation>); /** * Specifies whether the UI component responds to user interaction. */ get disabled(): boolean; set disabled(value: boolean); /** * Specifies the global attributes to be attached to the UI component&apos;s container element. */ get elementAttr(): any; set elementAttr(value: any); /** * Configures fields. */ get fields(): Array<DevExpress.ui.dxFilterBuilderField>; set fields(value: Array<DevExpress.ui.dxFilterBuilderField>); /** * Specifies filter operation descriptions. */ get 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; }; set filterOperationDescriptions(value: { 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. */ get focusStateEnabled(): boolean; set focusStateEnabled(value: boolean); /** * Specifies group operation descriptions. */ get groupOperationDescriptions(): { and?: string; notAnd?: string; notOr?: string; or?: string; }; set groupOperationDescriptions(value: { and?: string; notAnd?: string; notOr?: string; or?: string; }); /** * Specifies a set of available group operations. */ get groupOperations(): Array<string>; set groupOperations(value: Array<string>); /** * Specifies the UI component&apos;s height. */ get height(): number | Function | string | undefined; set height(value: number | Function | string | undefined); /** * Specifies text for a hint that appears when a user pauses on the UI component. */ get hint(): string | undefined; set hint(value: string | undefined); /** * Specifies whether the UI component changes its state when a user pauses on it. */ get hoverStateEnabled(): boolean; set hoverStateEnabled(value: boolean); /** * Specifies groups&apos; maximum nesting level. */ get maxGroupLevel(): number | undefined; set maxGroupLevel(value: number | undefined); /** * Switches the UI component to a right-to-left representation. */ get rtlEnabled(): boolean; set rtlEnabled(value: boolean); /** * Specifies the number of the element when the Tab key is used for navigating. */ get tabIndex(): number; set tabIndex(value: number); /** * Allows you to specify a filter. */ get value(): any; set value(value: any); /** * Specifies whether the UI component is visible. */ get visible(): boolean; set visible(value: boolean); /** * Specifies the UI component&apos;s width. */ get width(): number | Function | string | undefined; set width(value: number | Function | string | undefined); /** * A function that is executed when the UI component is rendered and each time the component is repainted. */ 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&apos;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 | undefined>; /** * 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 | undefined>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ hintChange: EventEmitter<string | undefined>; /** * 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 | undefined>; /** * 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 | undefined>; /** * */ onBlur: EventEmitter<any>; change(_: any): void; touched: (_: any) => void; get customOperationsChildren(): QueryList<DxiCustomOperationComponent>; set customOperationsChildren(value: QueryList<DxiCustomOperationComponent>); get fieldsChildren(): QueryList<DxiFieldComponent>; set fieldsChildren(value: 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; static ɵfac: i0.ɵɵFactoryDeclaration<DxFilterBuilderComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<DxFilterBuilderComponent, "dx-filter-builder", never, { "accessKey": "accessKey"; "activeStateEnabled": "activeStateEnabled"; "allowHierarchicalFields": "allowHierarchicalFields"; "customOperations": "customOperations"; "disabled": "disabled"; "elementAttr": "elementAttr"; "fields": "fields"; "filterOperationDescriptions": "filterOperationDescriptions"; "focusStateEnabled": "focusStateEnabled"; "groupOperationDescriptions": "groupOperationDescriptions"; "groupOperations": "groupOperations"; "height": "height"; "hint": "hint"; "hoverStateEnabled": "hoverStateEnabled"; "maxGroupLevel": "maxGroupLevel"; "rtlEnabled": "rtlEnabled"; "tabIndex": "tabIndex"; "value": "value"; "visible": "visible"; "width": "width"; }, { "onContentReady": "onContentReady"; "onDisposing": "onDisposing"; "onEditorPrepared": "onEditorPrepared"; "onEditorPreparing": "onEditorPreparing"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "onValueChanged": "onValueChanged"; "accessKeyChange": "accessKeyChange"; "activeStateEnabledChange": "activeStateEnabledChange"; "allowHierarchicalFieldsChange": "allowHierarchicalFieldsChange"; "customOperationsChange": "customOperationsChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "fieldsChange": "fieldsChange"; "filterOperationDescriptionsChange": "filterOperationDescriptionsChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "groupOperationDescriptionsChange": "groupOperationDescriptionsChange"; "groupOperationsChange": "groupOperationsChange"; "heightChange": "heightChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "maxGroupLevelChange": "maxGroupLevelChange"; "rtlEnabledChange": "rtlEnabledChange"; "tabIndexChange": "tabIndexChange"; "valueChange": "valueChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; "onBlur": "onBlur"; }, ["customOperationsChildren", "fieldsChildren"], never>; } export declare class DxFilterBuilderModule { static ɵfac: i0.ɵɵFactoryDeclaration<DxFilterBuilderModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<DxFilterBuilderModule, [typeof DxFilterBuilderComponent], [typeof i1.DxiCustomOperationModule, typeof i1.DxiFieldModule, typeof i1.DxoFormatModule, typeof i1.DxoLookupModule, typeof i1.DxoFilterOperationDescriptionsModule, typeof i1.DxoGroupOperationDescriptionsModule, typeof i2.DxIntegrationModule, typeof i2.DxTemplateModule, typeof i3.BrowserTransferStateModule], [typeof DxFilterBuilderComponent, typeof i1.DxiCustomOperationModule, typeof i1.DxiFieldModule, typeof i1.DxoFormatModule, typeof i1.DxoLookupModule, typeof i1.DxoFilterOperationDescriptionsModule, typeof i1.DxoGroupOperationDescriptionsModule, typeof i2.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxFilterBuilderModule>; }