devextreme-angular
Version:
Angular UI and visualization components based on DevExtreme widgets
436 lines (323 loc) • 17.1 kB
TypeScript
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 { UserDefinedElement } from 'devextreme/core/element';
import DxLoadPanel from 'devextreme/ui/load_panel';
import { DxComponent, DxTemplateHost, NestedOptionHost, WatcherHelper } from 'devextreme-angular/core';
import * as i0 from "@angular/core";
import * as i1 from "devextreme-angular/ui/nested";
import * as i2 from "devextreme-angular/core";
import * as i3 from "@angular/platform-browser";
/**
* 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.
*/
get animation(): {
hide?: AnimationConfig;
show?: AnimationConfig;
};
set animation(value: {
hide?: AnimationConfig;
show?: AnimationConfig;
});
/**
* Specifies whether to close the UI component if a user clicks outside it.
* @deprecated Use the hideOnOutsideClick option instead.
*/
get closeOnOutsideClick(): boolean | Function;
set closeOnOutsideClick(value: boolean | Function);
/**
* Specifies the UI component's container.
*/
get container(): string | UserDefinedElement | undefined;
set container(value: string | UserDefinedElement | undefined);
/**
* Copies your custom CSS classes from the root element to the wrapper element.
* @deprecated Use the wrapperAttr property instead.
*/
get copyRootClassesToWrapper(): boolean;
set copyRootClassesToWrapper(value: boolean);
/**
* Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
*/
get deferRendering(): boolean;
set deferRendering(value: boolean);
/**
* The delay in milliseconds after which the load panel is displayed.
*/
get delay(): number;
set delay(value: number);
/**
* Specifies the global attributes to be attached to the UI component's container element.
* @deprecated Use the wrapperAttr option instead.
*/
get elementAttr(): any;
set elementAttr(value: any);
/**
* Specifies whether or not the UI component can be focused.
*/
get focusStateEnabled(): boolean;
set focusStateEnabled(value: boolean);
/**
* Specifies the UI component's height.
*/
get height(): number | Function | string;
set height(value: number | Function | string);
/**
* Specifies whether to hide the UI component if a user clicks outside it.
*/
get hideOnOutsideClick(): boolean | Function;
set hideOnOutsideClick(value: boolean | Function);
/**
* Specifies whether to hide the widget when users scroll one of its parent elements.
*/
get hideOnParentScroll(): boolean;
set hideOnParentScroll(value: boolean);
/**
* 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);
/**
* A URL pointing to an image to be used as a load indicator.
*/
get indicatorSrc(): string;
set indicatorSrc(value: string);
/**
* Specifies the maximum height the UI component can reach while resizing.
*/
get maxHeight(): number | Function | string;
set maxHeight(value: number | Function | string);
/**
* Specifies the maximum width the UI component can reach while resizing.
*/
get maxWidth(): number | Function | string;
set maxWidth(value: number | Function | string);
/**
* Specifies the text displayed in the load panel. Ignored in the Material Design theme.
*/
get message(): string;
set message(value: string);
/**
* Specifies the minimum height the UI component can reach while resizing.
*/
get minHeight(): number | Function | string;
set minHeight(value: number | Function | string);
/**
* Specifies the minimum width the UI component can reach while resizing.
*/
get minWidth(): number | Function | string;
set minWidth(value: number | Function | string);
/**
* Positions the UI component.
*/
get position(): DevExpress.PositionConfig | Function | string;
set position(value: DevExpress.PositionConfig | Function | string);
/**
* Switches the UI component to a right-to-left representation.
*/
get rtlEnabled(): boolean;
set rtlEnabled(value: boolean);
/**
* Specifies whether to shade the background when the UI component is active.
*/
get shading(): boolean;
set shading(value: boolean);
/**
* Specifies the shading color. Applies only if shading is enabled.
*/
get shadingColor(): string;
set shadingColor(value: string);
/**
* A Boolean value specifying whether or not to show a load indicator.
*/
get showIndicator(): boolean;
set showIndicator(value: boolean);
/**
* A Boolean value specifying whether or not to show the pane behind the load indicator.
*/
get showPane(): boolean;
set showPane(value: boolean);
/**
* A Boolean value specifying whether or not the UI component is visible.
*/
get visible(): boolean;
set visible(value: boolean);
/**
* Specifies the UI component's width.
*/
get width(): number | Function | string;
set width(value: number | Function | string);
/**
* Specifies the global attributes for the UI component's wrapper element.
*/
get wrapperAttr(): any;
set wrapperAttr(value: any);
/**
* A function that is executed when the UI component is rendered and each time the component is repainted.
*/
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<string | UserDefinedElement | undefined>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
copyRootClassesToWrapperChange: EventEmitter<boolean>;
/**
* 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.
*/
hideOnOutsideClickChange: EventEmitter<boolean | Function>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
hideOnParentScrollChange: EventEmitter<boolean>;
/**
* 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.
*/
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>;
/**
* This member supports the internal infrastructure and is not intended to be used directly from your code.
*/
wrapperAttrChange: EventEmitter<any>;
constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
protected _createInstance(element: any, options: any): DxLoadPanel;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<DxLoadPanelComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DxLoadPanelComponent, "dx-load-panel", never, { "animation": "animation"; "closeOnOutsideClick": "closeOnOutsideClick"; "container": "container"; "copyRootClassesToWrapper": "copyRootClassesToWrapper"; "deferRendering": "deferRendering"; "delay": "delay"; "elementAttr": "elementAttr"; "focusStateEnabled": "focusStateEnabled"; "height": "height"; "hideOnOutsideClick": "hideOnOutsideClick"; "hideOnParentScroll": "hideOnParentScroll"; "hint": "hint"; "hoverStateEnabled": "hoverStateEnabled"; "indicatorSrc": "indicatorSrc"; "maxHeight": "maxHeight"; "maxWidth": "maxWidth"; "message": "message"; "minHeight": "minHeight"; "minWidth": "minWidth"; "position": "position"; "rtlEnabled": "rtlEnabled"; "shading": "shading"; "shadingColor": "shadingColor"; "showIndicator": "showIndicator"; "showPane": "showPane"; "visible": "visible"; "width": "width"; "wrapperAttr": "wrapperAttr"; }, { "onContentReady": "onContentReady"; "onDisposing": "onDisposing"; "onHidden": "onHidden"; "onHiding": "onHiding"; "onInitialized": "onInitialized"; "onOptionChanged": "onOptionChanged"; "onShowing": "onShowing"; "onShown": "onShown"; "animationChange": "animationChange"; "closeOnOutsideClickChange": "closeOnOutsideClickChange"; "containerChange": "containerChange"; "copyRootClassesToWrapperChange": "copyRootClassesToWrapperChange"; "deferRenderingChange": "deferRenderingChange"; "delayChange": "delayChange"; "elementAttrChange": "elementAttrChange"; "focusStateEnabledChange": "focusStateEnabledChange"; "heightChange": "heightChange"; "hideOnOutsideClickChange": "hideOnOutsideClickChange"; "hideOnParentScrollChange": "hideOnParentScrollChange"; "hintChange": "hintChange"; "hoverStateEnabledChange": "hoverStateEnabledChange"; "indicatorSrcChange": "indicatorSrcChange"; "maxHeightChange": "maxHeightChange"; "maxWidthChange": "maxWidthChange"; "messageChange": "messageChange"; "minHeightChange": "minHeightChange"; "minWidthChange": "minWidthChange"; "positionChange": "positionChange"; "rtlEnabledChange": "rtlEnabledChange"; "shadingChange": "shadingChange"; "shadingColorChange": "shadingColorChange"; "showIndicatorChange": "showIndicatorChange"; "showPaneChange": "showPaneChange"; "visibleChange": "visibleChange"; "widthChange": "widthChange"; "wrapperAttrChange": "wrapperAttrChange"; }, never, never>;
}
export declare class DxLoadPanelModule {
static ɵfac: i0.ɵɵFactoryDeclaration<DxLoadPanelModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<DxLoadPanelModule, [typeof DxLoadPanelComponent], [typeof i1.DxoAnimationModule, typeof i1.DxoHideModule, typeof i1.DxoFromModule, typeof i1.DxoPositionModule, typeof i1.DxoAtModule, typeof i1.DxoBoundaryOffsetModule, typeof i1.DxoCollisionModule, typeof i1.DxoMyModule, typeof i1.DxoOffsetModule, typeof i1.DxoToModule, typeof i1.DxoShowModule, typeof i2.DxIntegrationModule, typeof i2.DxTemplateModule, typeof i3.BrowserTransferStateModule], [typeof DxLoadPanelComponent, typeof i1.DxoAnimationModule, typeof i1.DxoHideModule, typeof i1.DxoFromModule, typeof i1.DxoPositionModule, typeof i1.DxoAtModule, typeof i1.DxoBoundaryOffsetModule, typeof i1.DxoCollisionModule, typeof i1.DxoMyModule, typeof i1.DxoOffsetModule, typeof i1.DxoToModule, typeof i1.DxoShowModule, typeof i2.DxTemplateModule]>;
static ɵinj: i0.ɵɵInjectorDeclaration<DxLoadPanelModule>;
}