/** * DevExtreme (ui/pivot_grid_field_chooser.d.ts) * Version: 21.1.7 * Build date: Thu Aug 07 2025 * * Copyright (c) 2012 - 2025 Developer Express Inc. ALL RIGHTS RESERVED * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/ */ import { UserDefinedElement, } from '../core/element'; import { DxEvent, EventInfo, InitializedEventInfo, ChangedOptionInfo, } from '../events/index'; import PivotGridDataSource, { Field, } from './pivot_grid/data_source'; import Widget, { WidgetOptions, } from './widget/ui.widget'; /** @public */ export type ContentReadyEvent = EventInfo; /** @public */ export type ContextMenuPreparingEvent = EventInfo & { readonly area?: string; readonly field?: Field; readonly event?: DxEvent; items?: Array; }; /** @public */ export type DisposingEvent = EventInfo; /** @public */ export type InitializedEvent = InitializedEventInfo; /** @public */ export type OptionChangedEvent = EventInfo & ChangedOptionInfo; /** * @deprecated use Properties instead * @namespace DevExpress.ui */ export interface dxPivotGridFieldChooserOptions extends WidgetOptions { /** * @docid * @default false * @public */ allowSearch?: boolean; /** * @docid * @type Enums.ApplyChangesMode * @default "instantly" * @public */ applyChangesMode?: 'instantly' | 'onDemand'; /** * @docid * @default null * @ref * @public */ dataSource?: PivotGridDataSource; /** * @docid * @public */ headerFilter?: { /** * @docid * @default undefined */ allowSearch?: boolean; /** * @docid * @default 325 */ height?: number; /** * @docid * @default 500 */ searchTimeout?: number; /** * @docid * @default false */ showRelevantValues?: boolean; /** * @docid */ texts?: { /** * @docid * @default "Cancel" */ cancel?: string; /** * @docid * @default "(Blanks)" */ emptyValue?: string; /** * @docid * @default "Ok" */ ok?: string; }; /** * @docid * @default 252 */ width?: number; }; /** * @docid * @default 400 * @public */ height?: number | string | (() => number | string); /** * @docid * @type Enums.PivotGridFieldChooserLayout * @default 0 * @public */ layout?: 0 | 1 | 2; /** * @docid * @type_function_param1 e:object * @type_function_param1_field4 items:Array * @type_function_param1_field5 area:string * @type_function_param1_field6 field:PivotGridDataSourceOptions.fields * @type_function_param1_field7 event:event * @default null * @type_function_param1_field1 component:dxPivotGridFieldChooser * @type_function_param1_field2 element:DxElement * @type_function_param1_field3 model:any * @action * @public */ onContextMenuPreparing?: ((e: ContextMenuPreparingEvent) => void); /** * @docid * @default 500 * @public */ searchTimeout?: number; /** * @docid * @default null * @public */ state?: any; /** * @docid * @public */ texts?: { /** * @docid * @default 'All Fields' */ allFields?: string; /** * @docid * @default 'Column Fields' */ columnFields?: string; /** * @docid * @default 'Data Fields' */ dataFields?: string; /** * @docid * @default 'Filter Fields' */ filterFields?: string; /** * @docid * @default 'Row Fields' */ rowFields?: string; }; } /** * @docid * @inherits Widget * @namespace DevExpress.ui * @public */ export default class dxPivotGridFieldChooser extends Widget { constructor(element: UserDefinedElement, options?: dxPivotGridFieldChooserOptions) /** * @docid * @publicName applyChanges() * @public */ applyChanges(): void; /** * @docid * @publicName cancelChanges() * @public */ cancelChanges(): void; /** * @docid * @publicName getDataSource() * @public */ getDataSource(): PivotGridDataSource; /** * @docid * @publicName updateDimensions() * @public */ updateDimensions(): void; } /** @public */ export type Properties = dxPivotGridFieldChooserOptions; /** @deprecated use Properties instead */ export type Options = dxPivotGridFieldChooserOptions; /** @deprecated use Properties instead */ export type IOptions = dxPivotGridFieldChooserOptions;