devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
325 lines (248 loc) • 10 kB
TypeScript
/*!
* 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 } from '@angular/core';
import DevExpress from 'devextreme/bundles/dx.all';
import DxPivotGridFieldChooser from 'devextreme/ui/pivot_grid_field_chooser';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } 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.
*/
accessKey: string;
/**
* Specifies whether or not the UI component changes its state when interacting with a user.
*/
activeStateEnabled: boolean;
/**
* Specifies whether the field chooser allows searching in the 'All Fields' section.
*/
allowSearch: boolean;
/**
* Specifies when to apply changes made in the UI component to the PivotGrid.
*/
applyChangesMode: string;
/**
* The data source of a PivotGrid UI component.
*/
dataSource: DevExpress.data.PivotGridDataSource;
/**
* 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;
/**
* Specifies whether the UI component can be focused using keyboard navigation.
*/
focusStateEnabled: boolean;
/**
* Configures the header filter feature.
*/
headerFilter: {
allowSearch?: boolean;
height?: number;
searchTimeout?: number;
showRelevantValues?: boolean;
texts?: {
cancel?: string;
emptyValue?: string;
ok?: string;
};
width?: number;
};
/**
* 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 the field chooser layout.
*/
layout: number | string;
/**
* Switches the UI component to a right-to-left representation.
*/
rtlEnabled: 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.
*/
searchTimeout: number;
/**
* The UI component's state.
*/
state: any;
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
tabIndex: number;
/**
* Strings that can be changed or localized in the PivotGridFieldChooser UI component.
*/
texts: {
allFields?: string;
columnFields?: string;
dataFields?: string;
filterFields?: string;
rowFields?: string;
};
/**
* 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 context menu is rendered.
*/
onContextMenuPreparing: EventEmitter<any>;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing: 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>;
/**
* 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.
*/
allowSearchChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
applyChangesModeChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
dataSourceChange: EventEmitter<DevExpress.data.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<any>;
/**
* 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;
height?: number;
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 | 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.
*/
layoutChange: EventEmitter<number | string>;
/**
* 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 | Function | string>;
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;
}
export declare class DxPivotGridFieldChooserModule {
}