devextreme-angular

/*! * devextreme-angular * Version: 24.2.6 * Build date: Mon Mar 17 2025 * * Copyright (c) 2012 - 2025 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, ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges } from '@angular/core'; import PivotGridDataSource from 'devextreme/ui/pivot_grid/data_source'; import { ApplyChangesMode, HeaderFilterSearchConfig } from 'devextreme/common/grids'; import { FieldChooserLayout } from 'devextreme/common'; import { ContentReadyEvent, ContextMenuPreparingEvent, DisposingEvent, InitializedEvent, OptionChangedEvent } from 'devextreme/ui/pivot_grid_field_chooser'; import DxPivotGridFieldChooser from 'devextreme/ui/pivot_grid_field_chooser'; import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core'; import type * as DxPivotGridFieldChooserTypes from "devextreme/ui/pivot_grid_field_chooser_types"; import * as i0 from "@angular/core"; import * as i1 from "devextreme-angular/ui/nested"; import * as i2 from "devextreme-angular/ui/pivot-grid-field-chooser/nested"; import * as i3 from "devextreme-angular/core"; /** * A complementary UI component for the PivotGrid that allows you to manage data displayed in the PivotGrid. The field chooser is already integrated in the PivotGrid and can be invoked using the context menu. If you need to continuously display the field chooser near the PivotGrid UI component, use the PivotGridFieldChooser UI component. */ export declare class DxPivotGridFieldChooserComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck { private _watcherHelper; private _idh; instance: DxPivotGridFieldChooser; /** * 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 field chooser allows search operations in the 'All Fields' section. */ get allowSearch(): boolean; set allowSearch(value: boolean); /** * Specifies when to apply changes made in the UI component to the PivotGrid. */ get applyChangesMode(): ApplyChangesMode; set applyChangesMode(value: ApplyChangesMode); /** * The data source of a PivotGrid UI component. */ get dataSource(): null | PivotGridDataSource; set dataSource(value: null | PivotGridDataSource); /** * 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's container element. */ get elementAttr(): Record<string, any>; set elementAttr(value: Record<string, any>); /** * Specifies whether HTML tags are displayed as plain text or applied to the values of the header filter. */ get encodeHtml(): boolean; set encodeHtml(value: boolean); /** * Specifies whether the UI component can be focused using keyboard navigation. */ get focusStateEnabled(): boolean; set focusStateEnabled(value: boolean); /** * Configures the header filter feature. */ get headerFilter(): { allowSearch?: boolean; allowSelectAll?: boolean; height?: number; search?: HeaderFilterSearchConfig; searchTimeout?: number; showRelevantValues?: boolean; texts?: { cancel?: string; emptyValue?: string; ok?: string; }; width?: number; }; set headerFilter(value: { allowSearch?: boolean; allowSelectAll?: boolean; height?: number; search?: HeaderFilterSearchConfig; searchTimeout?: number; showRelevantValues?: boolean; texts?: { cancel?: string; emptyValue?: string; ok?: string; }; width?: number; }); /** * Specifies the UI component's height. */ get height(): (() => number | string) | number | string; set height(value: (() => number | string) | number | string); /** * 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 the field chooser layout. */ get layout(): FieldChooserLayout; set layout(value: FieldChooserLayout); /** * Switches the UI component to a right-to-left representation. */ get rtlEnabled(): boolean; set rtlEnabled(value: boolean); /** * Specifies a delay in milliseconds between when a user finishes typing in the field chooser's search panel, and when the search is executed. */ get searchTimeout(): number; set searchTimeout(value: number); /** * The UI component's state. */ get state(): any; set state(value: any); /** * Specifies the number of the element when the Tab key is used for navigating. */ get tabIndex(): number; set tabIndex(value: number); /** * Strings that can be changed or localized in the PivotGridFieldChooser UI component. */ get texts(): { allFields?: string; columnFields?: string; dataFields?: string; filterFields?: string; rowFields?: string; }; set texts(value: { allFields?: string; columnFields?: string; dataFields?: string; filterFields?: string; rowFields?: string; }); /** * Specifies whether the UI component is visible. */ get visible(): boolean; set visible(value: boolean); /** * Specifies the UI component's width. */ get width(): (() => number | string) | number | string | undefined; set width(value: (() => number | string) | number | string | undefined); /** * A function that is executed when the UI component is rendered and each time the component is repainted. */ onContentReady: EventEmitter<ContentReadyEvent>; /** * A function that is executed before the context menu is rendered. */ onContextMenuPreparing: EventEmitter<ContextMenuPreparingEvent>; /** * A function that is executed before the UI component is disposed of. */ onDisposing: EventEmitter<DisposingEvent>; /** * A function used in JavaScript frameworks to save the UI component instance. */ onInitialized: EventEmitter<InitializedEvent>; /** * A function that is executed after a UI component property is changed. */ onOptionChanged: EventEmitter<OptionChangedEvent>; /** * 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. */ allowSearchChange: EventEmitter<boolean>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ applyChangesModeChange: EventEmitter<ApplyChangesMode>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ dataSourceChange: EventEmitter<null | PivotGridDataSource>; /** * 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<Record<string, any>>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ encodeHtmlChange: EventEmitter<boolean>; /** * 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. */ headerFilterChange: EventEmitter<{ allowSearch?: boolean; allowSelectAll?: boolean; height?: number; search?: HeaderFilterSearchConfig; searchTimeout?: number; showRelevantValues?: boolean; texts?: { cancel?: string; emptyValue?: string; ok?: string; }; width?: number; }>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ heightChange: EventEmitter<(() => number | string) | number | string>; /** * 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. */ layoutChange: EventEmitter<FieldChooserLayout>; /** * 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. */ searchTimeoutChange: EventEmitter<number>; /** * This member supports the internal infrastructure and is not intended to be used directly from your code. */ stateChange: EventEmitter<any>; /** * 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. */ textsChange: EventEmitter<{ allFields?: string; columnFields?: string; dataFields?: string; filterFields?: string; rowFields?: string; }>; /** * 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 | string) | number | string | undefined>; constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any); protected _createInstance(element: any, options: any): DxPivotGridFieldChooser; ngOnDestroy(): void; ngOnChanges(changes: SimpleChanges): void; setupChanges(prop: string, changes: SimpleChanges): void; ngDoCheck(): void; _setOption(name: string, value: any): void; static ɵfac: i0.ɵɵFactoryDeclaration<DxPivotGridFieldChooserComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<DxPivotGridFieldChooserComponent, "dx-pivot-grid-field-chooser", never, { "accessKey": { "alias": "accessKey"; "required": false; }; "activeStateEnabled": { "alias": "activeStateEnabled"; "required": false; }; "allowSearch": { "alias": "allowSearch"; "required": false; }; "applyChangesMode": { "alias": "applyChangesMode"; "required": false; }; "dataSource": { "alias": "dataSource"; "required": false; }; "disabled": { "alias": "disabled"; "required": false; }; "elementAttr": { "alias": "elementAttr"; "required": false; }; "encodeHtml": { "alias": "encodeHtml"; "required": false; }; "focusStateEnabled": { "alias": "focusStateEnabled"; "required": false; }; "headerFilter": { "alias": "headerFilter"; "required": false; }; "height": { "alias": "height"; "required": false; }; "hint": { "alias": "hint"; "required": false; }; "hoverStateEnabled": { "alias": "hoverStateEnabled"; "required": false; }; "layout": { "alias": "layout"; "required": false; }; "rtlEnabled": { "alias": "rtlEnabled"; "required": false; }; "searchTimeout": { "alias": "searchTimeout"; "required": false; }; "state": { "alias": "state"; "required": false; }; "tabIndex": { "alias": "tabIndex"; "required": false; }; "texts": { "alias": "texts"; "required": false; }; "visible": { "alias": "visible"; "required": false; }; "width": { "alias": "width"; "required": false; }; }, { "onContentReady": "onContentReady"; "onContextMenuPreparing": "onContextMenuPreparing"; "onDisposing": "onDisposing"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "accessKeyChange": "accessKeyChange"; "activeStateEnabledChange": "activeStateEnabledChange"; "allowSearchChange": "allowSearchChange"; "applyChangesModeChange": "applyChangesModeChange"; "dataSourceChange": "dataSourceChange"; "disabledChange": "disabledChange"; "elementAttrChange": "elementAttrChange"; "encodeHtmlChange": "encodeHtmlChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "headerFilterChange": "headerFilterChange"; "heightChange": "heightChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "layoutChange": "layoutChange"; "rtlEnabledChange": "rtlEnabledChange"; "searchTimeoutChange": "searchTimeoutChange"; "stateChange": "stateChange"; "tabIndexChange": "tabIndexChange"; "textsChange": "textsChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; }, never, never, false, never>; } export declare class DxPivotGridFieldChooserModule { static ɵfac: i0.ɵɵFactoryDeclaration<DxPivotGridFieldChooserModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<DxPivotGridFieldChooserModule, [typeof DxPivotGridFieldChooserComponent], [typeof i1.DxoHeaderFilterModule, typeof i1.DxoSearchModule, typeof i1.DxoTextsModule, typeof i2.DxoPivotGridFieldChooserHeaderFilterModule, typeof i2.DxoPivotGridFieldChooserHeaderFilterTextsModule, typeof i2.DxoPivotGridFieldChooserPivotGridFieldChooserTextsModule, typeof i2.DxoPivotGridFieldChooserSearchModule, typeof i2.DxoPivotGridFieldChooserTextsModule, typeof i3.DxIntegrationModule, typeof i3.DxTemplateModule], [typeof DxPivotGridFieldChooserComponent, typeof i1.DxoHeaderFilterModule, typeof i1.DxoSearchModule, typeof i1.DxoTextsModule, typeof i2.DxoPivotGridFieldChooserHeaderFilterModule, typeof i2.DxoPivotGridFieldChooserHeaderFilterTextsModule, typeof i2.DxoPivotGridFieldChooserPivotGridFieldChooserTextsModule, typeof i2.DxoPivotGridFieldChooserSearchModule, typeof i2.DxoPivotGridFieldChooserTextsModule, typeof i3.DxTemplateModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<DxPivotGridFieldChooserModule>; } export { DxPivotGridFieldChooserTypes };