devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
357 lines (259 loc) • 10.6 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 } from '@angular/core';
import { animationConfig } from 'devextreme/animation/fx';
import DevExpress from 'devextreme/bundles/dx.all';
import DxLoadPanel from 'devextreme/ui/load_panel';
import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } from 'devextreme-angular/core';
/**
* The LoadPanel is an overlay UI component notifying the viewer that loading is in progress.
*/
export declare class DxLoadPanelComponent extends DxComponent implements OnDestroy {
instance: DxLoadPanel;
/**
* 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 UI component's container.
*/
container: Element | JQuery | string;
/**
* Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
*/
deferRendering: boolean;
/**
* The delay in milliseconds after which the load panel is displayed.
*/
delay: number;
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
elementAttr: any;
/**
* Specifies whether or not the UI component can be focused.
*/
focusStateEnabled: 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;
/**
* A URL pointing to an image to be used as a load indicator.
*/
indicatorSrc: string;
/**
* 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 text displayed in the load panel. Ignored in the Material Design theme.
*/
message: 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;
/**
* 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;
/**
* A Boolean value specifying whether or not to show a load indicator.
*/
showIndicator: boolean;
/**
* A Boolean value specifying whether or not to show the pane behind the load indicator.
*/
showPane: boolean;
/**
* 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 before the UI component is displayed.
*/
onShowing: EventEmitter<any>;
/**
* A function that is executed after the UI component is displayed.
*/
onShown: EventEmitter<any>;
/**
* 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.
*/
deferRenderingChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
delayChange: EventEmitter<number>;
/**
* 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.
*/
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.
*/
indicatorSrcChange: EventEmitter<string>;
/**
* 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.
*/
messageChange: EventEmitter<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.
*/
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.
*/
showIndicatorChange: EventEmitter<boolean>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
showPaneChange: EventEmitter<boolean>;
/**
* 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, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxLoadPanel;
ngOnDestroy(): void;
}
export declare class DxLoadPanelModule {
}