UNPKG

devextreme

Version:

HTML5 JavaScript Component Suite for Responsive Web Development

1,028 lines (1,027 loc) • 582 kB
/*! * DevExtreme (dx.all.d.ts) * Version: 18.1.3 * Build date: Tue May 15 2018 * * Copyright (c) 2012 - 2018 Developer Express Inc. ALL RIGHTS RESERVED * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/ */ /* #StartGlobalDeclaration */ interface JQuery { } interface JQueryPromise<T> { } interface JQueryCallback { } interface JQueryEventObject { cancel?: boolean; } interface Promise<T> { } /* #EndGlobalDeclaration */ interface JQuery { dxAccordion(): JQuery; dxAccordion(options: "instance"): DevExpress.ui.dxAccordion; dxAccordion(options: string): any; dxAccordion(options: string, ...params: any[]): any; dxAccordion(options: DevExpress.ui.dxAccordionOptions): JQuery; } interface JQuery { dxActionSheet(): JQuery; dxActionSheet(options: "instance"): DevExpress.ui.dxActionSheet; dxActionSheet(options: string): any; dxActionSheet(options: string, ...params: any[]): any; dxActionSheet(options: DevExpress.ui.dxActionSheetOptions): JQuery; } interface JQuery { dxAutocomplete(): JQuery; dxAutocomplete(options: "instance"): DevExpress.ui.dxAutocomplete; dxAutocomplete(options: string): any; dxAutocomplete(options: string, ...params: any[]): any; dxAutocomplete(options: DevExpress.ui.dxAutocompleteOptions): JQuery; } interface JQuery { dxBox(): JQuery; dxBox(options: "instance"): DevExpress.ui.dxBox; dxBox(options: string): any; dxBox(options: string, ...params: any[]): any; dxBox(options: DevExpress.ui.dxBoxOptions): JQuery; } interface JQuery { dxButton(): JQuery; dxButton(options: "instance"): DevExpress.ui.dxButton; dxButton(options: string): any; dxButton(options: string, ...params: any[]): any; dxButton(options: DevExpress.ui.dxButtonOptions): JQuery; } interface JQuery { dxCalendar(): JQuery; dxCalendar(options: "instance"): DevExpress.ui.dxCalendar; dxCalendar(options: string): any; dxCalendar(options: string, ...params: any[]): any; dxCalendar(options: DevExpress.ui.dxCalendarOptions): JQuery; } interface JQuery { dxCheckBox(): JQuery; dxCheckBox(options: "instance"): DevExpress.ui.dxCheckBox; dxCheckBox(options: string): any; dxCheckBox(options: string, ...params: any[]): any; dxCheckBox(options: DevExpress.ui.dxCheckBoxOptions): JQuery; } interface JQuery { dxColorBox(): JQuery; dxColorBox(options: "instance"): DevExpress.ui.dxColorBox; dxColorBox(options: string): any; dxColorBox(options: string, ...params: any[]): any; dxColorBox(options: DevExpress.ui.dxColorBoxOptions): JQuery; } interface JQuery { dxContextMenu(): JQuery; dxContextMenu(options: "instance"): DevExpress.ui.dxContextMenu; dxContextMenu(options: string): any; dxContextMenu(options: string, ...params: any[]): any; dxContextMenu(options: DevExpress.ui.dxContextMenuOptions): JQuery; } interface JQuery { dxDataGrid(): JQuery; dxDataGrid(options: "instance"): DevExpress.ui.dxDataGrid; dxDataGrid(options: string): any; dxDataGrid(options: string, ...params: any[]): any; dxDataGrid(options: DevExpress.ui.dxDataGridOptions): JQuery; } interface JQuery { dxDateBox(): JQuery; dxDateBox(options: "instance"): DevExpress.ui.dxDateBox; dxDateBox(options: string): any; dxDateBox(options: string, ...params: any[]): any; dxDateBox(options: DevExpress.ui.dxDateBoxOptions): JQuery; } interface JQuery { dxDeferRendering(): JQuery; dxDeferRendering(options: "instance"): DevExpress.ui.dxDeferRendering; dxDeferRendering(options: string): any; dxDeferRendering(options: string, ...params: any[]): any; dxDeferRendering(options: DevExpress.ui.dxDeferRenderingOptions): JQuery; } interface JQuery { dxDropDownBox(): JQuery; dxDropDownBox(options: "instance"): DevExpress.ui.dxDropDownBox; dxDropDownBox(options: string): any; dxDropDownBox(options: string, ...params: any[]): any; dxDropDownBox(options: DevExpress.ui.dxDropDownBoxOptions): JQuery; } interface JQuery { dxFileUploader(): JQuery; dxFileUploader(options: "instance"): DevExpress.ui.dxFileUploader; dxFileUploader(options: string): any; dxFileUploader(options: string, ...params: any[]): any; dxFileUploader(options: DevExpress.ui.dxFileUploaderOptions): JQuery; } interface JQuery { dxFilterBuilder(): JQuery; dxFilterBuilder(options: "instance"): DevExpress.ui.dxFilterBuilder; dxFilterBuilder(options: string): any; dxFilterBuilder(options: string, ...params: any[]): any; dxFilterBuilder(options: DevExpress.ui.dxFilterBuilderOptions): JQuery; } interface JQuery { dxForm(): JQuery; dxForm(options: "instance"): DevExpress.ui.dxForm; dxForm(options: string): any; dxForm(options: string, ...params: any[]): any; dxForm(options: DevExpress.ui.dxFormOptions): JQuery; } interface JQuery { dxGallery(): JQuery; dxGallery(options: "instance"): DevExpress.ui.dxGallery; dxGallery(options: string): any; dxGallery(options: string, ...params: any[]): any; dxGallery(options: DevExpress.ui.dxGalleryOptions): JQuery; } interface JQuery { dxList(): JQuery; dxList(options: "instance"): DevExpress.ui.dxList; dxList(options: string): any; dxList(options: string, ...params: any[]): any; dxList(options: DevExpress.ui.dxListOptions): JQuery; } interface JQuery { dxLoadIndicator(): JQuery; dxLoadIndicator(options: "instance"): DevExpress.ui.dxLoadIndicator; dxLoadIndicator(options: string): any; dxLoadIndicator(options: string, ...params: any[]): any; dxLoadIndicator(options: DevExpress.ui.dxLoadIndicatorOptions): JQuery; } interface JQuery { dxLoadPanel(): JQuery; dxLoadPanel(options: "instance"): DevExpress.ui.dxLoadPanel; dxLoadPanel(options: string): any; dxLoadPanel(options: string, ...params: any[]): any; dxLoadPanel(options: DevExpress.ui.dxLoadPanelOptions): JQuery; } interface JQuery { dxLookup(): JQuery; dxLookup(options: "instance"): DevExpress.ui.dxLookup; dxLookup(options: string): any; dxLookup(options: string, ...params: any[]): any; dxLookup(options: DevExpress.ui.dxLookupOptions): JQuery; } interface JQuery { dxMap(): JQuery; dxMap(options: "instance"): DevExpress.ui.dxMap; dxMap(options: string): any; dxMap(options: string, ...params: any[]): any; dxMap(options: DevExpress.ui.dxMapOptions): JQuery; } interface JQuery { dxMenu(): JQuery; dxMenu(options: "instance"): DevExpress.ui.dxMenu; dxMenu(options: string): any; dxMenu(options: string, ...params: any[]): any; dxMenu(options: DevExpress.ui.dxMenuOptions): JQuery; } interface JQuery { dxMultiView(): JQuery; dxMultiView(options: "instance"): DevExpress.ui.dxMultiView; dxMultiView(options: string): any; dxMultiView(options: string, ...params: any[]): any; dxMultiView(options: DevExpress.ui.dxMultiViewOptions): JQuery; } interface JQuery { dxNavBar(): JQuery; dxNavBar(options: "instance"): DevExpress.ui.dxNavBar; dxNavBar(options: string): any; dxNavBar(options: string, ...params: any[]): any; dxNavBar(options: DevExpress.ui.dxNavBarOptions): JQuery; } interface JQuery { dxNumberBox(): JQuery; dxNumberBox(options: "instance"): DevExpress.ui.dxNumberBox; dxNumberBox(options: string): any; dxNumberBox(options: string, ...params: any[]): any; dxNumberBox(options: DevExpress.ui.dxNumberBoxOptions): JQuery; } interface JQuery { dxPanorama(): JQuery; dxPanorama(options: "instance"): DevExpress.ui.dxPanorama; dxPanorama(options: string): any; dxPanorama(options: string, ...params: any[]): any; dxPanorama(options: DevExpress.ui.dxPanoramaOptions): JQuery; } interface JQuery { dxPivot(): JQuery; dxPivot(options: "instance"): DevExpress.ui.dxPivot; dxPivot(options: string): any; dxPivot(options: string, ...params: any[]): any; dxPivot(options: DevExpress.ui.dxPivotOptions): JQuery; } interface JQuery { dxPivotGrid(): JQuery; dxPivotGrid(options: "instance"): DevExpress.ui.dxPivotGrid; dxPivotGrid(options: string): any; dxPivotGrid(options: string, ...params: any[]): any; dxPivotGrid(options: DevExpress.ui.dxPivotGridOptions): JQuery; } interface JQuery { dxPivotGridFieldChooser(): JQuery; dxPivotGridFieldChooser(options: "instance"): DevExpress.ui.dxPivotGridFieldChooser; dxPivotGridFieldChooser(options: string): any; dxPivotGridFieldChooser(options: string, ...params: any[]): any; dxPivotGridFieldChooser(options: DevExpress.ui.dxPivotGridFieldChooserOptions): JQuery; } interface JQuery { dxPopover(): JQuery; dxPopover(options: "instance"): DevExpress.ui.dxPopover; dxPopover(options: string): any; dxPopover(options: string, ...params: any[]): any; dxPopover(options: DevExpress.ui.dxPopoverOptions): JQuery; } interface JQuery { dxPopup(): JQuery; dxPopup(options: "instance"): DevExpress.ui.dxPopup; dxPopup(options: string): any; dxPopup(options: string, ...params: any[]): any; dxPopup(options: DevExpress.ui.dxPopupOptions): JQuery; } interface JQuery { dxProgressBar(): JQuery; dxProgressBar(options: "instance"): DevExpress.ui.dxProgressBar; dxProgressBar(options: string): any; dxProgressBar(options: string, ...params: any[]): any; dxProgressBar(options: DevExpress.ui.dxProgressBarOptions): JQuery; } interface JQuery { dxRadioGroup(): JQuery; dxRadioGroup(options: "instance"): DevExpress.ui.dxRadioGroup; dxRadioGroup(options: string): any; dxRadioGroup(options: string, ...params: any[]): any; dxRadioGroup(options: DevExpress.ui.dxRadioGroupOptions): JQuery; } interface JQuery { dxRangeSlider(): JQuery; dxRangeSlider(options: "instance"): DevExpress.ui.dxRangeSlider; dxRangeSlider(options: string): any; dxRangeSlider(options: string, ...params: any[]): any; dxRangeSlider(options: DevExpress.ui.dxRangeSliderOptions): JQuery; } interface JQuery { dxResizable(): JQuery; dxResizable(options: "instance"): DevExpress.ui.dxResizable; dxResizable(options: string): any; dxResizable(options: string, ...params: any[]): any; dxResizable(options: DevExpress.ui.dxResizableOptions): JQuery; } interface JQuery { dxResponsiveBox(): JQuery; dxResponsiveBox(options: "instance"): DevExpress.ui.dxResponsiveBox; dxResponsiveBox(options: string): any; dxResponsiveBox(options: string, ...params: any[]): any; dxResponsiveBox(options: DevExpress.ui.dxResponsiveBoxOptions): JQuery; } interface JQuery { dxScheduler(): JQuery; dxScheduler(options: "instance"): DevExpress.ui.dxScheduler; dxScheduler(options: string): any; dxScheduler(options: string, ...params: any[]): any; dxScheduler(options: DevExpress.ui.dxSchedulerOptions): JQuery; } interface JQuery { dxScrollView(): JQuery; dxScrollView(options: "instance"): DevExpress.ui.dxScrollView; dxScrollView(options: string): any; dxScrollView(options: string, ...params: any[]): any; dxScrollView(options: DevExpress.ui.dxScrollViewOptions): JQuery; } interface JQuery { dxSelectBox(): JQuery; dxSelectBox(options: "instance"): DevExpress.ui.dxSelectBox; dxSelectBox(options: string): any; dxSelectBox(options: string, ...params: any[]): any; dxSelectBox(options: DevExpress.ui.dxSelectBoxOptions): JQuery; } interface JQuery { dxSlideOut(): JQuery; dxSlideOut(options: "instance"): DevExpress.ui.dxSlideOut; dxSlideOut(options: string): any; dxSlideOut(options: string, ...params: any[]): any; dxSlideOut(options: DevExpress.ui.dxSlideOutOptions): JQuery; } interface JQuery { dxSlideOutView(): JQuery; dxSlideOutView(options: "instance"): DevExpress.ui.dxSlideOutView; dxSlideOutView(options: string): any; dxSlideOutView(options: string, ...params: any[]): any; dxSlideOutView(options: DevExpress.ui.dxSlideOutViewOptions): JQuery; } interface JQuery { dxSlider(): JQuery; dxSlider(options: "instance"): DevExpress.ui.dxSlider; dxSlider(options: string): any; dxSlider(options: string, ...params: any[]): any; dxSlider(options: DevExpress.ui.dxSliderOptions): JQuery; } interface JQuery { dxSwitch(): JQuery; dxSwitch(options: "instance"): DevExpress.ui.dxSwitch; dxSwitch(options: string): any; dxSwitch(options: string, ...params: any[]): any; dxSwitch(options: DevExpress.ui.dxSwitchOptions): JQuery; } interface JQuery { dxTabPanel(): JQuery; dxTabPanel(options: "instance"): DevExpress.ui.dxTabPanel; dxTabPanel(options: string): any; dxTabPanel(options: string, ...params: any[]): any; dxTabPanel(options: DevExpress.ui.dxTabPanelOptions): JQuery; } interface JQuery { dxTabs(): JQuery; dxTabs(options: "instance"): DevExpress.ui.dxTabs; dxTabs(options: string): any; dxTabs(options: string, ...params: any[]): any; dxTabs(options: DevExpress.ui.dxTabsOptions): JQuery; } interface JQuery { dxTagBox(): JQuery; dxTagBox(options: "instance"): DevExpress.ui.dxTagBox; dxTagBox(options: string): any; dxTagBox(options: string, ...params: any[]): any; dxTagBox(options: DevExpress.ui.dxTagBoxOptions): JQuery; } interface JQuery { dxTextArea(): JQuery; dxTextArea(options: "instance"): DevExpress.ui.dxTextArea; dxTextArea(options: string): any; dxTextArea(options: string, ...params: any[]): any; dxTextArea(options: DevExpress.ui.dxTextAreaOptions): JQuery; } interface JQuery { dxTextBox(): JQuery; dxTextBox(options: "instance"): DevExpress.ui.dxTextBox; dxTextBox(options: string): any; dxTextBox(options: string, ...params: any[]): any; dxTextBox(options: DevExpress.ui.dxTextBoxOptions): JQuery; } interface JQuery { dxTileView(): JQuery; dxTileView(options: "instance"): DevExpress.ui.dxTileView; dxTileView(options: string): any; dxTileView(options: string, ...params: any[]): any; dxTileView(options: DevExpress.ui.dxTileViewOptions): JQuery; } interface JQuery { dxToast(): JQuery; dxToast(options: "instance"): DevExpress.ui.dxToast; dxToast(options: string): any; dxToast(options: string, ...params: any[]): any; dxToast(options: DevExpress.ui.dxToastOptions): JQuery; } interface JQuery { dxToolbar(): JQuery; dxToolbar(options: "instance"): DevExpress.ui.dxToolbar; dxToolbar(options: string): any; dxToolbar(options: string, ...params: any[]): any; dxToolbar(options: DevExpress.ui.dxToolbarOptions): JQuery; } interface JQuery { dxTooltip(): JQuery; dxTooltip(options: "instance"): DevExpress.ui.dxTooltip; dxTooltip(options: string): any; dxTooltip(options: string, ...params: any[]): any; dxTooltip(options: DevExpress.ui.dxTooltipOptions): JQuery; } interface JQuery { dxTreeList(): JQuery; dxTreeList(options: "instance"): DevExpress.ui.dxTreeList; dxTreeList(options: string): any; dxTreeList(options: string, ...params: any[]): any; dxTreeList(options: DevExpress.ui.dxTreeListOptions): JQuery; } interface JQuery { dxTreeView(): JQuery; dxTreeView(options: "instance"): DevExpress.ui.dxTreeView; dxTreeView(options: string): any; dxTreeView(options: string, ...params: any[]): any; dxTreeView(options: DevExpress.ui.dxTreeViewOptions): JQuery; } interface JQuery { dxValidationGroup(): JQuery; dxValidationGroup(options: "instance"): DevExpress.ui.dxValidationGroup; dxValidationGroup(options: string): any; dxValidationGroup(options: string, ...params: any[]): any; dxValidationGroup(options: DevExpress.ui.dxValidationGroupOptions): JQuery; } interface JQuery { dxValidationSummary(): JQuery; dxValidationSummary(options: "instance"): DevExpress.ui.dxValidationSummary; dxValidationSummary(options: string): any; dxValidationSummary(options: string, ...params: any[]): any; dxValidationSummary(options: DevExpress.ui.dxValidationSummaryOptions): JQuery; } interface JQuery { dxValidator(): JQuery; dxValidator(options: "instance"): DevExpress.ui.dxValidator; dxValidator(options: string): any; dxValidator(options: string, ...params: any[]): any; dxValidator(options: DevExpress.ui.dxValidatorOptions): JQuery; } interface JQuery { dxBarGauge(): JQuery; dxBarGauge(options: "instance"): DevExpress.viz.dxBarGauge; dxBarGauge(options: string): any; dxBarGauge(options: string, ...params: any[]): any; dxBarGauge(options: DevExpress.viz.gauges.dxBarGaugeOptions): JQuery; } interface JQuery { dxBullet(): JQuery; dxBullet(options: "instance"): DevExpress.viz.dxBullet; dxBullet(options: string): any; dxBullet(options: string, ...params: any[]): any; dxBullet(options: DevExpress.viz.sparklines.dxBulletOptions): JQuery; } interface JQuery { dxChart(): JQuery; dxChart(options: "instance"): DevExpress.viz.dxChart; dxChart(options: string): any; dxChart(options: string, ...params: any[]): any; dxChart(options: DevExpress.viz.charts.dxChartOptions): JQuery; } interface JQuery { dxCircularGauge(): JQuery; dxCircularGauge(options: "instance"): DevExpress.viz.dxCircularGauge; dxCircularGauge(options: string): any; dxCircularGauge(options: string, ...params: any[]): any; dxCircularGauge(options: DevExpress.viz.gauges.dxCircularGaugeOptions): JQuery; } interface JQuery { dxFunnel(): JQuery; dxFunnel(options: "instance"): DevExpress.viz.dxFunnel; dxFunnel(options: string): any; dxFunnel(options: string, ...params: any[]): any; dxFunnel(options: DevExpress.viz.funnel.dxFunnelOptions): JQuery; } interface JQuery { dxLinearGauge(): JQuery; dxLinearGauge(options: "instance"): DevExpress.viz.dxLinearGauge; dxLinearGauge(options: string): any; dxLinearGauge(options: string, ...params: any[]): any; dxLinearGauge(options: DevExpress.viz.gauges.dxLinearGaugeOptions): JQuery; } interface JQuery { dxPieChart(): JQuery; dxPieChart(options: "instance"): DevExpress.viz.dxPieChart; dxPieChart(options: string): any; dxPieChart(options: string, ...params: any[]): any; dxPieChart(options: DevExpress.viz.charts.dxPieChartOptions): JQuery; } interface JQuery { dxPolarChart(): JQuery; dxPolarChart(options: "instance"): DevExpress.viz.dxPolarChart; dxPolarChart(options: string): any; dxPolarChart(options: string, ...params: any[]): any; dxPolarChart(options: DevExpress.viz.charts.dxPolarChartOptions): JQuery; } interface JQuery { dxRangeSelector(): JQuery; dxRangeSelector(options: "instance"): DevExpress.viz.dxRangeSelector; dxRangeSelector(options: string): any; dxRangeSelector(options: string, ...params: any[]): any; dxRangeSelector(options: DevExpress.viz.rangeSelector.dxRangeSelectorOptions): JQuery; } interface JQuery { dxSparkline(): JQuery; dxSparkline(options: "instance"): DevExpress.viz.dxSparkline; dxSparkline(options: string): any; dxSparkline(options: string, ...params: any[]): any; dxSparkline(options: DevExpress.viz.sparklines.dxSparklineOptions): JQuery; } interface JQuery { dxTreeMap(): JQuery; dxTreeMap(options: "instance"): DevExpress.viz.dxTreeMap; dxTreeMap(options: string): any; dxTreeMap(options: string, ...params: any[]): any; dxTreeMap(options: DevExpress.viz.treeMap.dxTreeMapOptions): JQuery; } interface JQuery { dxVectorMap(): JQuery; dxVectorMap(options: "instance"): DevExpress.viz.dxVectorMap; dxVectorMap(options: string): any; dxVectorMap(options: string, ...params: any[]): any; dxVectorMap(options: DevExpress.viz.map.dxVectorMapOptions): JQuery; } declare module DevExpress { export class DataHelperMixin { /** Gets the DataSource instance. */ getDataSource(): DevExpress.data.DataSource; } export function eventsHandler(event: dxEvent, extraParameters: any): boolean; /** Describes dxEvent, a counterpart of the jQuery.Event to be used without jQuery. */ export class dxEvent { /** The DOM element that initiated the event. */ target: Element; /** The DOM element within the current event propagation stage. */ currentTarget: Element; /** The DOM element to which the currently-called event handler was attached. */ delegateTarget: Element; /** Data passed to the event handler. */ data: any; /** Checks if the preventDefault() method was called on this event object. */ isDefaultPrevented(): boolean; /** Checks if the stopImmediatePropagation() method was called on this event object. */ isImmediatePropagationStopped(): boolean; /** Checks if the stopPropagation() method was called on this event object. */ isPropagationStopped(): boolean; /** Prevents the event's default action from triggering. */ preventDefault(): void; /** Stops the event's propagation up the DOM tree, preventing the rest of the handlers from being executed. */ stopImmediatePropagation(): void; /** Stops the event's propagation up the DOM tree, keeping parent handlers unnotified of the event. */ stopPropagation(): void; } export type event = dxEvent | JQueryEventObject; /** An object that serves as a namespace for the methods that are used to localize an application. */ export class localization { static formatDate(value: Date, format: DevExpress.ui.format): string; static formatMessage(key: string, value: string | Array<string>): string; static formatNumber(value: number, format: DevExpress.ui.format): string; static loadMessages(messages: any): void; /** Gets the current locale identifier. */ static locale(): string; /** Sets the current locale identifier. */ static locale(locale: string): void; static parseDate(text: string, format: DevExpress.ui.format): Date; static parseNumber(text: string, format: DevExpress.ui.format): number; } /** Defines animation options. */ export interface animationConfig { /** A function called after animation is completed. */ complete?: (($element: DevExpress.core.dxElement, config: any) => any); /** 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 the initial animation state. */ from?: number | string | any; /** 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: any) => any); /** Specifies a final animation state. */ to?: number | string | any; /** A string value specifying the animation type. */ type?: 'css' | 'fade' | 'fadeIn' | 'fadeOut' | 'pop' | 'slide' | 'slideIn' | 'slideOut'; } /** The position object specifies the widget positioning options. */ export interface positionConfig { /** The target element position that the widget is positioned against. */ at?: 'bottom' | 'center' | 'left' | 'left bottom' | 'left top' | 'right' | 'right bottom' | 'right top' | 'top' | { x?: 'center' | 'left' | 'right', y?: 'bottom' | 'center' | 'top' }; /** The element within which the widget is positioned. */ boundary?: string | Element | JQuery | Window; /** Specifies the horizontal and vertical offset from the window's boundaries. */ boundaryOffset?: string | { x?: number, y?: number }; /** Specifies how to move the widget if it overflows the screen. */ 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' | { x?: 'fit' | 'flip' | 'flipfit' | 'none', y?: 'fit' | 'flip' | 'flipfit' | 'none' }; /** The position of the widget to align against the target element. */ my?: 'bottom' | 'center' | 'left' | 'left bottom' | 'left top' | 'right' | 'right bottom' | 'right top' | 'top' | { x?: 'center' | 'left' | 'right', y?: 'bottom' | 'center' | 'top' }; /** The target element that the widget is positioned against. */ of?: string | Element | JQuery | Window; /** Specifies horizontal and vertical offset in pixels. */ offset?: string | { x?: number, y?: number }; } /** A repository of animations. */ export class 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): any; /** 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; } /** 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: JQuery, animation: animationConfig | string): void; /** Registers a set of elements that should be animated as "leaving" using the specified animation configuration. */ leave(elements: JQuery, 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(): Promise<void> & JQueryPromise<void>; /** Stops all started animations. */ stop(): void; } export interface ComponentOptions { /** A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. */ onDisposing?: ((e: { component?: Component }) => any); /** A handler for the initialized event. Executed only once, after the widget is initialized. */ onInitialized?: ((e: { component?: Component, element?: DevExpress.core.dxElement }) => any); /** A handler for the optionChanged event. Executed after an option of the widget is changed. */ onOptionChanged?: ((e: { component?: Component, name?: string, fullName?: string, value?: any }) => any); } /** A base class for all components and widgets. */ export class Component { constructor(options?: ComponentOptions); /** Prevents the widget from refreshing until the endUpdate() method is called. */ beginUpdate(): void; /** Refreshes the widget after a call of the beginUpdate() method. */ endUpdate(): void; /** Gets the widget's instance. Use it to access other methods of the widget. */ instance(): Component; /** Detaches all event handlers from a single event. */ off(eventName: string): any; /** Detaches a particular event handler from a single event. */ off(eventName: string, eventHandler: Function): any; /** Subscribes to an event. */ on(eventName: string, eventHandler: Function): any; /** Subscribes to events. */ on(events: any): any; /** Gets all widget options. */ option(): any; /** Gets the value of a single option. */ option(optionName: string): any; /** Updates the value of a single option. */ option(optionName: string, optionValue: any): void; /** Updates the values of several options. */ option(options: any): void; } /** Registers a new component in the DevExpress.ui namespace. */ export function registerComponent(name: string, componentClass: any): void; /** Registers a new component in the specified namespace. */ export function registerComponent(name: string, namespace: any, componentClass: any): void; /** Specifies settings that affect all DevExtreme widgets. */ export interface globalConfig { /** A decimal separator. Applies only if you do not use the Globalize or Intl library. */ decimalSeparator?: string; /** The default currency. Accepts a 3-letter code specified by ISO 4217. */ defaultCurrency?: string; /** Specifies whether dates are parsed and serialized according to the ISO 8601 standard in all browsers. */ forceIsoDateParsing?: boolean; /** Specifies whether the widgets support a right-to-left representation. Available for individual widgets as well. */ rtlEnabled?: boolean; /** The decimal separator that is used when submitting a value to the server. */ serverDecimalSeparator?: string; /** A group separator. Applies only if you do not use the Globalize or Intl library. */ thousandsSeparator?: string; } /** Gets the current global configuration. */ export function config(): globalConfig; /** Configures your application before its launch. */ export function config(config: globalConfig): void; /** The device object defines the device on which the application is running. */ export interface 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' | 'win' | '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>; /** Indicates whether or not the device platform is Windows. */ win?: boolean; } /** 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: string): any; /** Detaches a particular event handler from a single event. */ off(eventName: string, eventHandler: Function): any; /** Subscribes to an event. */ on(eventName: string, eventHandler: Function): any; /** Subscribes to events. */ on(events: any): any; /** Returns the current device orientation. */ orientation(): string; /** Returns real information about the current device regardless of the value passed to the devices.current(deviceName) method. */ real(): Device; } export var devices: DevicesObject; export interface DOMComponentOptions extends ComponentOptions { bindingOptions?: any; /** Specifies the attributes to be attached to the widget's root element. */ elementAttr?: any; /** Specifies the widget's height. */ height?: number | string | (() => number | string); /** A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only. */ onDisposing?: ((e: { component?: DOMComponent, element?: DevExpress.core.dxElement, model?: any }) => any); /** A handler for the optionChanged event. Executed after an option of the widget is changed. */ onOptionChanged?: ((e: { component?: DOMComponent, element?: DevExpress.core.dxElement, model?: any, name?: string, fullName?: string, value?: any }) => any); /** Switches the widget to a right-to-left representation. */ rtlEnabled?: boolean; /** Specifies the widget's width. */ width?: number | string | (() => number | string); } /** A base class for all components. */ export class DOMComponent extends Component { constructor(element: Element | JQuery, options?: DOMComponentOptions); /** Specifies the device-dependent default configuration options for this component. */ static defaultOptions(rule: { device?: Device | Array<Device> | Function, options?: any }): void; /** Removes the widget from the DOM. */ dispose(): void; /** Gets the root widget element. */ element(): DevExpress.core.dxElement; /** Gets the instance of a widget found using its DOM node. */ static getInstance(element: Element | JQuery): DOMComponent; } /** An object used to manage OData endpoints in your application. */ export class EndpointSelector { constructor(options: any); /** Gets an endpoint with a specific key. */ urlFor(key: string): string; } /** 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.dxValidationGroupResult; /** Validates editors from a specific validation group. */ static validateGroup(group: string | any): DevExpress.ui.dxValidationGroupResult; /** Validates a view model. */ static validateModel(model: any): any; } /** Hides the last displayed overlay widget. */ export function hideTopOverlay(): boolean; /** Processes the hardware back button click. */ export function processHardwareBackButton(): void; /** An object that serves as a namespace for DevExtreme UI widgets as well as for methods implementing UI logic in DevExtreme sites/applications. */ export class ui { /** Creates a toast message. */ static notify(message: string, type?: string, displayTime?: number): void; /** Creates a toast message. */ static notify(options: any, type?: string, displayTime?: number): void; /** Sets a template engine. */ static setTemplateEngine(templateEngineName: string): void; /** Sets a custom template engine defined via custom compile and render functions. */ static setTemplateEngine(templateEngineOptions: { compile?: Function, render?: Function }): void; } /** An object that serves as a namespace for DevExtreme Data Visualization Widgets. */ export class viz { /** Changes the current palette for all data visualization widgets on the page. */ static currentPalette(paletteName: string): void; /** Gets the current theme's name. */ static currentTheme(): string; /** Changes the current theme for all data visualization widgets on the page. The color scheme is defined separately. */ static currentTheme(platform: string, colorScheme: string): void; /** Changes the current theme for all data visualization widgets on the page. */ static currentTheme(theme: string): void; /** Allows you to export widgets using their SVG markup. */ static exportFromMarkup(markup: string, options: { fileName?: string, format?: string, backgroundColor?: string, proxyUrl?: string, width?: number, height?: number, onExporting?: Function, onExported?: Function, onFileSaving?: Function }): void; /** Gets the SVG markup of specific widgets for their subsequent export. */ static getMarkup(widgetInstances: Array<DOMComponent>): string; /** Gets the color sets of a predefined or registered palette. */ static getPalette(paletteName: string): any; /** Gets a predefined or registered theme's settings. */ static getTheme(theme: string): any; /** The method to be called every time the active entry in the browser history is modified without reloading the current page. */ static refreshPaths(): void; /** Refreshes the current theme and palette in all data visualization widgets on the page. */ static refreshTheme(): void; /** Registers a new palette. */ static registerPalette(paletteName: string, palette: any): void; /** Registers a new theme based on the existing one. */ static registerTheme(customTheme: any, baseTheme: string): void; } } declare module DevExpress.data { /** An object used to generate and hold the GUID. */ export class Guid { constructor(); constructor(value: string); /** Gets a Guid converted to a string. */ toString(): string; /** Gets a Guid converted to a string. */ valueOf(): string; } export interface StoreOptions { /** Specifies the function called when the Store causes an error. */ errorHandler?: Function; /** Specifies the key property or properties. */ key?: string | Array<string>; /** A handler for the inserted event. */ onInserted?: ((values: any, key: any | string | number) => any); /** A handler for the inserting event. */ onInserting?: ((values: any) => any); /** A handler for the loaded event. */ onLoaded?: ((result: Array<any>) => any); /** A handler for the loading event. */ onLoading?: ((loadOptions: LoadOptions) => any); /** A handler for the modified event. */ onModified?: Function; /** A handler for the modifying event. */ onModifying?: Function; /** A handler for the removed event. */ onRemoved?: ((key: any | string | number) => any); /** A handler for the removing event. */ onRemoving?: ((key: any | string | number) => any); /** A handler for the updated event. */ onUpdated?: ((key: any | string | number, values: any) => any); /** A handler for the updating event. */ onUpdating?: ((key: any | string | number, values: any) => any); } /** The base class for all Stores. */ export class Store { constructor(options?: StoreOptions) /** Gets a data item with a specific key. */ byKey(key: any | string | number): Promise<any> & JQueryPromise<any>; /** Adds an item to the Store's data. */ insert(values: any): Promise<any> & JQueryPromise<any>; /** Gets the key option's value. */ key(): any; /** Gets the key value of an item found using its data object. */ keyOf(obj: any): any; /** Starts loading data. */ load(): Promise<any> & JQueryPromise<any>; /** Starts loading data. */ load(options: LoadOptions): Promise<any> & JQueryPromise<any>; /** Detaches all event handlers from a single event. */ off(eventName: string): any; /** Detaches a particular event handler from a single event. */ off(eventName: string, eventHandler: Function): any; /** Subscribes to an event. */ on(eventName: string, eventHandler: Function): any; /** Subscribes to events. */ on(events: any): any; /** Removes a data item with a specific key. */ remove(key: any | string | number): Promise<void> & JQueryPromise<void>; /** Gets the total count of items the load() function returns. */ totalCount(obj: { filter?: any, group?: any }): Promise<number> & JQueryPromise<number>; /** Updates the data item specified by the key. */ update(key: any | string | number, values: any): Promise<any> & JQueryPromise<any>; } export interface ArrayStoreOptions extends StoreOptions { /** Specifies the array associated with the Store. */ data?: Array<any>; } /** A Store accessing an in-memory array. */ export class ArrayStore extends Store { constructor(options?: ArrayStoreOptions) /** Clears all data associated with the current ArrayStore. */ clear(): void; /** Creates the Query object for the underlying array. */ createQuery(): any; } /** This section describes the loadOptions object's fields. */ export interface LoadOptions { /** An object for storing additional settings that should be sent to the server. Relevant to the ODataStore only. */ customQueryParams?: any; /** An array of strings that represent the names of navigation properties to be loaded simultaneously with the ODataStore. */ expand?: any; /** A filter expression. */ filter?: any; /** A group expression. */ group?: any; /** A group summary expression. */ groupSummary?: any; /** Indicates whether a top-level group count is required. */ requireGroupCount?: boolean; /** Indicates whether the total count of data objects is needed. */ requireTotalCount?: boolean; /** A data field or expression whose value is compared to the search value. */ searchExpr?: string | Function | Array<string | Function>; /** A comparison operation. Can have one of the following values: "=", "<>", ">", ">=", "<", "<=", "startswith", "endswith", "contains", "notcontains", "isblank" and "isnotblank". */ searchOperation?: string; /** The current search value. */ searchValue?: any; /** A select expression. */ select?: any; /** The number of data objects to be skipped from the result set's start. In conjunction with take, used to implement paging. */ skip?: number; /** A sort expression. */ sort?: any; /** The number of data objects to be loaded. In conjunction with skip, used to implement paging. */ take?: number; /** A total summary expression. */ totalSummary?: any; /** An object for storing additional settings that should be sent to the server. */ userData?: any; } export interface CustomStoreOptions extends StoreOptions { /** Specifies a custom implementation of the byKey(key) method. */ byKey?: ((key: any | string | number) => Promise<any> | JQueryPromise<any>); /** Specifies whether raw data should be saved in the cache. Applies only if loadMode is "raw". */ cacheRawData?: boolean; /** Specifies a custom implementation of the insert(values) method. */ insert?: ((values: any) => Promise<any> | JQueryPromise<any>); /** Specifies a custom implementation of the load(options) method. */ load?: ((options: LoadOptions) => Promise<any> | JQueryPromise<any>); /** Specifies how data returned by the load function is treated. */ loadMode?: 'processed' | 'raw'; /** Specifies a custom implementation of the remove(key) method. */ remove?: ((key: any | string | number) => Promise<void> | JQueryPromise<void>); /** Specifies a custom implementation of the totalCount(options) method. */ totalCount?: ((loadOptions: { filter?: any, group?: any }) => Promise<number> | JQueryPromise<number>); /** Specifies a custom implementation of the update(key, values) method. */ update?: ((key: any | string | number, values: any) => Promise<any> | JQueryPromise<any>); /** Specifies whether the store combines the search and filter expressions. Defaults to true if the loadMode is "raw" and false if it is "processed". */ useDefaultSearch?: boolean; } /** A Store object that enables you to implement your own data access logic. */ export class CustomStore extends Store { constructor(options?: CustomStoreOptions) /** Deletes data from the cache. Takes effect only if the cacheRawData option is true. */ clearRawDataCache(): void; } export interface DataSourceOptions { /** The bag of custom parameters passed to the query executed when the DataSource load operation is invoked. */ customQueryParams?: any; /** Specifies the navigation properties that are loaded with the OData entity. Available only for the ODataStore. */ expand?: Array<string> | string; /** Specifies data filtering conditions. */ filter?: string | Array<any> | Function; /** Specifies data grouping options. */ group?: string | Array<any> | Function; /** Specifies an item mapping function. */ map?: ((dataItem: any) => any); /** A handler for the changed event. */ onChanged?: Function; /** A handler for the loadError event. */ onLoadError?: ((error: { message?: string }) => any); /** A handler for the loadingChanged event. */ onLoadingChanged?: ((isLoading: boolean) => any); /** Specifies the maximum number of items the page can contain. */ pageSize?: number; /** Specifies whether a DataSource loads data by pages, or all items at once. */ paginate?: boolean; /** Specifies a post processing function. */ postProcess?: ((data: Array<any>) => Array<any>); /** Specifies whether or not the DataSource instance requests the total count of items available in the storage. */ requireTotalCount?: boolean; /** Specifies the fields to search. */ searchExpr?: string | Function | Array<string | Function>; /** Specifies the comparison operation used in searching. The following values are accepted: "=", "<>", ">", ">=", "<", "<=", "startswith", "endswith", "contains", "notcontains". */ searchOperation?: string; /** Specifies the value to which the search expression is compared. */ searchValue?: any; /** Specifies the fields to select from data objects. */ select?: string | Array<any> | Function; /** Specifies data sorting options. */ sort?: string | Array<any> | Function; /** Specifies the underlying Store instance used to access data. */ store?: Store | StoreOptions | Array<any> | any; } /** An object that provides access to a data web service or local data storage for collection container widgets. */ export class DataSource { constructor(url: string); constructor(data: Array<any>); constructor(store: Store); constructor(options: CustomStoreOptions | DataSourceOptions); /** Cancels the load operation with a specific identifier. */ cancel(): boolean; /** Disposes all resources associated with this DataSource. */ dispose(): void; /** Gets the filter option's value. */ filter(): any; /** Sets the filter option's value. */ filter(filterExpr: any): void; /** Gets the group option's value. */ group(): any; /** Sets the group option's value. */ group(groupExpr: any): void; /** Checks whether the count of items on the current page is less than the pageSize. Takes effect only with enabled paging. */ isLastPage(): boolean; /** Checks whether data is loaded in the DataSource. */ isLoaded(): boolean; /** Checks whether the DataSource is being loaded. */ isLoading(): boolean; /** Gets data items the DataSource currently operate. */ items(): Array<any>; /** Gets the value of the underlying Store's key option. */ key(): any & string & number;