devextreme
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
1,376 lines (1,285 loc) • 1.32 MB
TypeScript
/*!
* DevExtreme (dx.all.d.ts)
* Version: 21.2.4
* Build date: Mon Dec 06 2021
*
* Copyright (c) 2012 - 2021 Developer Express Inc. ALL RIGHTS RESERVED
* Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/
*/
interface JQuery<TElement = HTMLElement> {}
interface JQuery<TElement = HTMLElement> {
dxAccordion(): JQuery;
dxAccordion(options: 'instance'): DevExpress.ui.dxAccordion;
dxAccordion(options: DevExpress.ui.dxAccordion.Properties): JQuery;
dxAccordion(options: string): any;
dxAccordion(options: string, ...params: any[]): any;
dxActionSheet(): JQuery;
dxActionSheet(options: 'instance'): DevExpress.ui.dxActionSheet;
dxActionSheet(options: DevExpress.ui.dxActionSheet.Properties): JQuery;
dxActionSheet(options: string): any;
dxActionSheet(options: string, ...params: any[]): any;
dxAutocomplete(): JQuery;
dxAutocomplete(options: 'instance'): DevExpress.ui.dxAutocomplete;
dxAutocomplete(options: DevExpress.ui.dxAutocomplete.Properties): JQuery;
dxAutocomplete(options: string): any;
dxAutocomplete(options: string, ...params: any[]): any;
dxBarGauge(): JQuery;
dxBarGauge(options: 'instance'): DevExpress.viz.dxBarGauge;
dxBarGauge(options: DevExpress.viz.dxBarGauge.Properties): JQuery;
dxBarGauge(options: string): any;
dxBarGauge(options: string, ...params: any[]): any;
dxBox(): JQuery;
dxBox(options: 'instance'): DevExpress.ui.dxBox;
dxBox(options: DevExpress.ui.dxBox.Properties): JQuery;
dxBox(options: string): any;
dxBox(options: string, ...params: any[]): any;
dxBullet(): JQuery;
dxBullet(options: 'instance'): DevExpress.viz.dxBullet;
dxBullet(options: DevExpress.viz.dxBullet.Properties): JQuery;
dxBullet(options: string): any;
dxBullet(options: string, ...params: any[]): any;
dxButton(): JQuery;
dxButton(options: 'instance'): DevExpress.ui.dxButton;
dxButton(options: DevExpress.ui.dxButton.Properties): JQuery;
dxButton(options: string): any;
dxButton(options: string, ...params: any[]): any;
dxButtonGroup(): JQuery;
dxButtonGroup(options: 'instance'): DevExpress.ui.dxButtonGroup;
dxButtonGroup(options: DevExpress.ui.dxButtonGroup.Properties): JQuery;
dxButtonGroup(options: string): any;
dxButtonGroup(options: string, ...params: any[]): any;
dxCalendar(): JQuery;
dxCalendar(options: 'instance'): DevExpress.ui.dxCalendar;
dxCalendar(options: DevExpress.ui.dxCalendar.Properties): JQuery;
dxCalendar(options: string): any;
dxCalendar(options: string, ...params: any[]): any;
dxChart(): JQuery;
dxChart(options: 'instance'): DevExpress.viz.dxChart;
dxChart(options: DevExpress.viz.dxChart.Properties): JQuery;
dxChart(options: string): any;
dxChart(options: string, ...params: any[]): any;
dxCheckBox(): JQuery;
dxCheckBox(options: 'instance'): DevExpress.ui.dxCheckBox;
dxCheckBox(options: DevExpress.ui.dxCheckBox.Properties): JQuery;
dxCheckBox(options: string): any;
dxCheckBox(options: string, ...params: any[]): any;
dxCircularGauge(): JQuery;
dxCircularGauge(options: 'instance'): DevExpress.viz.dxCircularGauge;
dxCircularGauge(options: DevExpress.viz.dxCircularGauge.Properties): JQuery;
dxCircularGauge(options: string): any;
dxCircularGauge(options: string, ...params: any[]): any;
dxColorBox(): JQuery;
dxColorBox(options: 'instance'): DevExpress.ui.dxColorBox;
dxColorBox(options: DevExpress.ui.dxColorBox.Properties): JQuery;
dxColorBox(options: string): any;
dxColorBox(options: string, ...params: any[]): any;
dxContextMenu(): JQuery;
dxContextMenu(options: 'instance'): DevExpress.ui.dxContextMenu;
dxContextMenu(options: DevExpress.ui.dxContextMenu.Properties): JQuery;
dxContextMenu(options: string): any;
dxContextMenu(options: string, ...params: any[]): any;
dxDataGrid(): JQuery;
dxDataGrid(options: 'instance'): DevExpress.ui.dxDataGrid;
dxDataGrid(options: DevExpress.ui.dxDataGrid.Properties): JQuery;
dxDataGrid(options: string): any;
dxDataGrid(options: string, ...params: any[]): any;
dxDateBox(): JQuery;
dxDateBox(options: 'instance'): DevExpress.ui.dxDateBox;
dxDateBox(options: DevExpress.ui.dxDateBox.Properties): JQuery;
dxDateBox(options: string): any;
dxDateBox(options: string, ...params: any[]): any;
dxDeferRendering(): JQuery;
dxDeferRendering(options: 'instance'): DevExpress.ui.dxDeferRendering;
dxDeferRendering(
options: DevExpress.ui.dxDeferRendering.Properties
): JQuery;
dxDeferRendering(options: string): any;
dxDeferRendering(options: string, ...params: any[]): any;
dxDiagram(): JQuery;
dxDiagram(options: 'instance'): DevExpress.ui.dxDiagram;
dxDiagram(options: DevExpress.ui.dxDiagram.Properties): JQuery;
dxDiagram(options: string): any;
dxDiagram(options: string, ...params: any[]): any;
dxDraggable(): JQuery;
dxDraggable(options: 'instance'): DevExpress.ui.dxDraggable;
dxDraggable(options: DevExpress.ui.dxDraggable.Properties): JQuery;
dxDraggable(options: string): any;
dxDraggable(options: string, ...params: any[]): any;
dxDrawer(): JQuery;
dxDrawer(options: 'instance'): DevExpress.ui.dxDrawer;
dxDrawer(options: DevExpress.ui.dxDrawer.Properties): JQuery;
dxDrawer(options: string): any;
dxDrawer(options: string, ...params: any[]): any;
dxDropDownBox(): JQuery;
dxDropDownBox(options: 'instance'): DevExpress.ui.dxDropDownBox;
dxDropDownBox(options: DevExpress.ui.dxDropDownBox.Properties): JQuery;
dxDropDownBox(options: string): any;
dxDropDownBox(options: string, ...params: any[]): any;
dxDropDownButton(): JQuery;
dxDropDownButton(options: 'instance'): DevExpress.ui.dxDropDownButton;
dxDropDownButton(
options: DevExpress.ui.dxDropDownButton.Properties
): JQuery;
dxDropDownButton(options: string): any;
dxDropDownButton(options: string, ...params: any[]): any;
dxFileManager(): JQuery;
dxFileManager(options: 'instance'): DevExpress.ui.dxFileManager;
dxFileManager(options: DevExpress.ui.dxFileManager.Properties): JQuery;
dxFileManager(options: string): any;
dxFileManager(options: string, ...params: any[]): any;
dxFileUploader(): JQuery;
dxFileUploader(options: 'instance'): DevExpress.ui.dxFileUploader;
dxFileUploader(options: DevExpress.ui.dxFileUploader.Properties): JQuery;
dxFileUploader(options: string): any;
dxFileUploader(options: string, ...params: any[]): any;
dxFilterBuilder(): JQuery;
dxFilterBuilder(options: 'instance'): DevExpress.ui.dxFilterBuilder;
dxFilterBuilder(options: DevExpress.ui.dxFilterBuilder.Properties): JQuery;
dxFilterBuilder(options: string): any;
dxFilterBuilder(options: string, ...params: any[]): any;
dxForm(): JQuery;
dxForm(options: 'instance'): DevExpress.ui.dxForm;
dxForm(options: DevExpress.ui.dxForm.Properties): JQuery;
dxForm(options: string): any;
dxForm(options: string, ...params: any[]): any;
dxFunnel(): JQuery;
dxFunnel(options: 'instance'): DevExpress.viz.dxFunnel;
dxFunnel(options: DevExpress.viz.dxFunnel.Properties): JQuery;
dxFunnel(options: string): any;
dxFunnel(options: string, ...params: any[]): any;
dxGallery(): JQuery;
dxGallery(options: 'instance'): DevExpress.ui.dxGallery;
dxGallery(options: DevExpress.ui.dxGallery.Properties): JQuery;
dxGallery(options: string): any;
dxGallery(options: string, ...params: any[]): any;
dxGantt(): JQuery;
dxGantt(options: 'instance'): DevExpress.ui.dxGantt;
dxGantt(options: DevExpress.ui.dxGantt.Properties): JQuery;
dxGantt(options: string): any;
dxGantt(options: string, ...params: any[]): any;
dxHtmlEditor(): JQuery;
dxHtmlEditor(options: 'instance'): DevExpress.ui.dxHtmlEditor;
dxHtmlEditor(options: DevExpress.ui.dxHtmlEditor.Properties): JQuery;
dxHtmlEditor(options: string): any;
dxHtmlEditor(options: string, ...params: any[]): any;
dxLinearGauge(): JQuery;
dxLinearGauge(options: 'instance'): DevExpress.viz.dxLinearGauge;
dxLinearGauge(options: DevExpress.viz.dxLinearGauge.Properties): JQuery;
dxLinearGauge(options: string): any;
dxLinearGauge(options: string, ...params: any[]): any;
dxList(): JQuery;
dxList(options: 'instance'): DevExpress.ui.dxList;
dxList(options: DevExpress.ui.dxList.Properties): JQuery;
dxList(options: string): any;
dxList(options: string, ...params: any[]): any;
dxLoadIndicator(): JQuery;
dxLoadIndicator(options: 'instance'): DevExpress.ui.dxLoadIndicator;
dxLoadIndicator(options: DevExpress.ui.dxLoadIndicator.Properties): JQuery;
dxLoadIndicator(options: string): any;
dxLoadIndicator(options: string, ...params: any[]): any;
dxLoadPanel(): JQuery;
dxLoadPanel(options: 'instance'): DevExpress.ui.dxLoadPanel;
dxLoadPanel(options: DevExpress.ui.dxLoadPanel.Properties): JQuery;
dxLoadPanel(options: string): any;
dxLoadPanel(options: string, ...params: any[]): any;
dxLookup(): JQuery;
dxLookup(options: 'instance'): DevExpress.ui.dxLookup;
dxLookup(options: DevExpress.ui.dxLookup.Properties): JQuery;
dxLookup(options: string): any;
dxLookup(options: string, ...params: any[]): any;
dxMap(): JQuery;
dxMap(options: 'instance'): DevExpress.ui.dxMap;
dxMap(options: DevExpress.ui.dxMap.Properties): JQuery;
dxMap(options: string): any;
dxMap(options: string, ...params: any[]): any;
dxMenu(): JQuery;
dxMenu(options: 'instance'): DevExpress.ui.dxMenu;
dxMenu(options: DevExpress.ui.dxMenu.Properties): JQuery;
dxMenu(options: string): any;
dxMenu(options: string, ...params: any[]): any;
dxMultiView(): JQuery;
dxMultiView(options: 'instance'): DevExpress.ui.dxMultiView;
dxMultiView(options: DevExpress.ui.dxMultiView.Properties): JQuery;
dxMultiView(options: string): any;
dxMultiView(options: string, ...params: any[]): any;
dxNavBar(): JQuery;
dxNavBar(options: 'instance'): DevExpress.ui.dxNavBar;
dxNavBar(options: DevExpress.ui.dxNavBar.Properties): JQuery;
dxNavBar(options: string): any;
dxNavBar(options: string, ...params: any[]): any;
dxNumberBox(): JQuery;
dxNumberBox(options: 'instance'): DevExpress.ui.dxNumberBox;
dxNumberBox(options: DevExpress.ui.dxNumberBox.Properties): JQuery;
dxNumberBox(options: string): any;
dxNumberBox(options: string, ...params: any[]): any;
dxPieChart(): JQuery;
dxPieChart(options: 'instance'): DevExpress.viz.dxPieChart;
dxPieChart(options: DevExpress.viz.dxPieChart.Properties): JQuery;
dxPieChart(options: string): any;
dxPieChart(options: string, ...params: any[]): any;
dxPivotGrid(): JQuery;
dxPivotGrid(options: 'instance'): DevExpress.ui.dxPivotGrid;
dxPivotGrid(options: DevExpress.ui.dxPivotGrid.Properties): JQuery;
dxPivotGrid(options: string): any;
dxPivotGrid(options: string, ...params: any[]): any;
dxPivotGridFieldChooser(): JQuery;
dxPivotGridFieldChooser(
options: 'instance'
): DevExpress.ui.dxPivotGridFieldChooser;
dxPivotGridFieldChooser(
options: DevExpress.ui.dxPivotGridFieldChooser.Properties
): JQuery;
dxPivotGridFieldChooser(options: string): any;
dxPivotGridFieldChooser(options: string, ...params: any[]): any;
dxPolarChart(): JQuery;
dxPolarChart(options: 'instance'): DevExpress.viz.dxPolarChart;
dxPolarChart(options: DevExpress.viz.dxPolarChart.Properties): JQuery;
dxPolarChart(options: string): any;
dxPolarChart(options: string, ...params: any[]): any;
dxPopover(): JQuery;
dxPopover(options: 'instance'): DevExpress.ui.dxPopover;
dxPopover(options: DevExpress.ui.dxPopover.Properties): JQuery;
dxPopover(options: string): any;
dxPopover(options: string, ...params: any[]): any;
dxPopup(): JQuery;
dxPopup(options: 'instance'): DevExpress.ui.dxPopup;
dxPopup(options: DevExpress.ui.dxPopup.Properties): JQuery;
dxPopup(options: string): any;
dxPopup(options: string, ...params: any[]): any;
dxProgressBar(): JQuery;
dxProgressBar(options: 'instance'): DevExpress.ui.dxProgressBar;
dxProgressBar(options: DevExpress.ui.dxProgressBar.Properties): JQuery;
dxProgressBar(options: string): any;
dxProgressBar(options: string, ...params: any[]): any;
dxRadioGroup(): JQuery;
dxRadioGroup(options: 'instance'): DevExpress.ui.dxRadioGroup;
dxRadioGroup(options: DevExpress.ui.dxRadioGroup.Properties): JQuery;
dxRadioGroup(options: string): any;
dxRadioGroup(options: string, ...params: any[]): any;
dxRangeSelector(): JQuery;
dxRangeSelector(options: 'instance'): DevExpress.viz.dxRangeSelector;
dxRangeSelector(options: DevExpress.viz.dxRangeSelector.Properties): JQuery;
dxRangeSelector(options: string): any;
dxRangeSelector(options: string, ...params: any[]): any;
dxRangeSlider(): JQuery;
dxRangeSlider(options: 'instance'): DevExpress.ui.dxRangeSlider;
dxRangeSlider(options: DevExpress.ui.dxRangeSlider.Properties): JQuery;
dxRangeSlider(options: string): any;
dxRangeSlider(options: string, ...params: any[]): any;
dxRecurrenceEditor(): JQuery;
dxRecurrenceEditor(options: 'instance'): DevExpress.ui.dxRecurrenceEditor;
dxRecurrenceEditor(
options: DevExpress.ui.dxRecurrenceEditor.Properties
): JQuery;
dxRecurrenceEditor(options: string): any;
dxRecurrenceEditor(options: string, ...params: any[]): any;
dxResizable(): JQuery;
dxResizable(options: 'instance'): DevExpress.ui.dxResizable;
dxResizable(options: DevExpress.ui.dxResizable.Properties): JQuery;
dxResizable(options: string): any;
dxResizable(options: string, ...params: any[]): any;
dxResponsiveBox(): JQuery;
dxResponsiveBox(options: 'instance'): DevExpress.ui.dxResponsiveBox;
dxResponsiveBox(options: DevExpress.ui.dxResponsiveBox.Properties): JQuery;
dxResponsiveBox(options: string): any;
dxResponsiveBox(options: string, ...params: any[]): any;
dxSankey(): JQuery;
dxSankey(options: 'instance'): DevExpress.viz.dxSankey;
dxSankey(options: DevExpress.viz.dxSankey.Properties): JQuery;
dxSankey(options: string): any;
dxSankey(options: string, ...params: any[]): any;
dxScheduler(): JQuery;
dxScheduler(options: 'instance'): DevExpress.ui.dxScheduler;
dxScheduler(options: DevExpress.ui.dxScheduler.Properties): JQuery;
dxScheduler(options: string): any;
dxScheduler(options: string, ...params: any[]): any;
dxScrollView(): JQuery;
dxScrollView(options: 'instance'): DevExpress.ui.dxScrollView;
dxScrollView(options: DevExpress.ui.dxScrollView.Properties): JQuery;
dxScrollView(options: string): any;
dxScrollView(options: string, ...params: any[]): any;
dxSelectBox(): JQuery;
dxSelectBox(options: 'instance'): DevExpress.ui.dxSelectBox;
dxSelectBox(options: DevExpress.ui.dxSelectBox.Properties): JQuery;
dxSelectBox(options: string): any;
dxSelectBox(options: string, ...params: any[]): any;
dxSlideOut(): JQuery;
dxSlideOut(options: 'instance'): DevExpress.ui.dxSlideOut;
dxSlideOut(options: DevExpress.ui.dxSlideOut.Properties): JQuery;
dxSlideOut(options: string): any;
dxSlideOut(options: string, ...params: any[]): any;
dxSlideOutView(): JQuery;
dxSlideOutView(options: 'instance'): DevExpress.ui.dxSlideOutView;
dxSlideOutView(options: DevExpress.ui.dxSlideOutView.Properties): JQuery;
dxSlideOutView(options: string): any;
dxSlideOutView(options: string, ...params: any[]): any;
dxSlider(): JQuery;
dxSlider(options: 'instance'): DevExpress.ui.dxSlider;
dxSlider(options: DevExpress.ui.dxSlider.Properties): JQuery;
dxSlider(options: string): any;
dxSlider(options: string, ...params: any[]): any;
dxSortable(): JQuery;
dxSortable(options: 'instance'): DevExpress.ui.dxSortable;
dxSortable(options: DevExpress.ui.dxSortable.Properties): JQuery;
dxSortable(options: string): any;
dxSortable(options: string, ...params: any[]): any;
dxSparkline(): JQuery;
dxSparkline(options: 'instance'): DevExpress.viz.dxSparkline;
dxSparkline(options: DevExpress.viz.dxSparkline.Properties): JQuery;
dxSparkline(options: string): any;
dxSparkline(options: string, ...params: any[]): any;
dxSpeedDialAction(): JQuery;
dxSpeedDialAction(options: 'instance'): DevExpress.ui.dxSpeedDialAction;
dxSpeedDialAction(
options: DevExpress.ui.dxSpeedDialAction.Properties
): JQuery;
dxSpeedDialAction(options: string): any;
dxSpeedDialAction(options: string, ...params: any[]): any;
dxSwitch(): JQuery;
dxSwitch(options: 'instance'): DevExpress.ui.dxSwitch;
dxSwitch(options: DevExpress.ui.dxSwitch.Properties): JQuery;
dxSwitch(options: string): any;
dxSwitch(options: string, ...params: any[]): any;
dxTabPanel(): JQuery;
dxTabPanel(options: 'instance'): DevExpress.ui.dxTabPanel;
dxTabPanel(options: DevExpress.ui.dxTabPanel.Properties): JQuery;
dxTabPanel(options: string): any;
dxTabPanel(options: string, ...params: any[]): any;
dxTabs(): JQuery;
dxTabs(options: 'instance'): DevExpress.ui.dxTabs;
dxTabs(options: DevExpress.ui.dxTabs.Properties): JQuery;
dxTabs(options: string): any;
dxTabs(options: string, ...params: any[]): any;
dxTagBox(): JQuery;
dxTagBox(options: 'instance'): DevExpress.ui.dxTagBox;
dxTagBox(options: DevExpress.ui.dxTagBox.Properties): JQuery;
dxTagBox(options: string): any;
dxTagBox(options: string, ...params: any[]): any;
dxTextArea(): JQuery;
dxTextArea(options: 'instance'): DevExpress.ui.dxTextArea;
dxTextArea(options: DevExpress.ui.dxTextArea.Properties): JQuery;
dxTextArea(options: string): any;
dxTextArea(options: string, ...params: any[]): any;
dxTextBox(): JQuery;
dxTextBox(options: 'instance'): DevExpress.ui.dxTextBox;
dxTextBox(options: DevExpress.ui.dxTextBox.Properties): JQuery;
dxTextBox(options: string): any;
dxTextBox(options: string, ...params: any[]): any;
dxTileView(): JQuery;
dxTileView(options: 'instance'): DevExpress.ui.dxTileView;
dxTileView(options: DevExpress.ui.dxTileView.Properties): JQuery;
dxTileView(options: string): any;
dxTileView(options: string, ...params: any[]): any;
dxToast(): JQuery;
dxToast(options: 'instance'): DevExpress.ui.dxToast;
dxToast(options: DevExpress.ui.dxToast.Properties): JQuery;
dxToast(options: string): any;
dxToast(options: string, ...params: any[]): any;
dxToolbar(): JQuery;
dxToolbar(options: 'instance'): DevExpress.ui.dxToolbar;
dxToolbar(options: DevExpress.ui.dxToolbar.Properties): JQuery;
dxToolbar(options: string): any;
dxToolbar(options: string, ...params: any[]): any;
dxTooltip(): JQuery;
dxTooltip(options: 'instance'): DevExpress.ui.dxTooltip;
dxTooltip(options: DevExpress.ui.dxTooltip.Properties): JQuery;
dxTooltip(options: string): any;
dxTooltip(options: string, ...params: any[]): any;
dxTreeList(): JQuery;
dxTreeList(options: 'instance'): DevExpress.ui.dxTreeList;
dxTreeList(options: DevExpress.ui.dxTreeList.Properties): JQuery;
dxTreeList(options: string): any;
dxTreeList(options: string, ...params: any[]): any;
dxTreeMap(): JQuery;
dxTreeMap(options: 'instance'): DevExpress.viz.dxTreeMap;
dxTreeMap(options: DevExpress.viz.dxTreeMap.Properties): JQuery;
dxTreeMap(options: string): any;
dxTreeMap(options: string, ...params: any[]): any;
dxTreeView(): JQuery;
dxTreeView(options: 'instance'): DevExpress.ui.dxTreeView;
dxTreeView(options: DevExpress.ui.dxTreeView.Properties): JQuery;
dxTreeView(options: string): any;
dxTreeView(options: string, ...params: any[]): any;
dxValidationGroup(): JQuery;
dxValidationGroup(options: 'instance'): DevExpress.ui.dxValidationGroup;
dxValidationGroup(
options: DevExpress.ui.dxValidationGroup.Properties
): JQuery;
dxValidationGroup(options: string): any;
dxValidationGroup(options: string, ...params: any[]): any;
dxValidationMessage(): JQuery;
dxValidationMessage(options: 'instance'): DevExpress.ui.dxValidationMessage;
dxValidationMessage(
options: DevExpress.ui.dxValidationMessage.Properties
): JQuery;
dxValidationMessage(options: string): any;
dxValidationMessage(options: string, ...params: any[]): any;
dxValidationSummary(): JQuery;
dxValidationSummary(options: 'instance'): DevExpress.ui.dxValidationSummary;
dxValidationSummary(
options: DevExpress.ui.dxValidationSummary.Properties
): JQuery;
dxValidationSummary(options: string): any;
dxValidationSummary(options: string, ...params: any[]): any;
dxValidator(): JQuery;
dxValidator(options: 'instance'): DevExpress.ui.dxValidator;
dxValidator(options: DevExpress.ui.dxValidator.Properties): JQuery;
dxValidator(options: string): any;
dxValidator(options: string, ...params: any[]): any;
dxVectorMap(): JQuery;
dxVectorMap(options: 'instance'): DevExpress.viz.dxVectorMap;
dxVectorMap(options: DevExpress.viz.dxVectorMap.Properties): JQuery;
dxVectorMap(options: string): any;
dxVectorMap(options: string, ...params: any[]): any;
}
interface JQueryEventObject {}
interface JQueryPromise<T> {}
declare module DevExpress {
/**
* Defines animation properties.
*/
export type AnimationConfig = {
/**
* A function called after animation is completed.
*/
complete?: (
$element: DevExpress.core.DxElement,
config: AnimationConfig
) => void;
/**
* A number specifying wait time before animation execution.
*/
delay?: number;
/**
* Specifies the animation direction for the 'slideIn' and 'slideOut' animation types.
*/
direction?: 'bottom' | 'left' | 'right' | 'top';
/**
* A number specifying the time in milliseconds spent on animation.
*/
duration?: number;
/**
* A string specifying the easing function for animation.
*/
easing?: string;
/**
* Specifies an initial animation state. Use the to property to specify the final state.
*/
from?: DevExpress.animation.AnimationState;
/**
* A number specifying the time period to wait before the animation of the next stagger item starts.
*/
staggerDelay?: number;
/**
* A function called before animation is started.
*/
start?: (
$element: DevExpress.core.DxElement,
config: AnimationConfig
) => void;
/**
* Specifies a final animation state. Use the from property to specify an initial state.
*/
to?: DevExpress.animation.AnimationState;
/**
* A string value specifying the animation type.
*/
type?:
| 'css'
| 'fade'
| 'fadeIn'
| 'fadeOut'
| 'pop'
| 'slide'
| 'slideIn'
| 'slideOut';
};
/**
* A repository of animations.
*/
export const animationPresets: {
/**
* Applies the changes made in the animation repository.
*/
applyChanges(): void;
/**
* Removes all animations from the repository.
*/
clear(): void;
/**
* Deletes an animation with a specific name.
*/
clear(name: string): void;
/**
* Gets the configuration of an animation with a specific name.
*/
getPreset(name: string): AnimationConfig;
/**
* Registers predefined animations in the animation repository.
*/
registerDefaultPresets(): void;
/**
* Adds an animation with a specific name to the animation repository.
*/
registerPreset(
name: string,
config: { animation: AnimationConfig; device?: Device }
): void;
/**
* Deletes all custom animations.
*/
resetToDefaults(): void;
};
/**
* A base class for all components and UI components.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export class Component<TProperties> {
constructor(options?: TProperties);
/**
* Prevents the UI component from refreshing until the endUpdate() method is called.
*/
beginUpdate(): void;
/**
* Refreshes the UI component after a call of the beginUpdate() method.
*/
endUpdate(): void;
/**
* Gets the UI component's instance. Use it to access other methods of the UI component.
*/
instance(): this;
/**
* Detaches all event handlers from a single event.
*/
off(eventName: string): this;
/**
* Detaches a particular event handler from a single event.
*/
off(eventName: string, eventHandler: Function): this;
/**
* Subscribes to an event.
*/
on(eventName: string, eventHandler: Function): this;
/**
* Subscribes to events.
*/
on(events: { [key: string]: Function }): this;
/**
* Gets all UI component properties.
*/
option(): TProperties;
/**
* Gets the value of a single property.
*/
option<TPropertyName extends string, TValue = unknown>(
optionName: TPropertyName
): TPropertyName extends keyof TProperties
? TProperties[TPropertyName]
: TValue;
/**
* Updates the value of a single property.
*/
option<TPropertyName extends string, TValue = unknown>(
optionName: TPropertyName,
optionValue: TPropertyName extends keyof TProperties
? TProperties[TPropertyName]
: TValue
): void;
/**
* Updates the values of several properties.
*/
option(options: Partial<TProperties>): void;
/**
* Resets a property to its default value.
*/
resetOption(optionName: string): void;
}
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export interface ComponentOptions<
TDisposingEvent,
TInitializedEvent,
TOptionChangedEvent
> {
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing?: (e: TDisposingEvent) => void;
/**
* A function used in JavaScript frameworks to save the UI component instance.
*/
onInitialized?: (e: TInitializedEvent) => void;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged?: (e: TOptionChangedEvent) => void;
}
/**
* Gets the current global configuration.
*/
export function config(): globalConfig;
/**
* Configures your application before its launch.
*/
export function config(config: globalConfig): void;
/**
*
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export class DataHelperMixin {
/**
* Gets the DataSource instance.
*/
getDataSource(): DevExpress.data.DataSource;
}
/**
* The device object defines the device on which the application is running.
*/
export type Device = {
/**
* Indicates whether or not the device platform is Android.
*/
android?: boolean;
/**
* Specifies the type of the device on which the application is running.
*/
deviceType?: 'phone' | 'tablet' | 'desktop';
/**
* Indicates whether or not the device platform is generic, which means that the application will look and behave according to a generic 'light' or 'dark' theme.
*/
generic?: boolean;
/**
* Specifies a performance grade of the current device.
*/
grade?: 'A' | 'B' | 'C';
/**
* Indicates whether or not the device platform is iOS.
*/
ios?: boolean;
/**
* Indicates whether or not the device type is 'phone'.
*/
phone?: boolean;
/**
* Specifies the platform of the device on which the application is running.
*/
platform?: 'android' | 'ios' | 'generic';
/**
* Indicates whether or not the device type is 'tablet'.
*/
tablet?: boolean;
/**
* Specifies an array with the major and minor versions of the device platform.
*/
version?: Array<number>;
};
/**
*
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export const devices: DevicesObject;
/**
* An object that serves as a namespace for the methods and events specifying information on the current device.
*/
export class DevicesObject {
constructor(options?: { window?: Window });
/**
* Gets information on the current device.
*/
current(): Device;
/**
* Overrides actual device information to force the application to operate as if it was running on a specified device.
*/
current(deviceName: string | Device): void;
/**
* Detaches all event handlers from a single event.
*/
off(eventName: DevExpress.core.EventName): this;
/**
* Detaches a particular event handler from a single event.
*/
off(eventName: DevExpress.core.EventName, eventHandler: Function): this;
/**
* Subscribes to an event.
*/
on(eventName: DevExpress.core.EventName, eventHandler: Function): this;
/**
* Subscribes to events.
*/
on(events: { [key in DevExpress.core.EventName]?: Function }): this;
/**
* Returns the current device orientation.
*/
orientation(): 'portrait' | 'landscape' | undefined;
/**
* Returns real information about the current device regardless of the value passed to the DevExpress.devices.current(deviceName) method.
*/
real(): Device;
isSimulator(): boolean;
}
/**
* A base class for all components.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export class DOMComponent<
TProperties = DevExpress.DOMComponent.Properties
> extends Component<TProperties> {
_templateManager: DevExpress.core.TemplateManager;
_cancelOptionChange?: string;
constructor(
element: DevExpress.core.UserDefinedElement,
options?: TProperties
);
/**
* Gets the instance of a UI component found using its DOM node.
*/
static getInstance(
element: DevExpress.core.UserDefinedElement
): DOMComponent<DevExpress.DOMComponent.Properties>;
/**
* Specifies the device-dependent default configuration properties for this component.
*/
static defaultOptions<TProperties = DevExpress.DOMComponent.Properties>(
rule: DevExpress.core.DefaultOptionsRule<TProperties>
): void;
/**
* Disposes of all the resources allocated to the widget instance.
*/
dispose(): void;
/**
* Gets the root UI component element.
*/
element(): DevExpress.core.DxElement;
$element(): DevExpress.core.UserDefinedElement;
_getTemplate(template: unknown): DevExpress.core.FunctionTemplate;
_invalidate(): void;
_refresh(): void;
_notifyOptionChanged(
fullName: string,
value: unknown,
previousValue: unknown
): void;
_createElement(element: HTMLElement): void;
}
module DOMComponent {
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
interface DOMComponentInstance extends DOMComponent<Properties> {}
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
type OptionChangedEventInfo<TComponent> =
DevExpress.events.EventInfo<TComponent> &
DevExpress.events.ChangedOptionInfo;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
type Properties = DOMComponentOptions<DOMComponentInstance>;
}
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export interface DOMComponentOptions<TComponent>
extends ComponentOptions<
DevExpress.events.EventInfo<TComponent>,
DevExpress.events.InitializedEventInfo<TComponent>,
DevExpress.DOMComponent.OptionChangedEventInfo<TComponent>
> {
/**
*
*/
bindingOptions?: { [key: string]: any };
/**
* Specifies the global attributes to be attached to the UI component's container element.
*/
elementAttr?: { [key: string]: any };
/**
* Specifies the UI component's height.
*/
height?: number | string | (() => number | string);
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing?: (e: DevExpress.events.EventInfo<TComponent>) => void;
/**
* A function that is executed after a UI component property is changed.
*/
onOptionChanged?: (
e: DevExpress.DOMComponent.OptionChangedEventInfo<TComponent>
) => void;
/**
* Switches the UI component to a right-to-left representation.
*/
rtlEnabled?: boolean;
/**
* Specifies the UI component's width.
*/
width?: number | string | (() => number | string);
}
/**
* A time zone object.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export interface dxSchedulerTimeZone {
/**
* A time zone text string from the IANA database.
*/
id: string;
/**
* A GMT offset.
*/
offset: number;
/**
* A time zone in the following format: `(GMT ±[hh]:[mm]) [id]`.
*/
title: string;
}
/**
* The EndpointSelector is an object for managing OData endpoints in your application.
*/
export class EndpointSelector {
constructor(options: any);
/**
* Gets an endpoint with a specific key.
*/
urlFor(key: string): string;
}
/**
* Configures the load panel.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export interface ExportLoadPanel {
/**
* Specifies whether the load panel is enabled.
*/
enabled?: boolean;
/**
* Specifies text displayed on the load panel.
*/
text?: string;
/**
* Specifies the width of the load panel in pixels.
*/
width?: number;
/**
* Specifies the height of the load panel in pixels.
*/
height?: number;
/**
* Specifies whether to show the loading indicator.
*/
showIndicator?: boolean;
/**
* Specifies a URL pointing to an image to be used as a loading indicator.
*/
indicatorSrc?: string;
/**
* Specifies whether to show the pane of the load panel.
*/
showPane?: boolean;
/**
* Specifies whether to shade the UI component when the load panel is shown.
*/
shading?: boolean;
/**
* Specifies the shading color. Applies only if shading is true.
*/
shadingColor?: string;
}
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
type ExternalFormat = any;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export interface FormatObject {
/**
* Specifies a 3-letter ISO 4217 code for currency. Applies only if the type is 'currency'.
*/
currency?: string;
/**
* A function that converts numeric or date-time values to a string.
*/
formatter?: (value: number | Date) => string;
/**
* Parses string values into numeric or date-time values. Should be used with formatter or one of the predefined formats.
*/
parser?: (value: string) => number | Date;
/**
* Specifies a precision for values of numeric or currency format types.
*/
precision?: number;
/**
* Specifies a predefined format. Does not apply if you have specified the formatter function.
*/
type?: PredefinedFormat | string;
}
/**
* An object that serves as a namespace for the methods that are used to animate UI elements.
*/
export const fx: {
/**
* Animates an element.
*/
animate(
element: Element,
config: AnimationConfig
): DevExpress.core.utils.DxPromise<void>;
/**
* Checks whether an element is being animated.
*/
isAnimating(element: Element): boolean;
/**
* Stops an element's animation.
*/
stop(element: Element, jumpToEnd: boolean): void;
};
/**
* Specifies settings that affect all DevExtreme UI components.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export interface globalConfig {
/**
* A decimal separator. No longer applies.
* @deprecated
*/
decimalSeparator?: string;
/**
* The default currency. Accepts a 3-letter ISO 4217 code.
*/
defaultCurrency?: string;
/**
* Specifies how editors' text fields are styled in your application.
*/
editorStylingMode?: 'outlined' | 'underlined' | 'filled';
/**
* Configures a Floating Action Button (FAB) that emits a stack of related actions (speed dial).
*/
floatingActionButtonConfig?: {
/**
* Specifies the icon the FAB displays when the speed dial is opened.
*/
closeIcon?: string;
/**
* Specifies the direction in which to open the speed dial menu.
*/
direction?: 'auto' | 'up' | 'down';
/**
* Specifies the icon the FAB displays when the speed dial is closed.
*/
icon?: string;
/**
* Specifies the text label displayed inside the FAB.
*/
label?: string;
/**
* Limits the number of speed dial actions.
*/
maxSpeedDialActionCount?: number;
/**
* Positions the FAB on the screen.
*/
position?:
| 'bottom'
| 'center'
| 'left'
| 'left bottom'
| 'left top'
| 'right'
| 'right bottom'
| 'right top'
| 'top'
| PositionConfig
| Function;
/**
* If true, the background should be shaded when the speed dial menu is open.
*/
shading?: boolean;
};
/**
* Specifies whether dates are parsed and serialized according to the ISO 8601 standard in all browsers.
*/
forceIsoDateParsing?: boolean;
/**
* Specifies whether to convert string values to lowercase in filter and search requests to OData services. Applies to the following operations: 'startswith', 'endswith', 'contains', and 'notcontains'.
*/
oDataFilterToLower?: boolean;
/**
* Specifies whether the UI components support a right-to-left representation. Available for individual UI components as well.
*/
rtlEnabled?: boolean;
/**
* The decimal separator that is used when submitting a value to the server.
*/
serverDecimalSeparator?: string;
/**
* A group separator. No longer applies.
* @deprecated
*/
thousandsSeparator?: string;
/**
*
*/
useLegacyStoreResult?: boolean;
/**
*
*/
useLegacyVisibleIndex?: boolean;
}
/**
* Hides the last displayed overlay UI component.
*/
export function hideTopOverlay(): boolean;
/**
* Configures the position of an overlay element.
*/
export interface PositionConfig {
/**
* Specifies the target element's side or corner where the overlay element should be positioned.
*/
at?:
| 'bottom'
| 'center'
| 'left'
| 'left bottom'
| 'left top'
| 'right'
| 'right bottom'
| 'right top'
| 'top'
| {
/**
* Specifies a position in the horizontal direction (for left, right, or center alignment).
*/
x?: 'center' | 'left' | 'right';
/**
* Specifies a position in the vertical direction (for top, bottom, or center alignment).
*/
y?: 'bottom' | 'center' | 'top';
};
/**
* A boundary element in which the overlay element must be positioned.
*/
boundary?: string | DevExpress.core.UserDefinedElement | Window;
/**
* Specifies the offset of boundaries from the boundary element.
*/
boundaryOffset?:
| string
| {
/**
* Specifies a horizontal offset.
*/
x?: number;
/**
* Specifies a vertical offset.
*/
y?: number;
};
/**
* Specifies how to resolve collisions - when the overlay element exceeds the boundary element.
*/
collision?:
| 'fit'
| 'fit flip'
| 'fit flipfit'
| 'fit none'
| 'flip'
| 'flip fit'
| 'flip none'
| 'flipfit'
| 'flipfit fit'
| 'flipfit none'
| 'none'
| 'none fit'
| 'none flip'
| 'none flipfit'
| {
/**
* Specifies how to resolve horizontal collisions.
*/
x?: 'fit' | 'flip' | 'flipfit' | 'none';
/**
* Specifies how to resolve vertical collisions.
*/
y?: 'fit' | 'flip' | 'flipfit' | 'none';
};
/**
* Specifies the overlay element's side or corner to align with a target element.
*/
my?:
| 'bottom'
| 'center'
| 'left'
| 'left bottom'
| 'left top'
| 'right'
| 'right bottom'
| 'right top'
| 'top'
| {
/**
* Specifies a position in the horizontal direction (for left, right, or center alignment).
*/
x?: 'center' | 'left' | 'right';
/**
* Specifies a position in the vertical direction (for top, bottom, or center alignment).
*/
y?: 'bottom' | 'center' | 'top';
};
/**
* The target element relative to which the overlay element should be positioned.
*/
of?: string | DevExpress.core.UserDefinedElement | Window;
/**
* Specifies the overlay element's offset from a specified position.
*/
offset?:
| string
| {
/**
* Specifies a horizontal offset.
*/
x?: number;
/**
* Specifies a vertical offset.
*/
y?: number;
};
}
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
type PredefinedFormat =
| 'billions'
| 'currency'
| 'day'
| 'decimal'
| 'exponential'
| 'fixedPoint'
| 'largeNumber'
| 'longDate'
| 'longTime'
| 'millions'
| 'millisecond'
| 'month'
| 'monthAndDay'
| 'monthAndYear'
| 'percent'
| 'quarter'
| 'quarterAndYear'
| 'shortDate'
| 'shortTime'
| 'thousands'
| 'trillions'
| 'year'
| 'dayOfWeek'
| 'hour'
| 'longDateLongTime'
| 'minute'
| 'second'
| 'shortDateShortTime';
/**
* Registers a new component in the DevExpress.ui namespace.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export function registerComponent<TComponent>(
name: string,
componentClass: DevExpress.core.ComponentFactory<TComponent>
): void;
/**
* Registers a new component in the specified namespace.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please describe your scenario in the following GitHub Issue, and we will suggest a public alternative: {@link https://github.com/DevExpress/DevExtreme/issues/17885|Internal Types}.
*/
export function registerComponent<TComponent>(
name: string,
namespace: {
[key: string]: DevExpress.core.ComponentFactory<DOMComponent>;
},
componentClass: DevExpress.core.ComponentFactory<TComponent>
): void;
/**
* Sets a supported template engine to use when using jQuery.
*/
export function setTemplateEngine(templateEngineName: string): void;
/**
* Sets custom functions that compile and render templates.
*/
export function setTemplateEngine(templateEngineOptions: {
compile?: Function;
render?: Function;
}): void;
/**
* The manager that performs several specified animations at a time.
*/
export class TransitionExecutor {
/**
* Registers the set of elements that should be animated as 'entering' using the specified animation configuration.
*/
enter(
elements: DevExpress.core.UserDefinedElementsArray,
animation: AnimationConfig | string
): void;
/**
* Registers a set of elements that should be animated as 'leaving' using the specified animation configuration.
*/
leave(
elements: DevExpress.core.UserDefinedElementsArray,
animation: AnimationConfig | string
): void;
/**
* Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods.
*/
reset(): void;
/**
* Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand.
*/
start(): DevExpress.core.utils.DxPromise<void>;
/**
* Stops all started animations.
*/
stop(): void;
}
/**
* An object that serves as a namespace for the methods required to perform validation.
*/
export class validationEngine {
/**
* Gets the default validation group.
*/
static getGroupConfig(): any;
/**
* Gets a validation group with a specific key.
*/
static getGroupConfig(group: string | any): any;
/**
* Registers all the Validator objects extending fields of the specified ViewModel.
*/
static registerModelForValidation(model: any): void;
/**
* Resets the values and validation result of the editors that belong to the default validation group.
*/
static resetGroup(): void;
/**
* Resets the values and validation result of the editors that belong to the specified validation group.
*/
static resetGroup(group: string | any): void;
/**
* Unregisters all the Validator objects extending fields of the specified ViewModel.
*/
static unregisterModelForValidation(model: any): void;
/**
* Validates editors from the default validation group.
*/
static validateGroup(): DevExpress.ui.dxValidationGroup.ValidationResult;
/**
* Validates editors from a specific validation group.
*/
static validateGroup(
group: string | any
): DevExpress.ui.dxValidationGroup.ValidationResult;
/**
* Validates a view