devextreme-dist
Version:
HTML5 JavaScript Component Suite for Responsive Web Development
1,242 lines (1,152 loc) • 1.62 MB
TypeScript
/*!
* DevExtreme (dx.all.d.ts)
* Version: 26.1.3
* Build date: Wed Jun 10 2026
*
* Copyright (c) 2012 - 2026 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;
dxChat(): JQuery;
dxChat(options: 'instance'): DevExpress.ui.dxChat;
dxChat(options: DevExpress.ui.dxChat.Properties): JQuery;
dxChat(options: string): any;
dxChat(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;
dxDateRangeBox(): JQuery;
dxDateRangeBox(options: 'instance'): DevExpress.ui.dxDateRangeBox;
dxDateRangeBox(options: DevExpress.ui.dxDateRangeBox.Properties): JQuery;
dxDateRangeBox(options: string): any;
dxDateRangeBox(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;
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;
dxPagination(): JQuery;
dxPagination(options: 'instance'): DevExpress.ui.dxPagination;
dxPagination(options: DevExpress.ui.dxPagination.Properties): JQuery;
dxPagination(options: string): any;
dxPagination(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;
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;
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;
dxSplitter(): JQuery;
dxSplitter(options: 'instance'): DevExpress.ui.dxSplitter;
dxSplitter(options: DevExpress.ui.dxSplitter.Properties): JQuery;
dxSplitter(options: string): any;
dxSplitter(options: string, ...params: any[]): any;
dxStepper(): JQuery;
dxStepper(options: 'instance'): DevExpress.ui.dxStepper;
dxStepper(options: DevExpress.ui.dxStepper.Properties): JQuery;
dxStepper(options: string): any;
dxStepper(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;
dxSpeechToText(): JQuery;
dxSpeechToText(options: 'instance'): DevExpress.ui.dxSpeechToText;
dxSpeechToText(options: DevExpress.ui.dxSpeechToText.Properties): JQuery;
dxSpeechToText(options: string): any;
dxSpeechToText(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 {
/**
* A base class for all components and UI components.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export class Component<TProperties> {
constructor(options?: TProperties);
/**
* Postpones rendering that can negatively affect performance 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>(
optionName: TPropertyName
): TPropertyName extends keyof TProperties
? TProperties[TPropertyName]
: unknown;
/**
* Updates the value of a single property.
*/
option<TPropertyName extends string>(
optionName: TPropertyName,
optionValue: TPropertyName extends keyof TProperties
? TProperties[TPropertyName]
: unknown
): 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 submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
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(): DevExpress.common.GlobalConfig;
/**
* Configures your application before its launch.
*/
export function config(config: DevExpress.common.GlobalConfig): void;
/**
*
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export class DataHelperMixin {
/**
* Gets the DataSource instance.
*/
getDataSource(): DevExpress.common.data.DataSource;
}
/**
* Specifies the device-dependent default configuration properties for a component.
*/
export type DefaultOptionsRule<T> = {
device?:
| DevExpress.common.core.environment.Device
| DevExpress.common.core.environment.Device[]
| ((device: DevExpress.common.core.environment.Device) => boolean);
options: DevExpress.core.DeepPartial<T>;
};
/**
* A base class for all components.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export class DOMComponent<
TProperties = DevExpress.DOMComponent.Properties
> extends Component<TProperties> {
_templateManager: DevExpress.core.TemplateManager;
_cancelOptionChange?: string | boolean;
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: 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.InternalElement<Element>;
_getTemplate(template: unknown): DevExpress.core.FunctionTemplate;
_invalidate(): void;
_refresh(): void;
_notifyOptionChanged(
fullName: string,
value: unknown,
previousValue: unknown
): void;
_createElement(element: HTMLElement): void;
_validateOptions(options: TProperties): TProperties;
}
module DOMComponent {
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
interface DOMComponentInstance extends DOMComponent<Properties> {}
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type OptionChangedEventInfo<TComponent> =
DevExpress.common.core.events.EventInfo<TComponent> &
DevExpress.common.core.events.ChangedOptionInfo;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type Properties = DOMComponentOptions<DOMComponentInstance>;
}
/**
*
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export interface DOMComponentOptions<TComponent>
extends ComponentOptions<
DevExpress.common.core.events.EventInfo<TComponent>,
DevExpress.common.core.events.InitializedEventInfo<TComponent>,
DevExpress.DOMComponent.OptionChangedEventInfo<TComponent>
> {
/**
* 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 | undefined;
/**
* A function that is executed before the UI component is disposed of.
*/
onDisposing?: (
e: DevExpress.common.core.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 | undefined;
}
/**
* Configures the load panel.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
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 the path to a custom load indicator image.
* @deprecated Use indicatorOptions instead.
*/
indicatorSrc?: string;
/**
* Configures the load indicator.
*/
indicatorOptions?: DevExpress.ui.dxLoadPanel.LoadPanelIndicatorProperties;
/**
* 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;
}
export type FloatingActionButtonDirection = 'auto' | 'up' | 'down';
/**
* Registers a new component in the DevExpress.ui namespace.
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
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 submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export function registerComponent<TComponent>(
name: string,
namespace: {
[key: string]: DevExpress.core.ComponentFactory<DOMComponent>;
},
componentClass: DevExpress.core.ComponentFactory<TComponent>
): void;
/**
* Sets custom functions that compile and render templates.
*/
export function setTemplateEngine(templateEngineOptions: {
compile?: Function;
render?: Function;
}): void;
/**
* A template notation used to specify templates for UI component elements.
*/
export type template = string | Function | DevExpress.core.UserDefinedElement;
/**
* 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 model.
*/
static validateModel(model: any): any;
}
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type VersionAssertion = {
packageName: string;
version: string;
};
}
declare module DevExpress.aiIntegration {
/**
* A class that activates AI services in DevExpress UI components.
*/
export class AIIntegration {
constructor(provider: AIProvider, options?: AIIntegrationOptions);
changeStyle(
params: ChangeStyleCommandParams,
callbacks: RequestCallbacks<ChangeStyleCommandResult>
): () => void;
changeTone(
params: ChangeToneCommandParams,
callbacks: RequestCallbacks<ChangeToneCommandResult>
): () => void;
execute(
params: ExecuteCommandParams,
callbacks: RequestCallbacks<ExecuteCommandResult>
): () => void;
expand(
params: ExpandCommandParams,
callbacks: RequestCallbacks<ExpandCommandResult>
): () => void;
proofread(
params: ProofreadCommandParams,
callbacks: RequestCallbacks<ProofreadCommandResult>
): () => void;
shorten(
params: ShortenCommandParams,
callbacks: RequestCallbacks<ShortenCommandResult>
): () => void;
summarize(
params: SummarizeCommandParams,
callbacks: RequestCallbacks<SummarizeCommandResult>
): () => void;
translate(
params: TranslateCommandParams,
callbacks: RequestCallbacks<TranslateCommandResult>
): () => void;
smartPaste(
params: SmartPasteCommandParams,
callbacks: RequestCallbacks<SmartPasteCommandResult>
): () => void;
generateGridColumn(
params: GenerateGridColumnCommandParams,
callbacks: RequestCallbacks<GenerateGridColumnCommandResult>
): () => void;
executeGridAssistant(
params: ExecuteGridAssistantCommandParams,
callbacks: RequestCallbacks<ExecuteGridAssistantCommandResult>
): () => void;
}
/**
* Specifies optional AI service configuration.
*/
export type AIIntegrationOptions = {
/**
* Specifies the AI response language.
*/
lang?: string;
};
/**
* An object responsible for sending requests to an AI service.
*/
export type AIProvider = {
/**
* A function that sends a request to an AI service.
*/
sendRequest: (params: RequestParams) => Response;
};
/**
* An object that contains an AI response.
*/
export type AIResponse = string | Record<PropertyKey, any>;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ChangeStyleCommandParams = {
text: string;
writingStyle: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ChangeStyleCommandResult = string;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ChangeToneCommandParams = {
text: string;
tone: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ChangeToneCommandResult = string;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ExecuteCommandParams = {
text: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ExecuteCommandResult = string;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ExecuteGridAssistantAction = {
name: string;
args: Record<string, unknown>;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ExecuteGridAssistantCommandParams = {
text: string;
context: Record<string, unknown>;
responseSchema: Record<string, unknown>;
additionalInfo?: Record<PropertyKey, unknown>;
};
/**
* An AI Assistant response.
*/
export type ExecuteGridAssistantCommandResponse =
| string
| {
/**
* Actions to be executed in the AI Assistant response.
*/
actions: ExecuteGridAssistantAction[] | string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ExecuteGridAssistantCommandResult = {
actions: ExecuteGridAssistantAction[];
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ExpandCommandParams = {
text: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ExpandCommandResult = string;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type FieldInfo = {
name: string;
format: string;
type?: SmartPasteFieldType;
instruction?: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type GenerateGridColumnCommandParams = {
text: string;
data: Record<PropertyKey, unknown>;
additionalInfo?: Record<PropertyKey, unknown>;
};
/**
*
*/
export type GenerateGridColumnCommandResponse =
| string
| {
/**
*
*/
data: string | Record<PropertyKey, string>;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type GenerateGridColumnCommandResult = {
data: Record<PropertyKey, string>;
};
/**
* A prompt for the AI model.
*/
export type Prompt = {
/**
* Direct instructions for the AI model.
*/
system?: string;
/**
* A user message to the AI model.
*/
user?: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ProofreadCommandParams = {
text: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ProofreadCommandResult = string;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type RequestCallbacks<T> = {
onChunk?: (chunk: string) => void;
onComplete?: (finalResponse: T) => void;
onError?: (error: Error) => void;
};
/**
* An object with request parameters for AI service.
*/
export type RequestParams = {
/**
* The prompt sent to the AI model.
*/
prompt: Prompt;
/**
* Additional data sent to the AI model.
*/
data?: RequestParamsData;
};
/**
* An object that contains additional data to be sent to an AI model.
*/
export type RequestParamsData = Record<PropertyKey, any>;
/**
* An object returned by the sendRequest function.
*/
export type Response = {
/**
* A promise that resolves with the final AI-generated text.
*/
promise: Promise<AIResponse>;
/**
* A function that cancels the request.
*/
abort: () => void;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ShortenCommandParams = {
text: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type ShortenCommandResult = string;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type SmartPasteCommandParams = {
text: string;
fields: FieldInfo[];
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type SmartPasteCommandResult = Array<{
name: string;
value: SmartPasteResultFieldType;
}>;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type SmartPasteFieldType =
| 'color'
| 'boolean'
| 'string'
| 'stringArray'
| 'number'
| 'numberRange'
| 'date'
| 'dateRange';
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type SmartPasteResultFieldType =
| string
| string[]
| number
| number[]
| Date
| Date[]
| boolean;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type SummarizeCommandParams = {
text: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type SummarizeCommandResult = string;
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type TranslateCommandParams = {
text: string;
lang: string;
};
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type TranslateCommandResult = string;
}
declare module DevExpress.animation {
/**
* @deprecated Use the DevExpress.common.core.animation.AnimationConfig type from common/core/animation instead
*/
export type animationConfig =
DevExpress.common.core.animation.AnimationConfig;
/**
* @deprecated Use the DevExpress.common.core.animation.PositionConfig type from common/core/animation instead
*/
export interface positionConfig
extends DevExpress.common.core.animation.PositionConfig {}
}
declare module DevExpress.common {
/**
* @deprecated Attention! This type is for internal purposes only. If you used it previously, please submit a ticket to our {@link https://supportcenter.devexpress.com/ticket/create Support Center}. We will check if there is an alternative solution.
*/
export type AnimationType =
| 'css'
| 'fade'
| 'fadeIn'
| 'fadeOut'
| 'pop'
| 'slide'
| 'slideIn'
| 'slideOut';
export type ApplyValueMode = 'instantly' | 'useButtons';
/**
* A custom validation rule that is checked asynchronously. Use async rules for server-side validation.
*/
export type AsyncRule = {
/**
* If true, the validationCallback is not executed for null, undefined, false, and empty strings.
*/
ignoreEmptyValue?: boolean;
/**
* Specifies the message that is shown if the rule is broken.
*/
message?: string;
/**
* Indicates whether the rule should always be checked for the target value or only when the value changes.
*/
reevaluate?: boolean;
/**
* Specifies the rule type. Set it to 'async' to use the AsyncRule.
*/
type: 'async';
/**
* A function that validates the target value.
*/
validationCallback?: (options: ValidationCallbackData) => PromiseLike<any>;
};
export type ButtonStyle = 'text' | 'outlined' | 'contained';
export type ButtonType = 'danger' | 'default' | 'normal' | 'success';
/**
* A validation rule that requires validated values to match a specified expression.
*/
export type CompareRule = {
/**
* Specifies the function whose