devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
490 lines (359 loc) • 14.3 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, QueryList } from '@angular/core';
import { animationConfig } from 'devextreme/animation/fx';
import DevExpress from 'devextreme/bundles/dx.all';
import DxPopup from 'devextreme/ui/popup';
import { DxComponent, DxTemplateHost, NestedOptionHost, IterableDifferHelper, WatcherHelper } from 'devextreme-angular/core';
import { DxiToolbarItemComponent } from 'devextreme-angular/ui/nested';
/**
* The Popup UI component is a pop-up window overlaying the current view.
*/
export declare class DxPopupComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
private _watcherHelper;
private _idh;
instance: DxPopup;
/**
* Specifies the shortcut key that sets focus on the UI component.
*/
accessKey: string;
/**
* Configures UI component visibility animations. This object contains two fields: show and hide.
*/
animation: {
hide?: animationConfig;
show?: animationConfig;
};
/**
* Specifies whether to close the UI component if a user clicks outside it.
*/
closeOnOutsideClick: boolean | Function;
/**
* Specifies the container in which to render the UI component.
*/
container: Element | JQuery | string;
/**
* Specifies a custom template for the UI component content.
*/
contentTemplate: any;
/**
* Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
*/
deferRendering: boolean;
/**
* Specifies whether the UI component responds to user interaction.
*/
disabled: boolean;
/**
* Specifies whether or not to allow a user to drag the popup window.
*/
dragEnabled: 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;
/**
* Specifies whether to display the Popup in full-screen mode.
*/
fullScreen: boolean;
/**
* Specifies the UI component's height in pixels.
*/
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 maximum height the UI component can reach while resizing.
*/
maxHeight: number | Function | string;
/**
* Specifies the maximum width the UI component can reach while resizing.
*/
maxWidth: number | Function | string;
/**
* Specifies the minimum height the UI component can reach while resizing.
*/
minHeight: number | Function | string;
/**
* Specifies the minimum width the UI component can reach while resizing.
*/
minWidth: number | Function | string;
/**
* Positions the UI component.
*/
position: DevExpress.positionConfig | Function | string;
/**
* Specifies whether or not an end user can resize the UI component.
*/
resizeEnabled: boolean;
/**
* Switches the UI component to a right-to-left representation.
*/
rtlEnabled: boolean;
/**
* Specifies whether to shade the background when the UI component is active.
*/
shading: boolean;
/**
* Specifies the shading color. Applies only if shading is enabled.
*/
shadingColor: string;
/**
* Specifies whether or not the UI component displays the Close button.
*/
showCloseButton: boolean;
/**
* A Boolean value specifying whether or not to display the title in the popup window.
*/
showTitle: boolean;
/**
* Specifies the number of the element when the Tab key is used for navigating.
*/
tabIndex: number;
/**
* The title in the overlay window.
*/
title: string;
/**
* Specifies a custom template for the UI component title. Does not apply if the title is defined.
*/
titleTemplate: any;
/**
* Configures toolbar items.
*/
toolbarItems: Array<any | {
disabled?: boolean;
html?: string;
location?: string;
options?: any;
template?: any;
text?: string;
toolbar?: string;
visible?: boolean;
widget?: string;
}>;
/**
* A Boolean value specifying whether or not the UI component is visible.
*/
visible: boolean;
/**
* Specifies the UI component's width in pixels.
*/
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 the UI component is hidden.
*/
onHidden: EventEmitter<any>;
/**
* A function that is executed before the UI component is hidden.
*/
onHiding: 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 each time the UI component is resized by one pixel.
*/
onResize: EventEmitter<any>;
/**
* A function that is executed when resizing ends.
*/
onResizeEnd: EventEmitter<any>;
/**
* A function that is executed when resizing starts.
*/
onResizeStart: EventEmitter<any>;
/**
* A function that is executed before the UI component is displayed.
*/
onShowing: EventEmitter<any>;
/**
* A function that is executed after the UI component is displayed.
*/
onShown: EventEmitter<any>;
/**
* A function that is executed when the UI component's title is rendered.
*/
onTitleRendered: 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.
*/
animationChange: EventEmitter<{
hide?: animationConfig;
show?: animationConfig;
}>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
closeOnOutsideClickChange: EventEmitter<boolean | Function>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
containerChange: EventEmitter<Element | JQuery | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
contentTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
deferRenderingChange: EventEmitter<boolean>;
/**
* 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.
*/
dragEnabledChange: 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.
*/
fullScreenChange: EventEmitter<boolean>;
/**
* 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.
*/
maxHeightChange: EventEmitter<number | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
maxWidthChange: EventEmitter<number | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
minHeightChange: EventEmitter<number | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
minWidthChange: EventEmitter<number | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
positionChange: EventEmitter<DevExpress.positionConfig | Function | string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
resizeEnabledChange: EventEmitter<boolean>;
/**
* 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.
*/
shadingChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
shadingColorChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showCloseButtonChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showTitleChange: 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.
*/
titleChange: EventEmitter<string>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
titleTemplateChange: EventEmitter<any>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
toolbarItemsChange: EventEmitter<Array<any | {
disabled?: boolean;
html?: string;
location?: string;
options?: any;
template?: any;
text?: string;
toolbar?: string;
visible?: boolean;
widget?: 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>;
toolbarItemsChildren: QueryList<DxiToolbarItemComponent>;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxPopup;
ngOnDestroy(): void;
ngOnChanges(changes: SimpleChanges): void;
setupChanges(prop: string, changes: SimpleChanges): void;
ngDoCheck(): void;
_setOption(name: string, value: any): void;
}
export declare class DxPopupModule {
}